Saropa Documentation Structure Guide

How to organize system documentation into five key areas to make it more effective

Back to all articles

This document presents a unified prescription for how to organize system documentation to make it more effective and to avoid 'wiki-dumps'.

There are five key areas of system documentation, each with distinct approaches and functions: Introduction, Tutorials, How-to Guides, Reference and Explanation.

See the full online document: Documentation Structure Guide


IMAGES

Open then right-click to download...

Square graphic of the five documentation areas
Landscape overview of the documentation model

How tutorials, how-to guides, reference pages, and explanatory narrative fit together in a typical product documentation set.


REFERENCES

Based on the presentation by Daniele Procida at PyCon AU 2017: What nobody tells you about documentation


Share

Share this article

Your feedback is essential to us, and we genuinely value your support. When we learn of a mistake, we acknowledge it with a correction. If you spot an error, please let us know at blog@saropa.com and learn more at saropa.com.

Originally published on the Saropa blog on February 17, 2021. Copyright © 2021