Veuillez cliquer ici pour aider David McMurrey payer pour l'hébergement web :
Faites don de tout petit montant que vous pouvez !
L'écriture technique en ligne restera gratuite.

Les documents techniques (y compris les manuels, les livres blancs et les guides) ont divers designs selon l'industrie, la profession ou l'organisation. Ce chapitre vous présente un design traditionnel. Si vous suivez un cours de rédaction technique, assurez-vous que le design présenté dans ce chapitre est acceptable. Il en va de même si vous rédigez un document technique dans un contexte scientifique, commercial ou gouvernemental.

NotebookLM-generated infographic of this chapter Infographie générée par NotebookLM de ce chapitre

Remarque : Pendant des années, ce manuel en ligne de rédaction technique a désigné de manière générique les rapports comme pratiquement tout ce qui contient des informations techniques. Mais comme "rapport" fait référence à un genre spécifique de document technique, il a fallu changer pour le terme générique "techdoc", abréviation de document technique.

Les techdocs (nom générique pour les documents techniques) ont des spécifications tout comme tout autre type de projet. Les spécifications pour les techdocs concernent la mise en page, l'organisation et le contenu, le format des titres et des listes, la conception des graphiques, et ainsi de suite. L'avantage d'une structure et d'un format requis pour les techdocs est que vous ou n'importe qui d'autre pouvez vous attendre à ce qu'ils soient conçus de manière familière—vous savez quoi chercher et où le chercher. Les techdocs sont généralement lus rapidement—les gens sont pressés d'accéder à l'information dont ils ont besoin, les faits clés, les conclusions et d'autres éléments essentiels. Un format standard de techdoc est comme un quartier familier.

Lorsque vous analysez la conception d'un techdoc, remarquez à quel point certaines sections sont répétitives. Cette duplication a trait à la manière dont les gens lisent les techdocs. Ils ne lisent pas les techdocs d'affilée : ils peuvent commencer par le résumé exécutif, passer d'une section à l'autre et il est probable qu'ils ne lisent pas chaque page. Votre défi est de concevoir les techdocs de manière à ce que ces lecteurs rencontrent vos faits et conclusions clés, peu importe combien de pages du techdoc ils lisent ou dans quel ordre ils les lisent.

Assurez-vous de voir le exemple de documents techniques.

Les composants standard du rapport technique typique sont discutés dans ce chapitre. Les sections suivantes vous guident à travers chacun de ces composants, en soulignant les caractéristiques clés. En lisant et en utilisant ces directives, rappelez-vous qu'il s'agit de directives, pas de commandements. Différentes entreprises, professions et organisations ont leurs propres directives variées pour les documents techniques—vous devrez adapter votre pratique à celles-ci ainsi qu'à celles présentées ici.

Message de transmission

Le message de transmission est soit une lettre d'accompagnement (ou un mémo), soit un e-mail. La lettre physique (ou le mémo) est soit attachée à l'extérieur du document technique avec un trombone, soit intégrée dans le document technique. L'e-mail contient un lien vers le document technique ou le document technique en pièce jointe. Il s'agit d'une communication de votre part—l'auteur du document technique—au destinataire, la personne qui a demandé le document technique et qui peut même vous rémunérer pour votre consultation experte. Essentiellement, il dit "D'accord, voici le document technique que nous avons convenu que je terminerais d'ici telle date. En résumé, il contient ceci et cela, mais ne couvre pas ceci ou cela. Faites-moi savoir si cela répond à vos besoins." Le message de transmission explique le contexte—les événements qui ont conduit à la création du document technique. Il contient des informations sur le document technique qui n'appartiennent pas au document technique.

Business letter and email versions of transmital message
Exemples d'une lettre de transmission et d'un message de transmission.

Dans l'exemple de la lettre de transmission, notez le format standard de la lettre d'affaires. Si vous rédigez un document technique interne, utilisez plutôt le format de mémorandum ; dans les deux cas, le contenu et l'organisation sont les mêmes :

