Documentation hinges on the reader’s ability to understand and apply it.
You will find the Attune documentation easy to understand and faster to access the information you’re looking for.
Tutorials, how-to guides, technical references, and explanations.
When it comes to writing effective software documentation, there’s an important insight that elevates the quality: documentation isn’t a monolithic entity, but rather a quartet of distinct types.
These types are tutorials, how-to guides, technical references, and explanations. Each serves a unique role, fulfils a specific need, and thus necessitates a tailored approach in its crafting.
Daniele Procida presents – What nobody tells you about documentation. This talk was given at PyCon Australia 2017.