Hacker News new | ask | show | jobs
by brnt 1394 days ago
Don't lead people to believe manuals/manpages are good, complete or readable. I often fine that coming up with an option line that does what I want requires more study than is presented in the manual. A quick forum search will probably be a much better starting point.

Also, I recall that reading though a Samba config file (it's been a decade, maybe it's gotten better) while instructive, is nearly equivalent to reading a novella. Sure I can configure domains and users, but I don't need any of that.

A mandatory half pager trying to setup a typical newbie use case would be a huge improvement for most manuals that I have seen.

1 comments

Manuals are written by the people who know the software better than anyone else. But that knowledge comes at a price of being completely unable to shift their perspective to that of someone coming in with fresh eyes.

Documentation needs two parts, a reference written by the authors and a tutorial written by someone with no prior experience with the software going though their process learning it from scratch.