Importance of Docs in OSS - Tips for Writing Effective Docs - Traits of Successful OSS Docs - Tools for Writing Good OSS Docs - Possible Structure your Documentation - Examples of Good Open Source Docs
and keep track on all aspects of the software. • It improves the quality of the software. • It informs people on all changes made on the software including version updates(release notes). • It informs people on what aspect of the software is currently being worked on by the maintainers of the OSS projects (roadmaps)
guide for your documentation and enforce it • Pick a markup style and stick with it • Focus on using an active voice. • Make use of simple and short sentences(efficient communication). • Make sure to format your documentation properly for easy reading. • Include sample code and examples • Use visual devices to represent information e.g illustrations, tables, graphs etc. • Always spell check your documentation to avoid errors. • Provide contribution guidelines
it easy to maintain Open Source documentation websites SPHINX Sphinx is what is called a documentation generator. This means that it takes a bunch of source files in plain text, and generates a bunch of other awesome things, mainly HTML GITHUB (& GITHUB PAGES) To use GitHub for documenting your software, just fill the README in with markdown. If you want more than just one sheet of formatted text, you can take advantage of GitHub’s Pages tool and you can even route a custom domain to it). READ THE DOCS Read the Docs simplifies software documentation by automating building, versioning, and hosting of your docs for you.