Table des matières
Quel que soit le format de table des matières (TDM) que vous utilisez, voici les normes courantes :
- Numéro de page de début uniquement. Bien que certains générateurs de table des matières automatiques affichent la plage de pages, la norme est d'indiquer uniquement le numéro de la première page.
- Niveaux de titres à inclure. Comme indiqué dans la table des matières ci-dessus, affichez les deux premiers niveaux de titres, sauf si le document technique a de nombreux sous-titres. La table des matières doit fournir un moyen rapide et clair de trouver des informations.
- Espacement et capitalisation. Notez comment les éléments de texte dans la table des matières ci-dessus sont indentés. Les titres de premier niveau utilisent des lettres majuscules ; les titres de deuxième niveau utilisent des majuscules initiales pour chaque mot principal ; les titres de troisième niveau utilisent des majuscules de style phrase.
- Espacement vertical. Remarquez que les sections de premier niveau ont un espace supplémentaire au-dessus et en dessous, ce qui augmente la lisibilité.
- Toutes les pages du techdoc (à l'intérieur mais en excluant les couvertures avant et arrière) sont numérotées ; mais sur certaines pages, les numéros ne sont pas affichés.
- Dans le design contemporain, toutes les pages du document utilisent des chiffres arabes ; dans le design traditionnel, toutes les pages avant l'introduction (première page du corps du texte) utilisent des chiffres romains minuscules.
- Sur des pages spéciales, comme la page de titre et la première page de l'introduction, les numéros de page ne sont pas affichés.
- Les numéros de page peuvent être placés dans l'un des plusieurs endroits sur la page. En général, le meilleur et le plus simple choix est de placer les numéros de page en bas au centre de la page (n'oubliez pas de les masquer sur les pages spéciales).
- Si vous placez des numéros de page en haut de la page, vous devez les masquer sur les ouvertures de chapitre ou de section où un en-tête ou un titre se trouve en haut de la page.
- Le techdoc (rapport) contient-il les éléments suivants (bien formatés) dans cet ordre : message de transmission ; page de titre ; table des matières ; liste des figures, des tables, ou des deux ; introduction ; sections du corps (chapitres) ; annexes (si nécessaire) ; sources d'information ; quatrième de couverture (si nécessaire). Pour plus de détails, voir Conception de Techdoc.
- Bien qu'il puisse être astucieux et ludique, le titre du document technique indique-t-il correctement son sujet ? Pour plus de détails, voir Titres de Techdoc.
- Si la table des matières et la liste des figures (et des tableaux) utilisent des points de leader, les numéros de page sont-ils alignés à droite ? Si la table des matières et la liste des figures (et des tableaux) incluent des numéros de page sur le bord droit de la page, des points de leader sont-ils utilisés ? Pour plus de détails, voir Table des matières et liste des figures (tableaux).
- L'introduction indique-t-elle adéquatement le sujet, l'objectif et le public visé du document technique ? Fournit-elle une liste des sous-sujets à aborder ainsi qu'une indication du champ d'application (ce qui n'est pas couvert) ? Pour plus de détails, voir Introductions.
- Ce document technique contient-il des détails adéquats, des spécificités, des exemples—tout ce qui est nécessaire pour expliquer les affirmations, les généralités ?
- En considérant le sujet, l'objectif et le public, y a-t-il des contenus vitaux manquants dans ce document technique ? Y a-t-il des contenus inutiles ? Des informations dans ce document technique sont-elles techniquement incorrectes ? Des informations techniques critiques manquent-elles ?
- Ce technologue contient-il des informations manifestement empruntées qui ne sont documentées d'aucune manière ?
- Les citations (références aux éléments de la liste des sources d'information) apparaissent-elles dans le corps du document technique formaté selon le style APA, MLA ou IEEE modifié ? Les éléments de la liste des sources d'information sont-ils formatés selon le style APA, MLA ou IEEE modifié ? Pour plus de détails, voir Documentation : sources d'information empruntées.
- Tous les tableaux et figures non décoratives incluent-ils un titre descriptif (légende) et une source (si nécessaire) ? Pour plus de détails, voir Titres de tableau.
- Tous les tableaux et figures non décoratives apparaissent aussi près que possible de leur texte pertinent ?
- Des renvois explicatifs brefs ont-ils lieu avant les tableaux et les figures non décoratives ? Pour plus de détails, consultez Références croisées explicatives.
- Un format standard de titres et sous-titres est-il utilisé dans le corps du techdoc ? Pour plus de détails, voir Titres.
- Les sections principales (chapitres) du document technique commencent-elles une nouvelle page dans les versions imprimées ?
- Les listes verticales numérotées sont-elles utilisées pour des éléments de liste dans un ordre requis ? Les listes verticales à puces sont-elles utilisées pour des éléments de liste sans ordre requis ? Les introductions sont-elles utilisées avant toutes les listes ? Pour plus de détails, voir Listes verticales.
- Les citations directes sont-elles attribuées, et les attributions sont-elles correctement ponctuées ? Toutes les citations directes, résumés, paraphrases sont-elles correctement citées selon le style APA, MLA ou IEEE modifié ? Pour plus de détails, voir Citations et attributions.
- Le texte du document technique est-il exempt d'erreurs de grammaire, d'utilisation et de ponctuation ? Pour plus de détails, voir Problèmes courants de grammaire, d'usage et d'orthographe.
- Le texte du technote est-il exempt de verbosité et d'autres erreurs de style de phrase ? Pour plus de détails, voir Verbosité, autres problèmes de style de phrase.
- Ce document technique peut-il être compris par son public cible (comme indiqué dans le message de transmission et l'introduction) ? Pour plus de détails, voir Analyse de l'audience, et voir Traduire le technique.
- IA, pour compléter votre évaluation de mon document technique, attribuez une note numérique de 100 à 55.
Points de leader et numéros de page alignés à droite. Pour la table des matières traditionnelle qui utilise des points leaders et des numéros de page alignés à droite :
Alignement à droite. Dans cet exemple, notez que les points de guide "mènent" aux numéros de page qui sont alignés à droite.
Points de leader et numéros de page alignés à droite.
Ce sommaire utilise le style de numérotation décimale pour les numéros de chapitre et de section, ce qui est courant dans les documents techniques. D'autres dans ce livre utilisent le style des chiffres romains majuscules uniquement pour les chapitres de premier niveau (voir ).
Des problèmes pour créer une table des matières bien formatée ? Voir Créer une table des matières au design professionnel
Virgules et numéros de page. Si un format de point de leader n'est pas requis et que vous préférez l'éviter, vous pouvez utiliser ce format couramment accepté :
|
3. PRINCIPES CLÉS DE L'EFFICACITÉ ÉNERGÉTIQUE, 5
Stratégies de conception passive, 6
4. NORMES ET CERTIFICATIONS, 11Systèmes Énergétiques Actifs, 7 Intégration des énergies renouvelables, 9
LEED, 11
Energy Star, 12 Défi du bâtiment vivant, 14 |
Liste des figures et des tableaux
La liste des figures présente de nombreuses considérations de conception similaires à celles de la table des matières. Les lecteurs utilisent la liste des figures pour trouver les illustrations, les diagrammes, les tableaux et les graphiques dans votre document technique.
Des complications surviennent lorsque vous avez à la fois des tableaux et des figures. Strictement parlant, les figures sont des illustrations, des dessins, des photographies, des graphiques et des diagrammes. Les tableaux sont des lignes et des colonnes de mots et de chiffres ; ils ne sont pas considérés comme des figures.
Pour les documents techniques plus longs contenant des dizaines de figures et de tableaux, créez des listes séparées de figures et de tableaux. Rassemblez-les sur la même page si cela convient, comme illustré ci-dessous. Vous pouvez combiner les deux listes sous le titre "Liste des Figures et des Tableaux," et identifier les éléments comme étant une figure ou un tableau, comme cela est fait dans l'illustration ci-dessous.
Introduction
Un élément essentiel de tout document technique est son introduction—assurez-vous d'être clair sur son véritable objectif et contenu. Dans un document technique, l'introduction prépare le lecteur à lire le corps principal du document. Voir introductions pour une discussion sur l'écriture d'introductions.
Voyez cet exemple d'introduction :
Liste des figures et des tableaux suivie de l'introduction.
S'il n'y a pas de tableaux, faites-le "Liste des Figures." Dans un cours de rédaction technique, demandez à votre instructeur si le style de numérotation décimale pour les titres est requis.
Corps du Techdoc
Le corps du techdoc est bien sûr le texte principal du techdoc, les sections entre l'introduction et la conclusion. Illustrées ci-dessous, des pages d'exemple.
Titres
Dans tous les techdocs sauf les plus courts (deux pages ou moins), utilisez des titres pour délimiter les différents sujets et sous-sujets abordés. Les titres permettent aux lecteurs de parcourir votre techdoc et de descendre à ces points où vous présentez des informations qui les intéressent. Voir titres pour les directives concernant les titres.
Listes à puces et numérotées
Dans le corps d'un document technique, utilisez également des listes à puces, numérotées et à deux colonnes lorsque cela est approprié. Les listes aident en mettant en évidence les points clés, en rendant l'information plus facile à suivre et en rompant les murs de texte constants. Voir listes pour des directives sur les listes.
Symboles, Nombres et Abréviations
Les discussions techniques contiennent généralement beaucoup de symboles, de chiffres et d'abréviations. Rappelez-vous que les règles concernant l'utilisation des chiffres par rapport aux mots diffèrent dans le monde technique. La vieille règle qui consiste à écrire tous les chiffres inférieurs à 10 n'est pas toujours applicable dans les documents techniques. (Voir nombres vs mots pour les directives.)
Sauf du corps d'un techdoc.
Dans un cours de rédaction technique, demandez à votre instructeur si le style de numérotation décimale pour les titres est requis. De plus, un système de documentation différent peut être requis—et non l'IEEE, qui est destiné aux ingénieurs.
Graphiques et Titres des Figures
Dans les documents techniques, vous aurez probablement besoin de dessins, de diagrammes, de tableaux et de graphiques. Ceux-ci non seulement transmettent certains types d'informations plus efficacement, mais donnent également à votre document technique une apparence supplémentaire de professionnalisme et d'autorité. Si vous n'avez jamais intégré ce genre de graphiques dans un document, il existe des moyens relativement simples de le faire—vous n'avez pas besoin d'être un artiste graphique professionnel. Pour des stratégies d'ajout de graphiques à s, voir graphismes. Pour des stratégies pour ajouter des tables à s, voir tables.
Renvois croisés
Vous devrez peut-être orienter les lecteurs vers des informations étroitement liées au sein de vos techdos, ou vers d'autres sources d'information ayant des informations pertinentes. Celles-ci sont appelées renvois croisés. Par exemple, ils peuvent orienter les lecteurs d'une discussion sur un mécanisme vers une illustration de celui-ci. Ils peuvent diriger les lecteurs vers une annexe où des informations de base sur un sujet sont fournies (des informations de base qui ne s'intègrent tout simplement pas dans le texte). Et ils peuvent orienter les lecteurs en dehors de votre document technique vers d'autres informations—vers des articles, des documents techniques et des livres contenant des informations en lien avec les vôtres. Lorsque vous créez des références croisées, suivez ces directives présentées dans renvois croisés.
Conclusions
Pour la plupart des documents techniques, vous devrez inclure une section finale. Lorsque vous planifiez la section finale de votre document technique, réfléchissez aux fonctions qu'elle peut exercer par rapport au reste du document. Des idées pour les sections finales sont présentées dans conclusions.
Annexes
Les annexes sont ces sections supplémentaires qui suivent la conclusion. Que mettez-vous dans les annexes ?—tout ce qui ne s'intègre pas confortablement dans la partie principale du document technique mais qui ne peut pas être laissé de côté. L'annexe est couramment utilisée pour de grands tableaux de données, de gros blocs de code d'exemple, des cartes dépliantes, des informations de base trop simples ou trop avancées pour le corps du document technique, ou de grandes illustrations qui ne trouvent tout simplement pas leur place dans le corps du document. Tout ce que vous jugez trop volumineux pour la partie principale du document technique ou que vous pensez être distrayant et interrompre le flux du document technique est un bon candidat pour une annexe. Notez que chacune d'elles reçoit une lettre (A, B, C, etc.).
Sources d'information
Documenter vos sources d'informations consiste à établir, maintenir et protéger votre crédibilité dans le métier. Vous devez citer ("documenter") les informations empruntées, peu importe la forme dans laquelle vous les présentez. Que vous les citiez directement, que vous les paraphrasiez ou que vous les résumiez—c'est toujours des informations empruntées. Que cela provienne d'un livre, d'un article, d'un diagramme, d'un tableau, d'une page web, d'une brochure de produit, d'un expert que vous interviewez en personne—c'est toujours des informations empruntées.
Les systèmes de documentation varient selon les professionnels et les domaines. Les ingénieurs utilisent le système IEEE, dont des exemples sont présentés tout au long de ce chapitre. Un autre système de documentation couramment utilisé est fourni par l'American Psychological Association (APA). Voir documentation pour les détails.
Numérotation des pages
Le style de numérotation des pages utilisé dans le design des documents techniques traditionnels diffère de celui du design contemporain principalement par l'utilisation de chiffres romains minuscules dans le matériel préliminaire (tout ce qui vient avant l'introduction).
Remarque : Les documents techniques plus longs utilisent souvent le style de numérotation des pages connu sous le nom de folio par chapitre ou double numérotation (par exemple, les pages du Chapitre 2 seraient numérotées 2-1, 2-2, 2-3, etc.). De même, les tableaux et les figures utiliseraient ce style de numérotation. Ce style facilite le processus d'ajout et de suppression de pages.
Invites AI pour Techdocs
Les listes de contrôle, qui restent généralement sans être lues, peuvent être utilisées comme source de prompts pour l'IA avec quelques modifications. Copiez ce qui suit, collez-le dans un système d'IA tel que Gemini de Google, et voyez ce que vous avez peut-être manqué.
Remarque : Toutes les références au contenu, au format, au style des lettres de candidature ou à leurs composants peuvent être trouvées dans le manuel de rédaction technique en ligne.
|
Invitations IA pour Techdocs Lorsque vous souhaitez que l'IA évalue un projet d'écriture, présentez-vous, dites à l'IA qui vous êtes, ce que vous voulez. Donnez à l'IA un point de référence pour effectuer des évaluations, comme un manuel en ligne. Ensuite, publiez ce que vous souhaitez que Gemini vérifie dans son évaluation. Voici un exemple : Bonjour, IA. Je suis David McMurrey, étudiant en cybersécurité au Austin Community College (Austin, Texas). Je vous demande d'évaluer le document technique suivant en utilisant ceci. manuel en ligne et les questions suivantes : |
Informations connexes
Table des matières : Un outil organisationnel clé pour les lecteurs
J'apprécierais vos pensées, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.
