From 11a9f654cc929aa3d0302b4e8348fd62f8748134 Mon Sep 17 00:00:00 2001 From: km0 Date: Wed, 1 Mar 2023 15:10:20 +0100 Subject: [PATCH] Update 'chapters/01_who_is_reading.md' --- chapters/01_who_is_reading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapters/01_who_is_reading.md b/chapters/01_who_is_reading.md index 186afdd..55d0036 100644 --- a/chapters/01_who_is_reading.md +++ b/chapters/01_who_is_reading.md @@ -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.