Si vous avez été accusé d'écrire un document censé indiquer à quelqu'un d'autre comment faire quelque chose, la manière de le faire aujourd'hui rejette plus ou moins les anciennes méthodes par la fenêtre.
1. En-têtes Big Bombastic
Vous remarquerez que les en-têtes sur PCMech, tels que celui situé juste au-dessus de cette phrase, sont énormes. C'est parce qu'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 utiliser le Fanny Whacker 2000.
La bonne façon:
Instructions sur l'utilisation du Fanny Whacker 2000
Rappelez-vous toujours de cette phrase lors de la rédaction de la documentation: Rendez-vous aussi vite que possible.
3. Passer les références inutiles
Si la référence n'a rien à voir avec l'instruction principale de ce que vous essayez de décrire, telle que:
Pour plus d'informations sur Turnip Twaddler de Fanny Whacker 2000, veuillez consulter le document FU, sous-section ID10T.
… Ne fais pas ça.
4. La date Toujours.
La date à laquelle la documentation a été écrite doit être dans le pied de page de chaque page. S'il s'agit d'un document électronique, la date est affichée 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
Si quelque chose dans votre documentation peut potentiellement endommager / détruire / effacer quelque chose s’il est mal effectué, cette information doit être placée juste après ladite instruction, être bien en vue (signification sur la même page) et accentuée.
Exemple:
Étape 5. Nettoyage du Fanny Whacker 2000
Les pagaies du FW2000 doivent être nettoyées avec un chiffon doux non abrasif.
AVERTISSEMENT: N'utilisez que des solvants sans ammoniac 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 synonyme de super-description de tout ce qui est imaginable. Lisez votre documentation et demandez-vous si elle vous guide correctement. Si la réponse est oui, la question suivante est la suivante: donne-t-il des instructions rapidement ? Si oui, la documentation est bonne.
