This page contains the details of a technical writing project accepted for Season of Docs.
- Open source organization:
- The FreeBSD Project
- Technical writer:
- The King of Toasters
- Project name:
- Write missing manpages, Add EXAMPLE sections to man pages
- Project length:
- Standard length (3 months)
Write missing man pages:
There is a list of missing manpages on https://wiki.freebsd.org/MissingManpages. Start writing as many man pages from that list as possible. With the help of your mentor, find the author or someone who recently changed the source file that the man page in question is about for background information and details.
Add EXAMPLE sections to man pages:
The FreeBSD man pages include in many places an EXAMPLE sections, describing basic usage of the utility or command described therein. The FreeBSD wiki has a list of man pages without examples (https://wiki.freebsd.org/ManPagesWithoutExamples). Add as many examples to these man pages as possible in cases where it makes sense to have them. Come up with a general way of introducing the command/utility in these sections (i.e. quick start first, more advanced examples afterwards) and apply that to man pages describing similar utilities/commands. That way, the examples have a consistent approach and the reader can find things easier.