Si vous avez été accusé d'avoir écrit un document qui est censé expliquer à quelqu'un d'autre comment faire quelque chose, la façon de le faire aujourd'hui jette plus ou moins les anciennes méthodes par la fenêtre.

1. Grands en-têtes bombastiques

Vous remarquerez que les en-têtes sur PCMech, tels que celui juste au-dessus de cette phrase, sont énormes. En effet, ils sont plus faciles à voir, à lire et à savoir où vous vous trouvez dans le document.

2. Moins de mots

Fausse route:

La documentation suivante explique comment utiliser et faire fonctionner le Fanny Whacker 2000.

La bonne façon:

Instructions d'utilisation du Fanny Whacker 2000

Rappelez-vous toujours cette phrase lors de la rédaction de la documentation: ALLEZ AU POINT LE PLUS RAPIDEMENT POSSIBLE.

3. Ignorer les références inutiles

Si la référence n'a rien à voir avec l'instruction de base de ce que vous essayez de décrire, comme:

Pour plus d'informations sur le navet Twaddler de Fanny Whacker 2000, veuillez consulter le document FU, sous-section ID10T.

… Ne fais pas ça.

4. Datez-le. Toujours.

La date de rédaction de la documentation doit se trouver dans la zone de pied de page de chaque page. S'il s'agit d'un document électronique, la date s'affiche deux fois. Une fois au début, une fois à la fin.

Vous pouvez écrire ceci comme "Dernière révision (insérer la date ici)".

5. Les avertissements doivent toujours être affichés avant le point de non-retour

S'il y a quelque chose dans votre documentation qui pourrait potentiellement endommager / détruire / effacer quelque chose s'il est mal exécuté, ces informations doivent être placées directement après ladite instruction, être bien en vue (c'est-à-dire sur la même page) et accentuées.

Exemple:

Étape 5. Nettoyage du Fanny Whacker 2000 Les palettes du FW2000 doivent être nettoyées doucement à l'aide d'un chiffon doux non abrasif. AVERTISSEMENT: utilisez uniquement un solvant sans ammoniaque pour empêcher le FW2000 d'exploser et d'entraîner votre mort prématurée.

Sur une note finale, une bonne documentation n'est pas d'être super-descriptive sur chaque chose possible imaginable. Lisez votre documentation et posez-vous la question: est-ce qu'elle donne des instructions correctement? Si la réponse est oui, la question suivante est: donne-t-elle des instructions rapidement? Si oui, la documentation est bonne.