Re:Simplified and community-driven man pages
by Annatar on Monday November 27, 2017 @07:16AM
(#15786738)
Good projects should have tutorials and complete references online in addition to man pages.
A well written manual page requires no additional tutorials, for they will be included in the text’s corpus.
Writing good documentation for one’s software is almost more important than writing the software itself; don’t force the user to have to run around the internet; be comprehensive in the manual.
A well written manual page requires no additional tutorials, for they will be included in the text’s corpus.
Writing good documentation for one’s software is almost more important than writing the software itself; don’t force the user to have to run around the internet; be comprehensive in the manual.