Lorsqu'on travaille sur un projet, que l'on crée des outils ou qu'on définit des méthodes, il est important de produire de la documentation. Mais cette tâche n'est pas évidente. Pensez un instant à un sujet que vous maîtrisez ! votre travail, votre passe-temps préféré... puis ouvrez une nouvelle page dans un éditeur de texte et essayez de rédiger 1 page de documentation sur ce sujet ! ou juste une demie page. Bonne chance et bon courage !
Ce que j'ai trouvé comme méthode qui fonctionne plutôt bien pour créer de la documentation, c'est de me mettre dans la peau d'une personne qui ne connaît rien. J'ai tendance à décrire cette personne comme un "idiot" mais le mot ne doit pas être pris comme une insulte. L'idiot, c'est moi tel que j'étais avant de découvrir le sujet pour lequel je me retrouve à écrire une documentation. En procédant ainsi, j'arrive à produire une documentation facilement compréhensible par quiconque et dont les prérequis sont minimaux.
A quoi ressemble une telle documentation au final ? C'est un mélange de captures d'écran et de phrases courtes. Plus les indications sont simples et plus la documentation sera efficace.
Aucun commentaire:
Enregistrer un commentaire