The documentation system (A.K.A. What Nobody Tells You About Documentation)

See The documentation system (A.K.A. What Nobody Tells You About Documentation) on documentation.divio.com

I got this from a talk What Nobody Tells You About Documentation [VIDEO: 30:52] by Daniele Procida. The main idea is to split documentation into four sections.

• Tutorials are for beginners trying to see how things work,
• How-To Guides are for those looking to do a specific task,
• Reference describe things (like API’s functions) and,
• Discussions are for understanding the decisions behind the tool.

It’s important that you don’t mix these sections together.