Rédiger de la bonne documentation pour un projet
par Vincent Poulailleau - 1 minute de lecture - 175 mots
Pas facile de rédiger une documentation qui répond à tous les besoins tels que :
- appréhender les bases du projet, savoir se débrouiller
- avoir une documentation exhaustive
- trouver facilement la méthode pour résoudre les problèmes classiques
- …
La réponse à cette problématique est : il ne faut pas une documentation mais des documentations. C’est ce que nous explique Daniele Procida dans sa présentation « What nobody tells you about documentation ».
There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four.
They are: tutorials, how-to guides, explanation and technical reference. They represent four different purposes or functions, and require four different approaches to their creation. Understanding the implications of this will help improve most software documentation − often immensely.
Voici une vidéo de sa présentation à la PyCon 2017 : https://www.youtube.com/watch?v=azf6yzuJt54.
Vous trouverez l’article de blog qui explique la même chose ici : https://www.divio.com/blog/documentation/ et le support de la présentation ici : http://technicalcommunicationuk.com/wp/wp-content/uploads/2018/10/Daniele-Procida-%E2%80%93-Four-functions-in-the-structure-of-technical-documentation-and-why-they-matter.pdf.
