The Hitchhiker's Guide to Documentation!

This Guide exists to provide advices and a best-practice handbook about creating documentation.

This Guide is in the early stage but is under active development.

Feel free to give feedback, criticize or contribute! Don't afraid to mention what is missing. Every comment is welcome!

See this project on github or

The Guide is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported license.

How to read this Guide?

Start from Process page to what are the roles of different people and what group of topics you are interested in.