Konubinix' opinionated web of thoughts

Paradoxe D'écrire Une Bonne Documentation

Fleeting

Quand on n’arrive pas à utiliser un produit, on blâme la documentation.

Quand on crée un produit, on n’arrive pas à écrire une bonne documentation. Parfois même, on blâme les utilisateurs de ne pas comprendre la documentation (rationalisation).

Est-ce qu’on doit imaginer avoir une bonne documentation comme une référence et vivre l’aversion à la perte à chaque fois qu’on n’en n’a pas ? Ou est-ce qu’on devrait avoir comme référence pas de documentation et vivre la présence d’une bonne documentation comme un ajout confortable ?

Écrire une bonne documentation est pour moi un sujet d’user experience. Tant qu’on confondra user experience et user interface, je pense qu’on continuera à écrire de mauvaises documentations.

Je pense en outre que ne rien attendre de la documentation permet de développer des habitudes et outils de rétro ingénierie qui aident énormément dans la vie d’un développeur.

Notes pointant ici