Comment rédiger une bonne documentation technique ?

Il existe autant de manière d’écrire de la documentation que de développeurs et d’entreprises. Voici quelques recommandations pour rédiger une documentation impactante et efficace.

Comment rédiger une bonne documentation technique ?

Il existe autant de manière d’écrire de la documentation que de développeurs et d’entreprises.

Il faut d'abord bien comprendre que ce n'est pas simple d'écrire une bonne documentation et que cela prend plusieurs itérations, avec des feedbacks de la part de l'équipe, des clients ou des décideurs en interne pour avoir quelque chose de cohérent, utile et agréable à utiliser.

Voici 8 recommandations de notre part, pour rédiger une documentation impactante et efficace !

Nos documentations ont toujours été saluées par les développeurs et par nos clients au fil des années. On vous livre tout nos secrets 🔓

1. Ne rien présupposer sur le lecteur ️🤌

Le développeur qui lira votre documentation n’a peut-être aucune culture numérique, du moins considérez qu’il n’en a aucune et partez du principe qu’il ne sait pas où il est, ce qu’il doit faire et qu’il n’a pas de bagage technique a part lire et naviguer sur votre documentation.

Partez du principe que la personne qui lit votre doc est NULLE comme vous l'étiez avant.

Ce sera d'autant plus simple d'intégrer une nouvelle recrue à votre équipe en partant de ce principe.

Partez from scratch, si c'est une documentation pour lancer un projet, imaginez que le développeur n'a rien d'installé sur son ordinateur et qu'il doit partir de zéro.

(pour lire la suite, inscrivez vous, c'est full gratuit et ça nous montre que vous appréciez l'effort 🤎)

Commentaires

Connectez vous ou devenez un membre de Async pour rejoindre la conversation.
Entrez un mail ici pour recevoir un lien de connexion, super simple ⚡️