Saropa Documentation Structure Guide

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...

REFERENCES

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

SCAN CODE