Documentation technique

Samedi 4 septembre 2004 22:05 - Divers

Écrire de la documentation technique, déjà en temps normal mais encore plus quand ça s'adresse à un client important, c'est être précis, factuel, chiant même. C'est se refuser le moindre écart, la plus petite fantaisie.

Je me souviens d'une préface (ou était-ce sur le quatrième de couverture ?), Starship Titanic si mes souvenirs sont bons (ils le sont, je viens de vérifier), écrit par Terry Jones, idée de Douglas Adams. Dans cette préface (ou ce quatrième de couverture, je suis incapable de vérifier, j'ai lu ce bouquin qui ne m'appartenait pas dans un village proche de la frontière écossaise il y a des années (et peut-être que la version française ne propose pas ce texte)), dans cette préface donc, Terry Jones expliquait qu'il avait écrit le livre nu, du début à la fin. (confirmation avec photo)

De ces deux paragraphes, la suite est déjà évidente aux fins esprits de mon lectorat. C'est ainsi que non, je n'ajouterai pas dans cette documentation, une note, au début d'un chapitre:

Ce chapitre a été écrit nu. Cela n'a pas eu d'incidence sur la qualité du travail. Il est aussi pénible à lire que les autres chapitres. Si vous trouvez un poil, vous pouvez le garder.

Je ne l'ajouterai pas surtout que ce n'est même pas vrai; même déconnecté et résolu, je n'ai pas écrit plus que quelques phrases aujourd'hui. Quelques phrases et une entrée dans ce carnet. À poil.