test home

main
km0 2 years ago
parent 4e8638e908
commit 0986651683

@ -35,7 +35,7 @@ Documentation is not just for beginners: it's a code companion. One never stops
This tentacular surface can reach a programmer in different moment of their life: from the _hello world_ to the _how to uninstall_. This is possible thanks to the multitude of shapes documentation can take: video tutorials and commands cheatsheets, _README_ files and complete guides featuring colored images. Daniele Procida proposes a systematic approach to organize this wealth of formats (Procida, 2017). His framework focuses on the needs of different kinds of readers: by leveraging between practical steps and theoretical knowledge, it charts four main modes of technical writing. Each format comes with its own approach and intentions, and in response to different questions.
![Diataxis scheme + two kookaburras](../img/diataxis.jpg)
![Diataxis scheme + two kookaburras](~/img/diataxis.jpg)
This system organizes knowledge around code in a way that tries to meet every user possible. _Tutorials_ offer entry points for the newcomers, while _explanations_ unveal core mechanisms for more navigated readers. _How-to guides_ teach how to get the work done, while _references_ report lists of information ready to be consulted. Different documentations for different readers for the same code.

Loading…
Cancel
Save