Gregory's Server@masukomi manpages work great for a lot of projects
|
3 comments
Moritz Poldrack :arch:
@masukomi I semi-agree there. Of course writing a manpage for an image upscaler that does not have a command line interface would be silly, but for documenting config formats and switches I've found them incredibly valuable. Apart from being easy to search, they can be significantly more thorough than a –help text ever could and having them available offline certainly has its advantages for things like DNS resolvers. For examples, a markdown wiki (of whatever shape) can be a useful resource.
Moritz Poldrack :arch:
@masukomi and bad documentation comes in all flavours, unfortunately. I even have a list in my bookmarks, I call "documentation hell" and manpages are a rare occurrence on that list. Whether I would agree with the first statement I am not sure either. Many programs come with switches that alter the programs behaviour (think proxies in chromium). Calling them irrelevant is ignoring the reality that is daemons and other non-interactive programs. |
@mpldr that may work for you, but overall i’m a Hard Disagree
1. Most apps aren’t for the command line. Thus manpages are irrelevant
2. Most devs starting within the past 20yrs are uncomfortable with the command line & only open it when there’s no GUI alternative.
3. Most manpages are terrible examples of good documentation. They’re usually bad referance docs with zero teaching for those who don’t know what they need or don’t know the jargon.