Premier paragraphe. Citez le nom du techdoc, en l'italisant. Il mentionne également la date de l'accord pour rédiger le techdoc.

Paragraphe du milieu. Se concentre sur l'objectif du techdoc et donne un bref aperçu du contenu du techdoc.

Dernier paragraphe. Encourage le lecteur à se mettre en contact s'il a des questions, des commentaires ou des préoccupations. Cela se termine par un geste de bonne volonté, exprimant l'espoir que le lecteur trouve le doc tech satisfaisant.

Comme pour tout autre élément d'une documentation technique, vous devrez peut-être modifier le contenu de ce message (ou mémo) pour des situations spécifiques. Par exemple, vous pourriez vouloir ajouter un autre paragraphe, énumérant des questions que vous aimeriez que les lecteurs prennent en compte lors de la révision de la documentation technique.

Couvertures, Page de Titre et Étiquette

Si votre documentation technique fait plus de dix pages, reliez-la d'une manière ou d'une autre et créez une étiquette pour la couverture.

Couvre-lits

Les couvertures donnent aux documents techniques une apparence solide et professionnelle, ainsi qu'une protection. Vous pouvez choisir parmi de nombreux types de couvertures. Gardez ces conseils à l'esprit :

En général, les cahiers à feuillets mobiles, ou les classeurs à anneaux, sont moins préférables. Ceux-ci sont trop encombrants pour de courts documents techniques, et les trous des pages tendent à se déchirer. Bien sûr, le classeur à anneaux facilite le changement de pages ; si c'est ainsi que votre document technique sera utilisé, alors c'est un bon choix. Au "haut de gamme", on trouve des couvertures trop fantaisistes avec un aspect simili cuir et des finitions dorées. Évitez-les—gardez-le simple, sobre et fonctionnel.

Page de titre

Dans sa forme la plus simple, un titre de techdoc est une copie de ce qui figure sur la couverture—possiblement avec quelques détails ajoutés.

Jetez un œil à la page de titre. Résumé et Sommaire Exécutif.

Étiquettes

Assurez-vous de concevoir une étiquette pour la couverture de votre techdoc. C'est une étape que certains rédacteurs de techdoc oublient. Sans étiquette, un techdoc est anonyme ; il est ignoré.

Le meilleur moyen de créer une étiquette est d'utiliser votre logiciel de traitement de texte pour en concevoir une sur une page standard avec une boîte graphique autour des informations de l'étiquette. Imprimez-la, puis allez dans un service de photocopie et faites-la photocopier directement sur la couverture du techdoc.

Il n'y a pas grand-chose sur l'étiquette : le titre du techdoc, votre nom, le nom de votre organisation, un numéro de suivi techdoc et une date. Il n'y a pas d'exigences standard pour l'étiquette, bien que votre entreprise ou organisation devrait avoir ses propres exigences. (Un exemple d'étiquette de techdoc est montré ci-dessous.)


Lettre de transmission et couverture de document technique (avec étiquette de couverture).

Résumé et Sommaire Exécutif

La plupart des techdocs techniques contiennent au moins un résumé — parfois deux, auquel cas les résumés jouent des rôles différents. Les résumés synthétisent le contenu d'une techdoc, mais les différents types le font de manières différentes :

Si le résumé exécutif, l'introduction et le message de transmission vous semblent répétitifs, rappelez-vous que les lecteurs ne commencent pas nécessairement par le début d'un document technique et ne lisent pas page par page jusqu'à la fin. Ils sautent autour : ils peuvent parcourir la table des matières ; ils survolent généralement le résumé exécutif pour en extraire des faits et des conclusions clés. Ils peuvent lire attentivement seulement une ou deux sections du corps du document technique, puis sauter le reste. Pour ces raisons, les documents techniques sont conçus avec une certaine duplication afin que les lecteurs puissent voir les informations importantes peu importe où ils plongent dans le document technique.


Table des matières (qui vient en premier) puis le résumé exécutif.

Table des matières

Quel que soit le format de table des matières (TDM) que vous utilisez, voici les normes courantes :