logoalt Hacker News

jrmg • today at 2:35 PM • 1 reply • view on HN

Yeah, this feels like one of those ‘explainers’ that feel like they are great to someone who already knows how the system works, but don’t actually work for newbies because they tacitly assume knowledge of the shape of the system that seems ‘obvious’ to someone steeped in it.


Replies

bityard • today at 4:04 PM

This is a problem with most docs I encounter. _Good_ documentation should also teach the user how to use the thing, not simply end up as glorified out-of-band code comments.

➕ show 1 reply