writer’s guide for technical documentation

62
C-01-100-100/AG-008 POLICY/MANAGEMENT PROCEDURES AND GUIDELINES WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION (BILINGUAL) (Supersedes C-01-100-100/AG-008 dated 2017-11-02) PROCÉDURES ET LIGNES DIRECTRICES RELATIVES À LA POLITIQUE/GESTION GUIDE DE RÉDACTION – DOCUMENTATION TECHNIQUE (BILINGUE) (Remplace C-01-100-100/AG-008 datée 2017-11-02) Issued on Authority of the Chief of the Defence Staff Publiée avec l'autorisation du Chef d'état-major de la Défense OPI: DMPP 5-2 BPR : DPPM 5-2 2018-08-01

Upload: others

Post on 28-Apr-2022

2 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

POLICY/MANAGEMENT PROCEDURES AND GUIDELINES

WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

(BILINGUAL)

(Supersedes C-01-100-100/AG-008 dated 2017-11-02)

PROCÉDURES ET LIGNES DIRECTRICES RELATIVES À LA POLITIQUE/GESTION

GUIDE DE RÉDACTION – DOCUMENTATION TECHNIQUE

(BILINGUE)

(Remplace C-01-100-100/AG-008 datée 2017-11-02)

Issued on Authority of the Chief of the Defence StaffPubliée avec l'autorisation du Chef d'état-major de la Défense

OPI: DMPP 5-2BPR : DPPM 5-2

2018-08-01

Page 2: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

LIST OF EFFECTIVE PAGES ÉTAT DES PAGES EN VIGUEUR

Contact Officer: DMPP 5-2© 2018 DND Canada

Personne responsable : DPPM 5-2© 2018 MDN Canada

A

Insert latest changed pages; dispose of supersededpages in accordance with applicable orders.

Insérer les pages le plus récemment modifiées et sedéfaire de celles qu'elles remplacent conformémentaux instructions pertinentes.

NOTE

The portion of text affected by the latestchange is indicated by a black verticalline in the margin of the page. Changesto illustrations are indicated by miniaturepointing hands or black vertical lines.

NOTA

La partie du texte touchée par le plusrécent modificatif est indiquée par uneligne verticale noire dans la marge de lapage. Les modifications aux illustrationssont indiquées par des mains miniaturesà l'index pointé ou des lignes verticalesnoires.

Dates of issue for original and changed pages are: Les dates de publication des pages originales etmodifiées sont :

Original ..................... 0 ..................... 2018-08-01 Ch/Mod ..................... 3 .....................Ch/Mod ..................... 1 ..................... Ch/Mod ..................... 4 .....................Ch/Mod ..................... 2 ..................... Ch/Mod ..................... 5 .....................

Zero in Change No. column indicates an original page.The use of the letter E or F indicates the change is inEnglish or French only. Total number of pages in thispublication is 62 consisting of the following:

Un zéro dans la colonne Numéro de modificatifindique une page originale. La lettre E ou F indiqueque la modification est exclusivement en anglais ouen français. La présente publication comprend 62pages réparties de la façon suivante :

Page No./Numéro de page

ChangeNo./

Numéro demodificatif

Page No./Numéro de page

ChangeNo./

Numéro demodificatif

Title/Titre ....................................................... 0A ........ ........................................................... 0i/ii to/à vii/viii ................................................. 01-1 to/à 1-8 .................................................. 02-1 to/à 2-7/2-8 ............................................ 03-1 to/à 3-3/3-4 ............................................ 0

4-1 to/à 4-3/4-4 ............................................ 05-1 to/à 5-8 .................................................. 06-1 to/à 6-4 .................................................. 07-1 to/à 7-14 ................................................ 08-1/8-2 .......................................................... 0

Page 3: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

i/ii

FOREWORD AVANT-PROPOS

1. C-01-100-100/AG-008, Specification, Writer'sGuide for Technical Documentation, is issued onauthority of the Chief of the Defence Staff. This guideis effective upon receipt.

1. La C-01-100-100/AG-008, Spécification,Guide de rédaction - Documentation technique, estpubliée avec l'autorisation du Chef d'état-major dela Défense. Cette publication entre en vigueur dèsréception.

2. The aim of this guide is to provide guidancein the preparation of Department of National Defence(DND) publications. This guide includes the mostimportant writing style information with emphasis onareas in which errors are most frequently made. Thisguide is to be read in conjunction with other DNDdocuments that apply to writing style and methodology;however this guide is not a comprehensive documenton common grammatical usage.

2. Le présent guide fournit aux rédacteursdes renseignements utiles pour la préparation despublications du ministère de la Défense nationale(MDN). On y énonce les principales règles de rédactionet les erreurs les plus fréquentes retrouvées dans lesmanuscrits. Ce guide doit être lu conjointement auxautres documents du MDN traitant de la rédactionet de la méthodologie relative à la préparationde publications. Toutefois, ce guide ne s'agit pasd'un document exhaustif sur l'usage courant de lagrammaire.

3. This instruction is accessible onlineat the electronic publications repository: http://publications.mil.ca/epubs/pubs/pubSearch.jsp

3. Cette instruction est disponible en se servantdu dépôt de publications électroniques en direct auhttp://publications.mil.ca/epubs/pubs/pubSearch.jsp

4. This guide is UNCLASSIFIED and does notcontain Controlled Goods. There are no restrictions onthe Guide's use.

4. Ce guide est SANS CLASSIFICATION et necontient pas de Marchandises contrôlées. Il n'y aaucune restriction quant à l'utilisation de ce Guide.

5. Suggestions for changes should be forwardedthrough normal channels to National DefenceHeadquarters, Attention Director Materiel Policyand Procedures 5-2 (DMPP 5-2). The DMPP 5OPI email address is: +DMPP 5 MA&S E&MInquiries@ADM(Mat) DMPP@Ottawa-Hull, attention:DMPP 5-2 or

5. Toute proposition de modification au présentmanuel doit être envoyée par la voie réglementaire auQuartier général de la Défense nationale, à l'attentiondu Directeur - Politiques et procédures (Matériel) 5-2(DPPM 5-2). L'adresse email du BPR DPPM 5est : +DMPP 5 MA&S E&M Inquiries@ADM(Mat)DMPP@Ottawa-Hull, attention : DPPM 5-2 ou

DMPP 5-2 DPPM 5-2National Defence Headquarters Quartier général de la Défense nationale101 Colonel By Drive 101 promenade du Colonel-ByOttawa, Ontario Ottawa (Ontario)K1A 0K2 K1A 0K2

Page 4: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION
Page 5: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

iii

NOTES TO USERS AVIS AUX USAGERS

1. This is one of several publications dealing withDND publishing:

1. Le présent document fait partie de plusieurspublications relatives à l'édition des publications duMDN :

a. A-AD-100-100/AG-000, National DefencePublishing Policy and AdministrationProcedures;

a. A-AD-100-100/AG-000, Politiques etmodalités régissant les publications de laDéfense nationale;

b. A-DS-100-100/AG-002, Writing, Productionand Format of Administrative, Operational andTactical (AOT) Publications;

b. A-DS-100-100/AG-002, Guide de rédaction,de mise en page et de production despublications administratives, opérationnelleset tactiques;

c. C-01-100-100/AG-005, Acceptance ofCommercial and Foreign GovernmentPublications as Adopted Publications;

c. C-01-100-100/AG-005, Acceptation depublications provenant du commerce et degouvernements étrangers comme publicationsadoptées;

d. C-01-100-100/AG-006, Specification - Writing,Format and Production of TechnicalPublications; and

d. C-01-100-100/AG-006, Rédaction, mise enpage et production de publications techniques;et

e. D-01-000-100/SF-000, Specification forProcurement of Publishing Services andPublished Works.

e. D-01-000-100/SF-000, Spécification portantsur l'obtention de services de publication etd'ouvrages publiés.

2. This publication is the former Annex B, Writer'sGuide of C-01-100-100/AG-006 and A-DS-100-100/AG-002, Chapter 2. Additional information has beenincluded.

2. La présente publication est l'ancienneannexe B des guides de rédaction C-01-100-100/AG-006 et A-DS-100-100/AG-002, chapitre 2. Desrenseignements additionnels ont été ajoutés.

3. The aim of this guide is to provide guidancein the preparation of DND publications. This guideincludes the most important writing style informationwith emphasis on areas in which errors are mostfrequently made. This guide is to be read in conjunctionwith other DND documents that apply to writing styleand methodology. This guide is not a comprehensivedocument on common grammatical usage.

3. Le présent guide fournit aux rédacteursdes renseignements utiles pour la préparation despublications du MDN. On y énonce les principalesrègles de rédaction et les erreurs les plus fréquentesretrouvées dans les manuscrits. Ce guide doit être luconjointement aux autres documents du MDN traitantde la rédaction et de la méthodologie relative à lapréparation de publications. Toutefois, ce guide nes'agit pas d'un document exhaustif sur l'usage courantde la grammaire.

4. The publication has been divided into thefollowing eight parts:

4. La présente publication a été divisée en huitparties :

a. Part 1 provides a general introduction to theWriter's Guide;

a. la partie 1 est une introduction générale auguide de rédaction;

b. Part 2 addresses the use of numbers; b. la partie 2 concerne l'utilisation des nombres;

c. Part 3 details the use of sentences andparagraphs;

c. la partie 3 détaille l'utilisation des phrases etdes paragraphes;

d. Part 4 describes the requirements forcapitalization;

d. la partie 4 énonce les directives d'emploi desmajuscules;

e. Part 5 addresses and details the requirementsand usage of punctuation marks;

e. la partie 5 traite des règles d'usage des signesde ponctuation;

f. Part 6 explains the methods of referencing; f. la partie 6 décrit les méthodes de référence;

Page 6: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

iv

g. Part 7 explains writing for clearcommunication; and

g. la partie 7 explique comment rédiger pour unecommunication efficace; et

h. Part 8 addresses intellectual property. h. la partie 8 concerne la propriété intellectuelle.

Page 7: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

CONTENTS TABLE DES MATIÈRES

PAGE PAGE

v

PART 1 - INTRODUCTION ................................ 1-1 PARTIE 1 - INTRODUCTION ............................. 1-1

Purpose ............................................................... 1-1 Objet .................................................................... 1-1Choice of Words ................................................. 1-1 Choix des mots ................................................... 1-1Gender ................................................................. 1-2 Stéréotypes sexuels ............................................ 1-2Emphasis ............................................................. 1-3 Mise en valeur des mots .................................... 1-3Positive Expressions ........................................... 1-3 Expressions positives .......................................... 1-3Abbreviations ....................................................... 1-3 Abréviations ......................................................... 1-3Signs and Symbols ............................................. 1-4 Signes et symboles ............................................. 1-4Acronyms ............................................................. 1-4 Sigles et acronyme ............................................. 1-4Consistency ......................................................... 1-4 Uniformité ............................................................ 1-4Vague Words ....................................................... 1-5 Termes vagues .................................................... 1-5Redundancies ...................................................... 1-5 Pléonasmes ......................................................... 1-5Contractions ........................................................ 1-6 Contractions ........................................................ 1-6Voice .................................................................... 1-6 Voix et modes ..................................................... 1-6Use of Must, May, Will and Should ..................... 1-7 Devoir, pouvoir, will et should ............................. 1-7That and Which ................................................... 1-8 Pronoms relatifs anglais ...................................... 1-8

PART 2 - USE OF NUMBERS ........................... 2-1 PARTIE 2 - REPRÉSENTATION DESNOMBRES ................................................. 2-1

Numbers - Spelled Out ....................................... 2-1 Le nombre en toutes lettres ................................ 2-1Numbers - Written as Figures ............................. 2-1 Le nombre en chiffres ......................................... 2-1Numbers - Written as Roman Numerals ............. 2-2 Le nombre en chiffres romains ........................... 2-2Numbers and Units of Measurement .................. 2-3 Nombres et unités de mesures ........................... 2-3Decimal Point ...................................................... 2-4 Virgule décimale .................................................. 2-4Numbers and Metric System .............................. 2-5 Nombres et système métrique ............................ 2-5Equations and Formulae ..................................... 2-6 Équations et formules ......................................... 2-6

PART 3 - SENTENCES ANDPARAGRAPHS .......................................... 3-1

PARTIE 3 - PHRASES ET PARAGRAPHES ...... 3-1

Sentence Structure and Length .......................... 3-1 Structure et longueur de la phrase ..................... 3-1Syntax .................................................................. 3-1 Syntaxe ................................................................ 3-1Sentence Construction ........................................ 3-1 Construction de la phrase ................................... 3-1Subject-Verb Agreement ..................................... 3-2 Accord du verbe .................................................. 3-2Paragraph Structure and Length ......................... 3-2 Structure et longueur des paragraphes ............... 3-2

PART 4 - CAPITALIZATION ............................... 4-1 PARTIE 4 - EMPLOI DES MAJUSCULES ......... 4-1

Full Capitalization ................................................ 4-1 Termes en majuscules ........................................ 4-1Initial Capitalization ............................................. 4-1 Lettre initiale majuscule ...................................... 4-1Punctuation and Capitalization of

Subparagraphs ................................................. 4-2Emploi des signes de ponctuation et des

majuscules dans les alinéas ............................ 4-2

PART 5 - PUNCTUATION MARKS .................... 5-1 PARTIE 5 - SIGNES DE PONCTUATION ........... 5-1

Apostrophe .......................................................... 5-1 Apostrophe .......................................................... 5-1Brackets ............................................................... 5-1 Crochets .............................................................. 5-1Colon ................................................................... 5-1 Deux points ......................................................... 5-1Comma ................................................................ 5-2 Virgule .................................................................. 5-2Dash .................................................................... 5-3 Tiret ...................................................................... 5-3Ellipsis .................................................................. 5-3 Points de suspension .......................................... 5-3Exclamation Mark ................................................ 5-4 Point d'exclamation ............................................. 5-4

Page 8: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

CONTENTS (Cont) TABLE DES MATIÈRES (suite)

PAGE PAGE

vi

Hyphen ................................................................ 5-4 Trait d'union ......................................................... 5-4Oblique ................................................................ 5-5 Barre oblique ....................................................... 5-5Parentheses ........................................................ 5-6 Parenthèses ........................................................ 5-6Period .................................................................. 5-6 Point ..................................................................... 5-6Question Mark ..................................................... 5-6 Point d'interrogation ............................................ 5-6Quotation Marks .................................................. 5-7 Guillemets ............................................................ 5-7Semicolon ............................................................ 5-7 Point-virgule ......................................................... 5-7Spacing Punctuation Marks ................................ 5-8 Espacement des signes de ponctuation ............. 5-8

PART 6 - METHODS OF REFERENCING ......... 6-1 PARTIE 6 - MÉTHODES DE RÉFÉRENCE ........ 6-1

Quotations ........................................................... 6-1 Citations ............................................................... 6-1References to Other Publications ....................... 6-1 Renvois à d'autres publications .......................... 6-1Cross-referencing ................................................ 6-2 Procédés de renvoi ............................................. 6-2Footnotes ............................................................. 6-3 Notes en bas de page ........................................ 6-3

PART 7 - WRITING FOR CLEARCOMMUNICATION .................................... 7-1

PARTIE 7 - BIEN RÉDIGER POUR UNECOMMUNICATION EFFICACE ................. 7-1

The Fog Index ..................................................... 7-3 L'indice de compréhension ................................. 7-3

PART 8 - INTELLECTUAL PROPERTY ..........8-1/8-2 PARTIE 8 - PROPRIÉTÉINTELLECTUELLE ................................. 8-1/8-2

Copyright Symbol ............................................. 8-1/8-2 Symbole du droit d'auteur ................................ 8-1/8-2Trade-mark Symbol ..........................................8-1/8-2 Symbole de la marque de commerce .............. 8-1/8-2

Page 9: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

LIST OF FIGURES LISTE DE FIGURES

FIGURE TITLE PAGE FIGURE TITRE PAGE

vii/viii

2-1 Roman Numerals System ................. 2-3 2-1 Système des chiffres romains ........... 2-3

7-1 Fog Index .......................................... 7-4 7-1 Indice de compréhension .................. 7-4

7-2 Writing for Clarity (4 Sheets) ............. 7-6 7-2 Rédiger pour la clarté(4 feuilles) ....................................... 7-7

Page 10: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION
Page 11: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

1-1

PART 1

INTRODUCTION

PARTIE 1

INTRODUCTION

NOTE

The elements contained in this Writer's Guidemay apply in part or in full to either of the twoofficial languages of Canada. However, somerules are inherent to English grammar and willconsequently be applicable only to the Englishlanguage.

NOTA

Les articles explicatifs du guide de rédactionpeuvent s'appliquer en tout ou en partie àune ou l'autre des deux langues officiellesdu Canada. Cependant, certaines règles sontinhérentes à la grammaire française et font parconséquent partie intrinsèque du génie de cettelangue.

Purpose Objet

1. The purpose of this guide is to provideguidance in the preparation of DND publications.This guide includes the most important writing styleinformation with emphasis on areas in which errorsare most frequently made. This guide is to be read inconjunction with other DND documents that apply towriting style and methodology because this guide is nota comprehensive document on common grammaticalusage.

1. L'objet du présent guide est de fourniraux rédacteurs des renseignements utilisés pour lapréparation des publications du MDN. On y énonceles principales règles de rédaction et les erreurs lesplus fréquentes retrouvées dans les manuscrits. Ceguide doit être lu conjointement aux autres documentsdu MDN traitant de la rédaction et de la méthodologierelative à la préparation de publications car il ne s'agitpas d'un document exhaustif sur l'usage courant de lagrammaire.

Choice of Words Choix des mots

2. Words that describe requirements accuratelyand that convey meaning precisely must be used.Words with nuances or special meanings must bedefined. Needless variations and synonyms must beavoided. Jargon that cannot be supported by dictionarydefinition must not be confused with terminology:terminology consists of scientific or technical termsthat are proper to a specific discipline. Terminologymust be restricted to contexts that deal with itsspecific discipline; jargon must not be used. Technicalwords must be interpreted in accordance with currentCanadian military and commercial practices and mustbe used only when a common word does not conveythe precise meaning intended.

2. Il faut utiliser des mots dont le sens est clairet précis. Les mots comportant des nuances ou dessignifications particulières doivent être définis. Éviterles mots superflus et les synonymes inutiles, de mêmeque les termes de jargon dont les définitions nefigurent pas au dictionnaire. Il faut donc s'en tenir à laterminologie usuelle ainsi qu'aux termes scientifiquesou techniques applicables à un domaine particulier.Le sens du mot technique doit être conforme à celuique lui prêtent la terminologie militaire canadienneet l'usage commercial; le jargon ne sera pas utilisé.On peut employer des termes techniques lorsque lesmots courants ne sont pas assez précis pour rendre lapensée de l'auteur.

Page 12: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

1-2

Gender Stéréotypes sexuels

3. References to gender (such as his, hers,him, and her) must be avoided. Neutral terms suchas personnel, staff, members, the member, therecipient, and the technician which refer to a class ofpersons, must be used. The author must also do oneof (or a combination of) the following:

3. Les caractéristiques et les qualités humainesdoivent être présentées des façons à montrer qu'elless'appliquent aux femmes comme aux hommes. Pour cequi est des occupations (professions), il faut les décrirecomme ayant une valeur et une importance égales.

a. Make the gender reference plural. a. Dans la mesure du possible, les titres depostes ne doivent pas être sexistes. Il fautéviter les expressions et les titres formés avecle terme générique « homme ». À cette fin, ontentera d'utiliser certains termes collectifs oucertaines tournures neutres.

- EXAMPLES - - EXEMPLES -

1. The DND employee should always carryhis identification card. (incorrect)

1. Le personnel doit se présenter…

2. DND employees must always carry theiridentification cards. (correct)

2. L'ensemble du personnel doit seprésenter…

3. Not applicable. 3. Toute personne doit se présenter…

4. Not applicable. 4. Heure-personne ou année-personne(plutôt que d'heure-homme ou d'année-homme).

b. Delete the pronoun. b. Sans objet.

- EXAMPLES - - EXEMPLES -

1. The Director is responsible for … Hedetermines … (incorrect)

1. Sans objet.

2. The Director is responsible for determining… ensuring … (correct)

2. Sans objet.

c. Substitute an article (a, an, the) for his. c. Sans objet.

d. Repeat the noun as an adjective. d. Sans objet.

- EXAMPLES - - EXEMPLES -

1. The captain … His responsibilities …determines … (incorrect)

1. Sans objet.

2. The captain … The captain'sresponsibilities … (correct)

2. Sans objet.

e. Use a synonym. e. Sans objet.

f. Substitute with the word one or one's. f. Sans objet.

Page 13: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

1-3

Emphasis Mise en valeur des mots

4. To add emphasis, the writer may bold-facethe text, underlining text must not be used exceptfor references to security classification. Except forinstances of clarity, quotation marks must not be usedfor emphasis (refer to Section 5 for their proper use).

4. Pour mettre en valeur certains mots, l'auteurles met en caractères gras. En général, il n'est paspermis de souligner dans un texte pour attirer l'attentiondu lecteur, sauf pour mentionner des classificationsde sécurité. Par ailleurs, on ne doit pas employerles guillemets pour mettre en valeur un ou des mots(référer à la section 5).

- EXAMPLE -

Use the command C:\>net useq:\\<servername>\<sharename>> to map anetwork drive in Windows.

- EXEMPLE -

Utiliser la commande C:\>netuse q:\\<servername>\<sharename>> pourétablir une correspondance avec un piloteréseau dans Windows.

Positive Expressions Expressions positives

5. State what is required rather than what is notrequired.

5. Il est préférable de choisir des tournurespositives plutôt que des tournures négatives pourénoncer des idées sauf dans les textes de naturetechnique, où la forme négative est préférable.

- EXAMPLE -

"Panels must be free of scratches." is preferredover "Panels must not show scratches."

- EXEMPLE -

On dira : Négliger sa santé, plutôt que : Ne passoigner sa santé.

Abbreviations Abréviations

6. Abbreviations must only be used when spaceis at a premium, as in a Figure, a formula, anequation, or when cumbersome terms, detracting fromthe readability, would otherwise be used repeatedly ina text. When only a few terms are to be abbreviated,they may be shown by placing the abbreviation inparentheses after the term when used for the firsttime and thereafter using only the abbreviation. Ifabbreviations are required, refer to C-01-100-100/AG-006, Part 1 for applicable reference guides.

6. Les abréviations ne doivent être utiliséesque dans des espaces restreints, comme dans unefigure, une formule, une équation, ou lorsque destermes encombrants nuisant à l'intelligibilité du texteseraient alors utilisés avec répétition dans le texte.Lorsqu'il n'y a qu'un nombre restreint d'abréviations,il faut d'abord les présenter en toutes lettres unepremière fois dans le texte et les faire suivre del'abréviation entre parenthèses. Par la suite, on peutemployer l'abréviation. S'il est nécessaire d'utiliser desabréviations, se référer à la C-01-100-100/AG-006,partie 1 pour la liste des ouvrages de référencecourants.

7. Punctuation. If an abbreviation does not forma word in itself, it must not be punctuated. If anabbreviation forms a word, then a period must followthe abbreviation.

7. Ponctuation. En fin de phrase, le pointabréviatif sert aussi de point final et doit être suivi dedeux espaces. Les abréviations semblables de motsdifférents sont à éviter.

- EXAMPLE -

If No. is the abbreviation for number, then aperiod must follow the abbreviation.

- EXEMPLE -

ch. pour chant et chapitre, s. pour suivant etsiècle.

Page 14: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

1-4

Signs and Symbols Signes et symboles

8. The use of signs and symbols must berestricted to equations, formulae and Figures. Thefollowing signs and symbols must not be used in text:

8. L'usage de signes et symboles doit être retreintautant que possible aux équations, aux formules et auxfigures. Aucun des signes et symboles suivants ne doitêtre utilisé dans un texte :

a. ' for feet; a. « ' » pour pied;

b. " for inches; b. « " » pour pouce;

c. % for per cent; c. « % » pour pourcentage;

d. ° for degrees; and d. « ° » pour degré de température; et

e. x to denote "by" for dimensions (for example,use 4 cm by 8 cm not 4 cm x 8 cm).

e. « X » pour le signe de multiplication quandil s'agit de dimensions (par exemple, écrivez4 cm sur 8 cm au lieu de 4 cm x 8 cm).

Acronyms Sigles et acronyme

9. An acronym is a word or expression formedfrom the initial letters of other words. Acronyms mustnormally be written in upper-case letters and withoutperiods, except those that through common usagehave been accepted as words.

9. Un sigle est une initiale ou une suite d'initialesservant d'abréviation, comme H.L.M. (habitation à loyermodéré). L'acronyme est un sigle prononcé et acceptécomme un mot ordinaire.

- EXAMPLES - - EXEMPLES -

1. NATO - North American TreatyOrganization; and

1. OTAN - Organisation du Traitéd'Atlantique Nord; et

2. radar - radio detection and ranging. 2. Sans objet.

10. A new acronym (or abbreviation) must notbe introduced in the title, heading or sub-headingof a document. It must be written in full on thefirst appearance in a Part, followed by the acronym(or abbreviation) in parentheses (). Subsequentappearances of the acronym (or abbreviation) in a Partare to be in abbreviated form.

10. Il faut éviter de présenter un nouvel acronyme(ou abréviation) dans le titre, l'en-tête ou l'en-têtecontinu d'un texte; au contraire, il faut d'abord leprésenter en toutes lettres une première fois dansla partie et le faire suivre de l'acronyme (ou del'abréviation) entre parenthèses (). Par la suite, on peutemployer l'acronyme ou l'abréviation dans la partie.

11. The usage of acronyms must be restricted;however, if many acronyms are frequently used, thenthey must be defined in a List of Abbreviations.

11. L'emploi des acronymes doit être restreint;cependant, si l'on emploie un certain nombred'acronymes, il faut alors les définir dans une Liste desabréviations.

Consistency Uniformité

12. The terminology in texts of DND publicationsmust be consistent. The following rules must beobserved:

12. La terminologie des publications du MDN doitêtre uniforme. Il faut suivre les règles suivantes :

a. Use of Abbreviations. If in one instance"engineering drawings" is used and in another,"drawings", the question arises whether thesame drawings are being discussed.

a. Emploi des abréviations. Si dans un premiercas, l'expression « dessin technique » estintroduite et que, par la suite, le mot « dessin »apparaît dans le texte, l'emploi de ces deuxexpressions soulève la confusion, à savoir s'ils'agit toujours du même dessin technique.

Page 15: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

1-5

b. Synonyms and Pronouns. To avoidconfusion, the use of synonyms and pronounsmust generally be avoided.

b. Synonymes et pronoms. En général, il fautéviter l'emploi de synonymes et de pronomsdans un même texte.

- EXAMPLE -

Use shears throughout a publication rather thanthe shear, the product, the electric shear, it, thetool, or other descriptors.

- EXEMPLE -

On ne doit pas employer « les cartouches »dans une phrase et « ces munitions » dans uneautre. Il faut s'en tenir à la même expressionpour éviter toute confusion.

c. Consistency of Number. The use of either theplural or singular for the item being coveredmust be consistent throughout the publication.

c. Uniformité du nombre. L'uniformité est derigueur lorsqu'une expression se retrouveplusieurs fois dans un même texte.

- EXAMPLE -

Do not use "the charge must be …" in oneinstance and "the charges must be …" inanother unless the differences are relevant.

- EXEMPLE -

Si l'on dit dans un premier cas : « Le coûts'élèvera à … », il faut éviter de dire plus loindans le texte : « Les coûts s'élèveront à … ».

Vague Words Termes vagues

13. Vague or ambiguous words like these must beavoided because they are difficult to evaluate:

13. Il faut éviter d'employer des termes vaguesou ambigus, comme les suivants, parce qu'ils sontdifficiles à juger :

a. excessive; a. excessif;

b. good; b. bon;

c. suitable; c. convenable;

d. might; d. peut-être;

e. considerable; e. considérable;

f. readily; f. aisément;

g. sufficient; g. suffisant;

h. various; h. divers;

i. negligible; i. négligeable;

j. nearly; j. environ;

k. approximately; k. approximatif;

l. substantial; l. important;

m. adequate; and m. adéquatement; et

n. preferable. n. préférable.

Redundancies Pléonasmes

14. The following phrases must be avoided; thepreferred expressions must be used:

14. Une pléonasme est une répétition inutile determes. La liste suivante fournit des exemples depléonasmes et l'expression correcte correspondante :

Page 16: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

1-6

Avoid Preferred

in order to access the access the

due to the fact that because

first and foremost first

each and every each

both of these both

at all times always

in the case of for

in the event that if

a large number of many

physical size close size

proximity close

attach together attach

in order that so that

in a manner such that so that

closed position closed

uniform consistent consistent

a quantity of six six

for a period of two min for two minutes

properly mixed mixed

two cubic metres in volume two cubic metres

proper voltage (stipulate amount of voltage)

Incorrect Correct

pareil comme pareil à

joindre ensemble joindre

comme par exemple par exemple

il suffit simplement il suffit

puis ensuite puis

une fausse imitation une imitation

collaborer ensemble collaborer

un grand maximum un maximum

actuellement en cours en cours

prévoir d'avance prévoir

s'entraider mutuellement s'entraider

répéter de nouveau répéter

Contractions Contractions

15. Contractions, although grammatically correct,must be avoided.

15. Les contractions de verbes avec lesexpressions négatives relèvent du génie de la langueanglaise et n'existent pas en français.

Voice Voix et modes

16. In DND publications, the active voice ispreferred to the passive.

16. Dans les publications du MDN, on utilisepréférablement le français à voix active. On emploiel'infinitif plutôt que l'impératif pour donner desinstructions, surtout dans les textes de naturetechnique.

- EXAMPLES - - EXEMPLES -

1. Amber lights indicate a need for caution.(active voice)

1. Le personnel change les pneus tous lestrois mois. (voix active)

2. A need for caution is indicated by amberlights. (passive)

2. Les pneus sont changés tous les troismois. (voix passive)

3. Not applicable. 3. Faire le tour du véhicule (plutôt que : Faitesle tour du véhicule).

Page 17: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

1-7

Use of Must, May, Will and Should Devoir, pouvoir, will et should

17. The following defined words have othermeanings dictated by particular contexts; the mostcommon usage is given:

17. Les verbes définis plus bas comportant dessignifications particulières selon l'emploi; voici lesusages les plus communs :

a. Must. To express a requirement, use theverb must. Formerly, writers avoided itsuse within technical documents howeverthe verb must is now obligatory withinStatements of Work and associated technicaldocuments, is recommended for Statementsof Requirements, and is encouraged within alltechnical documents.

a. Devoir. L'obligation morale ou physiques'exprime par le verbe « devoir », qui traduitle « must ». Auparavant, les rédacteursévitaient de l'utiliser dans les documentstechniques. Toutefois, l'utilisation du verbe« devoir » est maintenant obligatoire dansles énoncés de travail et les documentstechniques connexes, est recommandée pourles énoncés de besoins, et encouragée danstous les documents techniques.

b. May. To convey that something is possible orpermissible and for information purposes only,may must be used. The verb may should beavoided within SOWs and associated technicaldocuments because it does not create acontractual obligation.

b. Pouvoir. La permission s'exprime par le verbe« pouvoir » comme équivalent de « may ».Il faudrait éviter l'utilisation du verbe pouvoirdans les énoncés de travail et les documentstechniques connexes, car il ne crée pasd'obligation contractuelle.

c. Will. To express a declaration of intent orpurpose, will must be used. Within SOWsand associated technical documents, willexpresses intent on the part of the Governmentof Canada only.

c. « Will ». L’intention ou le dessein, quis’exprime en anglais par l’auxiliaire « will »,rend en français un problème quant àl’usage et la relation aux antécédents. Dansles énoncés de travail et les documentstechniques connexes, le verbe « will » exprimeuniquement une intention de la part dugouvernement du Canada.

d. Should. To express a desirable requirementor provision in SOWs and associated technicaldocuments, use the verb should. When used,it only indicates a preference or identifiesdesirable goals that will be subject to arated evaluation within a contractor selectionprocess.

d. « Should ». Pour exprimer un besoin ou unedisposition souhaitable dans les énoncés detravail et les documents techniques connexes,les rédacteurs anglophones utilisent le verbe« should ». Son utilise indique une préférenceou des objectifs souhaitables qui feront l'objetd'une évaluation cotée dans le cadre d'unprocessus de sélection d'un fournisseur.

- EXAMPLES - - EXEMPLES -

1. The aircraft must carry eight toboggans. 1. L'aéronef doit être équipé de huittoboggans.

2. Canada test the aircraft's capacity tocarry….

2. La Couronne testera la capacité del'aéronef…

Page 18: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

1-8

That and Which Pronoms relatifs anglais

18. That is a relative pronoun used to introducea restrictive clause (a clause that adds essentialinformation to the meaning of a sentence). Therestrictive clause must never be set off by commas.Which introduces a non-restrictive clause (a clausethat adds information but is not necessary to theunderstanding of the sentence).

18. Les pronoms relatifs anglais « that » « which »ne présentent pas en français un problème quant àl'usage et la relation aux antécédents.

- EXAMPLES - - EXEMPLES -

1. The dog that was injured yesterday shouldrecover. (restrictive)

1. Sans objet.

2. The house, which was built withcommunity support, is warm in the winter.(non-restrictive)

2. Sans objet.

19. In some cases, a writer is justified in usingwhich in a restrictive clause. This is the case whenthere is already one that in a sentence.

19. Sans objet.

- EXAMPLES - - EXEMPLES -

1. A friend told me that the car that theybought was recalled. (poor)

1. Sans objet.

2. A friend told me that the car which theybought was recalled. (improved)

2. Sans objet.

20. The writer may choose to modify the sentenceso that the second relative pronoun is avoided.

20. Sans objet.

- EXAMPLE -

A friend told me that the car they had boughtwas recalled.

- EXEMPLE -

Sans objet.

Page 19: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

2-1

PART 2

USE OF NUMBERS

PARTIE 2

REPRÉSENTATION DES NOMBRES

Numbers - Spelled Out Le nombre en toutes lettres

1. The following numbers must be spelled out: 1. On doit écrire en toutes lettres :

a. either of two adjacent numbers; and a. l’un de deux nombres adjacents; et

- EXAMPLES -

five 2-inch bolts, or

- EXEMPLES -

cinq boulons de 2 pouces, ou

153 ten-pound characters. 153 caractères de dix points.

b. numbers that are used in fractions orcompound adjectives, and that do not describeunits of measurement.

b. les nombres utilisés dans des fractions ou desmots composés et qui n’accompagnent pasd’unités de mesure.

- EXAMPLES -

one half, and

- EXEMPLES -

un demi, et

three-phase plan. un deux-pièces.

Numbers - Written as Figures Le nombre en chiffres

2. The following numbers must be written asfigures:

2. On doit écrire en chiffres arabes :

a. all cardinal numbers; a. tous les nombres cardinaux;

b. all ordinal numbers, with the appropriate suffix b. tous les nombres ordinaux s’abrègent avec un« e » supérieur;

- EXAMPLE -

10th, 23rd.

- EXEMPLE -

10e, 23e.

c. numbers with a decimal point; c. les nombres décimaux;

d. numbers in equations, formulae, ormathematical expressions

d. les nombres dans les équations, formules oules expressions mathématiques;

- EXAMPLE -

Subtract 2 and divide by 5.

- EXEMPLE -

Soustraire 2 et diviser par 5.

e. numbers that represent organizationalpositions;

e. les nombres représentant des postesorganisationnels;

- EXAMPLE -

Pay level 3.

- EXEMPLE -

Niveau de paye 3.

Page 20: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

2-2

f. a part or unit considered one of a series; f. la numérotation d’une partie ou d’une unitédans une série;

- EXAMPLE -

Unit No. 1 or Rack No. 3.

- EXEMPLE -

Unité n° 1 ou baie n° 3.

g. monetary expressions; g. les sommes d’argent;

- EXAMPLE -

$400 and $1.98.

- EXEMPLE -

400 $ et 1,98 $.

h. numbers that express percentage, proportion,distance, dimensions, weight, volume,temperature, dates, clock time, latitude,longitude, and other units of measurement;and

h. les nombres des mesures de longueur, desurface, de volume, de capacité et depoids(masse). Les degrés, minutes, secondesde latitude et de longitude, de température, lesheures (divisions de temps), les taux d’intérêtet les pourcentages, les dates; et

NOTE

Within the United States, the expression ofdates is by month, day, and year.

NOTA

Les dates aux États-Unis s’écrivent encommençant par le mois, suivi du jour et del’année.

i. mixed numbers. i. les nombres fractionnaires composés.

- EXAMPLE -

1-1/4 inch bolts.

- EXEMPLE -

1 1/4 révolution.

Numbers - Written as Roman Numerals Le nombre en chiffres romains

3. Numbers can be represented as Romannumerals. Roman numerals are used in the followingsituations:

3. Les nombres peuvent être écrits en chiffresromains dans les situations suivantes :

a. page numbering for Front Matter of DNDmanuals; and

a. numéro des pages préliminaires des manuelsdu MDN; et

b. when identifying rulers or ships with the samename.

b. en parlant de souverains ou de navires quiportent le même nom.

- EXAMPLES -

The List of Figures is found on page iv.

- EXEMPLES -

La liste des figures se trouve à la page iv.

Queen Elizabeth II (ruler) and the QueenMary II (ship).

La Reine Élizabeth II (souveraine) et le QueenMary II (navire).

Page 21: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

2-3

4. The Roman numerals system is found inFigure 2-1. To express numbers lower or higher thanthe Roman numeral, insert the appropriate numeral infront (to subtract) or behind (to add) the closest numeralto the desired number.

4. Le système des chiffres romains est décritdans la Figure 2-1. Pour écrire des nombres inférieursou supérieurs aux chiffres romains de la figure,ajouterle chiffre approprié devant(pour soustraire) ou après(pour additionner) le chiffre le plus près du nombredésiré.

- EXAMPLES -

viii = eight, and

- EXEMPLES -

viii = huit, et

ix = nine. ix = neuf.

Lower CaseMinuscule

Upper CaseMajuscule

No.N°

Written OutEn toutes lettres

i I 1 Oneun

v V 5 Fivecinq

x X 10 Tendix

l L 50 Fiftycinquante

c C 100 One hundredcent

d D 500 Five hundredcinq cents

m M 1000 One thousandun mille

Figure 2-1 Roman Numerals SystemFigure 2-1 Système des chiffres romains

Numbers and Units of Measurement Nombres et unités de mesures

5. The number (numeric value) and itscorresponding unit of measurement must not split apartand be written on two separate lines.

5. Le nombre (en chiffres) et l’unité de mesure quis’y rattache ne doivent pas se séparer ou être écrits surdeux lignes différentes.

- EXAMPLES - - EXEMPLES -

1. Use scissors to cut twometres of cloth. (Incorrect)

1. Utiliser les ciseaux pour couperdeux mètres de tissu. (incorrect)

2. Use scissors to cut two metres of cloth.(Correct)

2. Utiliser les ciseaux pour couperdeux mètres de tissu. (correct)

3. The plane flew 300kilometers without refuelling. (Incorrect)

3. L’avion a parcouru 300kilomètres sans faire le plein. (incorrect)

4. The plane flew 300 kilometres withoutrefuelling. (Correct)

4. L’avion a parcouru 300 kilomètres sansfaire le plein. (correct)

Page 22: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

2-4

6. Units of measurement must be written usingCanadian spelling.

6. Sans objet.

- EXAMPLES - - EXEMPLES -

1. Meters and kilometers. (Incorrect) 1. Sans objet.

2. Metres and kilometres. (Correct) 2. Sans objet.

7. Fractions standing alone or modifying wordsthat are not units of measurement must be spelled out.Fractions combined with whole numbers or modifyingunits of measurement must be written as full sizefigures.

7. Les fractions seules ou les fractions modifiantdes mots qui ne sont pas des unités de mesure doiventêtre écrites en toutes lettres. Les fractions combinéesavec des nombres entiers ou modifiant des unités demesure doivent être écrites en chiffres (ou en touteslettres).

- EXAMPLES - - EXEMPLES -

1. increased by one half, and 1. augmenté de une demie, et

2. 1-1/2 revolutions. 2. 1 1/2 révolution ou une révolution et demie.

Decimal Point Virgule décimale

8. The decimal point must be used only when it isboth preceded and followed by a number. For numbersless than one, a zero must precede the decimal point. Adecimal point must follow a whole number only to showprecision; the decimal point must in such cases befollowed by a zero. In columns of numbers, the decimalpoints must be aligned vertically unless the column ofnumbers is for mixed units of measurement.

8. Le signe décimal en français est la virgule,mais dans les publications du MDN, un point doit êtreutilisé. La virgule de la décimale ne doit être utiliséeque lorsqu’elle est précédée et suivie d’un nombre. Lechiffre zéro précédera la virgule des nombres qui sontinférieurs à un. Une virgule suivra un nombre entieruniquement par souci de précision; dans ce cas, lavirgule sera suivie d’un zéro. S’ils sont présentés encolonnes, les chiffres doivent être alignés verticalementà partir de la virgule décimale, à moins que la colonnene regroupe différentes mesures.

- EXAMPLES -

0.5

- EXEMPLES -

0.5

10.0 10.0

Page 23: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

2-5

Numbers and Metric System Nombres et système métrique

9. In the metric system, there are two acceptablepractices for indicating the decimal marker: with adecimal point or with a comma. In DND publications thedecimal point must be used, e.g. 567.49 not 567,49.A letter space must be used instead of a comma toseparate a long number into three-digit groups. Four-digit numbers, either to the left or the right of the decimalpoint, may be written either with or without a space;numbers of more than four digits, either to the left ofright of the decimal point, must be written with spacesas shown in the examples that follow (the practices setout in the CAN-Z234.1-00, Canadian Metric PracticeGuide must be followed for metric numbers):

9. Le MDN utilise la virgule dans ses publicationspour indiquer les décimales dans le système métrique.Il ne faut pas utiliser de virgule pour séparer en groupesde trois les nombres comportant plusieurs chiffres.L’espace d’une lettre sera dorénavant laissé à la placede la virgule. Les nombres de quatre chiffres, soit àgauche, soit à droite de la virgule décimale, peuvents’écrire avec ou sans espace. Les nombres de plus dequatre chiffres, soit à gauche, soit à droite de la virgule,doivent être écrits avec des espaces. Pour les nombresmétriques, on doit respecter (les méthodes énoncéesdans la publication CAN-Z234.1-00, Guide canadien defamiliarisation au système métrique) :

- EXAMPLES - - EXEMPLES -

1. 1234.0 1. 1234.0

2. 1 234.0 2. 1 234.0

3. 4.1234 3. 4.1234

4. 4.123 4 4. 4.123 4

5. 1 000 000 5. 1 000 000

6. 15 000.12 6. 15 000.12

7. 15 000.135 000 7. 15 000.135 000

8. 1.105 001 01 8. 1.105 001 01

10. In the expression for a quantity, the unit symbolmust be placed after the numerical value, and a spacemust be left between the numeric value and the unitsymbol. The only exception to this requirement occurswith non-SI plane angles: there must no space betweenthe numerical value and the superscript-type symbolsfor the degree (°), the minute ('), and the second (").

10. Lorsqu’on exprime une quantité, le symbole del’unité doit être placé après la valeur numérique et doitêtre séparé de celle-ci par un espace insécable. Laseule exception concerne les symboles d’unités horsSI des angles plans : aucun espace ne sépare la valeurnumérique des symboles en exposant de degré (°), deminute (') et de seconde (").

- EXAMPLES - - EXEMPLES -

1. a mass of 12 kg, not 12kg, 1. une masse de 12 kg, et non 12kg,

2. a temperature of 43 °C, not 43°C, and 2. une température de 43 °C et non 43°C, et

3. an angle of 163.6°, not 163.6 °. 3. un angle de 163.6°, et non 163.6 °.

Page 24: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

2-6

Equations and Formulae Équations et formules

11. Elements of equations and signs or symbolsused in formulae must be described either in text or in aseparate list near the equations or formulae. If there areseveral equations or formulae, they must be identifiedfor referencing in text by consecutive Arabic numbersin parentheses. The numbers set in parentheses areplaced close to the right margin opposite the equationsor formulae they identify.

11. Les éléments d’une équation et les signesou symboles utilisés dans les formules doivent êtreexpliqués dans le texte ou sur une liste séparéeà proximité de l’équation ou de la formule. Si letexte contient un grand nombre de ces équations ouformules, il faut, à des fins de référence, les identifierdans le texte par des nombres arabes consécutifs entreparenthèses. Ces nombres, entre parenthèses, doiventensuite être inscrits près de la marge de droite, vis-à-vis des équations ou des formules auxquelles ils serapportent.

- EXAMPLES - - EXEMPLES -

1. E = mc2

where

E = energy,m = mass, andc = speed of light.

1. E = mc2

E = l’énergie,m = la masse, etc = la vitesse de la lumière.

2. E = F/q

where

E = electric field,F = force, andq = point charge.

2. E = F/q

E = champ électriqueF = force, etq = charge ponctuelle.

3. T = (3R + P) - (2P - R) (1) S

S = (4MN - 6N) + M (2) N

In the application of formula (1), the valueof S derives from formula (2).

3. T = (3R + P) - (2P - R) (1) S

S = (4MN - 6N) + M (2) N

La valeur « S » employée dans la formule(1) provient du résultat de la formule (2).

12. When a long expression must be carried overto a succeeding line, divide the equation at one of thefollowing points:

12. Lorsqu’une longue expression doit sepoursuivre à la ligne suivante, diviser l’équation à l’undes points suivants :

a. Set the first portion of the equation flush withthe left margin of the allotted area and thesecond portion flush with the right margin ofthat area:

a. Placer la première tranche de l’équation vis-à-vis la marge gauche de la zone allouée et ladeuxième tranche vis-à-vis la marge droite decette zone :

(1) just before an equals (=) sign in anequation;

(1) dans le cas d’une équation,immédiatement avant un signe égal (=);

(2) just before a plus (+) sign or minus (-) signseparating elements of comparable rank;and

(2) immédiatement avant un signe d’addition(+) ou de soustraction (-) séparant deséléments de même importance; et

Page 25: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

2-7/2-8

(3) just before a multiplication (x) sign.Use this type of multiplication indicationwherever line interruption is necessary ata multiplication point.

(3) immédiatement avant un signe demultiplication (x). Utiliser ce typed’identification d’une multiplication dèsqu’une interruption de la ligne s’avèrerequise à un point de multiplication.

b. In a series of equations, align the major equalssign.

b. Dans le cas d’une suite d’équations, alignerlessignes égaux principaux.

- EXAMPLE - - EXEMPLE -

x = (3 x 2 + 495) + (y2/3.68 + z3) x = (3 x 2 + 495) + (y2/3.68 + z3)

= =

c. Make all enclosing symbol, such asparentheses () or braces {}, just wide enough toalign with the highest and lowest points of thematter enclosed. Similarly, make the dividingor covering element, such as the horizontaldivision symbol ( ) or the top ofthe radical sign (√33), must be wide enough toalign with the right and left outer edges of thematter divided or covered.

c. Régler la hauteur des symboles deregroupement – par exemple les parenthèses() ou les accolades { } – de façon à cequ’ils coïncident avec les points inférieuret supérieur des éléments à l’intérieur. Parailleurs, régler la largeur des symboles deséparation ou de recouvrement – par exemplela division horizontale ( ) ou la barresupérieure de la racine carrée (√33) – de façonà ce qu’ils coïncident avec les points gaucheet droit des éléments divisés ou recouverts.

d. Use parentheses, brackets, and braces in thefollowing order to set off parts of an equation.

d. Afin de segmenter les différentes parties d’uneéquation, utiliser les parenthèses, les crochetset les accolades dans l’ordre suivant :

- EXAMPLE -

{ [ ( ) ] }

- EXEMPLE -

{ [ ( ) ] }

Page 26: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION
Page 27: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

3-1

PART 3

SENTENCES AND PARAGRAPHS

PARTIE 3

PHRASES ET PARAGRAPHES

Sentence Structure and Length Structure et longueur de la phrase

1. A sentence consists of at least a subjectand a verb. The subject may be a noun, pronoun,phrase or clause; the verb must agree with the subjectin number, and may be complemented by a directobject, indirect object, adverbial phrase or a clause.Complicated clauses must be avoided as they oftenresult in ambiguity.

1. En général, une phrase comprend au moins unsujet et un verbe. Le sujet peut être un nom, un pronom,un infinitif, une locution ou une proposition; le verbedoit s'accorder en genre et en nombre avec le sujetet il peut être suivi d'un complément d'objet direct ouindirect, d'une locution adverbiale ou d'une proposition.Les phrases compliquées doivent être évitées car ellessont souvent ambiguës.

Syntax Syntaxe

2. Syntax is the wording and arranging of theparts of a sentence to form a coherent whole. Properarrangement consists in placing related words asclose to each other as possible so that their meaningis clear. The reader should understand descriptions,explanations, and instructions quickly, without havingto consult other sources for clarification.

2. On entend par syntaxe les règles qui présidentà l'ordre des mots et à la construction des phrases.Le lecteur doit pouvoir comprendre les descriptions,les explications et les instructions rapidement, sansavoir à consulter d'autres sources pour obtenir deséclaircissements.

- EXAMPLES - - EXEMPLES -

1. While facing the control panel, the left boltshould be tightened before the right of thedial. (poor)

1. En faisant face au tableau de commande,le boulon gauche doit être serré avant ladroite sur le cadran. (médiocre)

2. Facing the control panel, first tighten thebolt on the left of the dial, then the one onthe right. (acceptable)

2. Le technicien, faisant face au tableau decommande, doit serrer premièrement leboulon à la gauche du cadran, puis celuide droite. (acceptable)

Sentence Construction Construction de la phrase

3. Parallel Structure. Parallel structure must beused to express parallel ideas.

3. Parallélisme. Pour obtenir des phrasesconcises et claires, on doit s'en tenir à une structureconstante.

- EXAMPLES - - EXEMPLES -

1. The recorder operates quietly and withsmoothness. (not parallel)

1. Ce moteur roule silencieusement et avecrapidité. (structure non constante)

2. The recorder operates quietly andsmoothly. (parallel)

2. Ce moteur roule silencieusement etrapidement. (structure constante)

Page 28: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

3-2

4. A sentence must contain only one mainthought.

4. Toute phrase ne doit contenir qu'une seuleidée principale.

- EXAMPLES - - EXEMPLES -

1. Check for lube oil, grease, hydraulic fluid,fuel oil and water leaks and if leaksare discovered, report conditions to themaintenance supervisor. (poor)

1. Vérifier les lubrifiants, graisse, fluideshydrauliques, carburant et eau pour voir s'ily a des fuites, et faire rapport de la situationau surveillant de l'entretien. (médiocre)

2. Check for leaks of lube oil, grease,hydraulic fluid, fuel oil and water. If leaksare found, report them to the maintenancesupervisor. (better)

2. Vérifier s'il y a des fuites de lubrifiant,de graisse, de fluides hydrauliques, decarburant et d'eau. Si tel est le cas,signaler ces fuites au surveillant de lamaintenance. (bon)

5. Modifiers must be placed close to the wordthey modify.

5. Les adjectifs doivent se trouver à proximité dumot qu'ils qualifient.

- EXAMPLES - - EXEMPLES -

1. Wipe tools on clean rags if greasy. (poor) 1. Essuyer les outils avec des chiffonspropres s'ils sont graisseux. (médiocre)

2. Wipe greasy tools on clean rags. (better) 2. Essuyer les outils graisseux avec deschiffons propres. (bon)

Subject-Verb Agreement Accord du verbe

6. Single subjects require single verbs; pluralsubjects require plural verbs.

6. Le verbe s'accorde en nombre avec le sujet(et le participe passé s'accorde en genre et en nombreavec le sujet). Si celui-ci est au singulier, le verbe semet au singulier; si le sujet est au pluriel, le verbe semet au pluriel. Avec « plus d'un », le verbe se met ausingulier. Avec « moins de deux », il se met au pluriel,l'accord se faisant avec le complément de « moins »ou de « plus ». Quand le verbe a pour sujet un nomcollectif suivi d'un complément, il s'accorde avec celuides deux mots (le collectif ou le complément) sur lequelon arrête sa pensée.

- EXAMPLES - - EXEMPLES -

1. A series of tests were completed.(incorrect)

1. La majorité des officiers était présente.(pris collectivement)

2. The first of the tests was completed.(better)

2. La majorité des officiers sont à court demunitions. (pris individuellement)

Paragraph Structure and Length Structure et longueur des paragraphes

7. Paragraphs must be short, usually three to fivesentences in length. Paragraphs must deal with onlyone idea, and must include only as much informationas the reader can grasp easily.

7. Les paragraphes doivent être courts,généralement de trois à cinq phrases. Ils doiventcomporter une seule idée principale et le nombre derenseignements qu'ils contiennent ne doit pas nuire àla compréhension du lecteur.

8. Each paragraph must be organized arounda topic sentence that gives the main idea of itscontents. Sentences must be arranged in a logicalorder. Paragraphs may carry run-in headings followedby a period.

8. Chaque paragraphe doit être centré sur unephrase principale qui donne l'idée générale de soncontenu. Les phrases doivent se succéder selonun ordre de progression logique. Les paragraphespeuvent avoir un en-tête continu suivi d'un point.

Page 29: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

3-3/3-4

9. Paragraphs must be limited to no more thanthree levels of subdivision.

9. Les subdivisions de paragraphes ne doiventpas dépasser plus de trois niveaux.

Page 30: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION
Page 31: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

4-1

PART 4

CAPITALIZATION

PARTIE 4

EMPLOI DES MAJUSCULES

Full Capitalization Termes en majuscules

1. Full capitalization must be used for: 1. Les majuscules doivent être utilisées pour :

a. acronyms; a. les acronymes et certains sigles,

b. call-out labels; b. les repères et les légendes des illustrations,

c. centre headings; c. les en-têtes centrés,

d. primary side headings; d. les en-têtes latéraux principaux,

e. security classifications; e. les classifications de sécurité,

f. the headings of annexes; appendices;glossaries and indices; and

f. les titres d'annexes, d'appendices, deglossaires et d'index, et

g. placarded control settings and placardednames of controls.

g. les réglages et les noms des commandesaffichées.

Initial Capitalization Lettre initiale majuscule

2. The first letter must be capitalized in thefollowing cases:

2. La lettre initiale doit être écrite en majusculedans les cas suivants :

a. the first word of a sentence; a. le premier mot d'une phrase;

b. the important words in run-in headings; b. le premier mot d'un en-tête continu;

c. each important word in a title; c. le premier mot d'un titre;

d. proper names; d. les noms propres;

e. names of planets, natural and artificialsatellites, when it refers to a planet or artificialsatellite in general. Use initial capitalizationwhen referring to a specific planet or celestialbody;

e. le nom des planètes et des satellites naturelsou artificiels lorsqu'il y a référence généraleà une planète ou un satellite artificiel. Mettrela majuscule à la lettre initiale lorsqu'il ya référence à une planète ou un astre enparticulier;

- EXAMPLES - - EXEMPLES -

1. Mercury, Earth, Mars. 1. Mars, Mercure, Terre.

2. Sun and Moon. 2. Elle avait le soleil dans les yeux.

3. Anik F3. 3. Calculer la distance de la Terre.

f. each important word in captions and lists ofillustrations;

f. le premier mot de chaque titre d'illustration etde chaque entrée dans une liste des figures;

g. each important word in a contents; g. le premier mot de chaque entrée dans la tabledes matières;

h. the word Government, when it refers to theCanadian Government;

h. sans objet;

Page 32: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

4-2

i. single letter compound nouns; and i. certains mots ou expressions composés avecune lettre; et

- EXAMPLE -

X-axis.

- EXEMPLE -

rayons X.

j. words when they apply to the hierarchybreakdown of publications. The words statedin the Example are not necessarily all used inone publication.

j. sans objet,

- EXAMPLE -

Volume, Book, Part, Chapter, Section, Annex,and Appendix.

- EXEMPLE -

Sans objet.

Punctuation and Capitalization of Subparagraphs Emploi des signes de ponctuation et desmajuscules dans les alinéas

3. Punctuation and Capitalization Used. Thepunctuation used for paragraphs and all subsequentsubparagraph levels must be as follows:

3. Emploi des signes de ponctuation et desmajuscules. Les signes de ponctuation correspondantaux paragraphes et aux niveaux d'alinéa subséquentsdoivent obéir aux normes suivantes :

a. A sentence that introduces subparagraphs(including subsequent subparagraph levels)must end in a colon.

a. Toute phrase qui introduit un alinéa (ycompris les niveaux subséquents d'alinéa) doitnormalement se terminer par un deux points.

b. Subparagraphs (and all subsequentsubparagraph levels) consisting of completesentences must begin with an upper-caseletter and end in a period.

b. Les alinéas (et tous les niveaux subséquentsd'alinéa) comportant des phrases complètesdoivent commencer par une lettre majuscule etse terminer par un point.

c. Subparagraphs (and all subsequentsubparagraph levels) consisting of clausesmust begin with a lower-case letter and endin a semicolon. (If the subparagraphs consistof steps in a procedure, or explanationsof items identified by run-in headings thesubparagraphs may be punctuated as anormal paragraph, i.e. beginning with anupper-case letter and ending with a period.)

c. Les alinéas (et tous les niveaux subséquentsd'alinéa) comportant plusieurs propositionsdoivent commencer par une lettre minuscule etse terminer par un point-virgule. (Si les alinéasse présentent sous la forme d'une marcheà suivre ou d'une explication de différentspoints identifiés par un en-tête continu, cesalinéas peuvent être ponctués comme desparagraphes normaux, c.-à-d. commencer parune lettre majuscule et se terminer par unpoint.)

d. When a subparagraph (or subsequentsubparagraph levels) is dependent on theintroductory sentence and consists of anumber of sentences, those sentences mustbe punctuated in the normal manner, exceptthat the first word of the subparagraph mustbegin with a lower-case letter and the lastsentence of the subparagraph must end with asemicolon.

d. Lorsqu'un alinéa (et les niveaux subséquentsd'alinéa) dépend de la phrase d'introductionet comprend un certain nombre de phrases,ces phrases doivent être ponctuées de façonnormale, sauf que le premier mot de cet alinéadoit commencer par une lettre minuscule etque la dernière phrase de l'alinéa doit seterminer par un point-virgule.

Page 33: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

4-3/4-4

e. If subparagraphs (or subsequentsubparagraph levels) consist of phrases orlists, and if the text of no subparagraph atone level requires further punctuation, thesubparagraphs at that level may begin withlower-case letters and be followed by commas.

e. Si les alinéas (ou les niveaux subséquentsd'alinéa) se présentent sous la formed'expressions ou de listes, et si le texted'aucun autre alinéa n'a besoin d'être ponctué,il est possible à ce niveau de commencerl'alinéa par une minuscule et de le terminer pardes virgules.

f. If a subparagraph does not end in a period,then the second to last subparagraph must endwith the appropriate punctuation - and or or.

f. Si l'alinéa ne se termine pas par un point,son avant-dernier alinéa doit se terminer par laponctuation appropriée suivi de la conjonctionsoit « et » soit « ou » à la fin de l'avant-dernièresubdivision.

g. The last subparagraph must end either in aperiod or the punctuation mark of the nexthigher level of subparagraph.

g. À tous les niveaux, le dernier alinéa doit seterminer par un point ou par le signe deponctuation du niveau d'alinéa immédiatementsupérieur.

4. If text is added to explain a clause in asubparagraph, the text must be inserted in parenthesesand placed immediately before the semicolon orcomma that would normally apply to the subparagraph.Normal rules of punctuation must apply to the textwithin the parentheses.

4. Si une explication à l'intérieur d'un alinéa estajoutée, le texte doit être placé entre parenthèsesimmédiatement avant le point-virgule ou la virgules'appliquant normalement à l'alinéa en question. Lesrègles courantes de ponctuation s'appliquent au texteentre parenthèses.

Page 34: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION
Page 35: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

5-1

PART 5

PUNCTUATION MARKS

PARTIE 5

SIGNES DE PONCTUATION

Apostrophe Apostrophe

1. The apostrophe (') is used to indicate: 1. L'apostrophe (') se place en haut et à droited'une consonne pour :

a. the omission of letters; a. marquer l'élision devant les voyelles « a »,« e », « i »;

b. the possessive of nouns; and b. sans objet; et

c. the plural of letters, numbers and symbols. c. sans objet.

- EXAMPLES - - EXEMPLES -

1. req'd for required, 1. sans objet,

2. the mechanic's tools, and 2. sans objet, et

3. three t's. 3. sans objet.

Brackets Crochets

2. Brackets ([ ]) are used within parentheses to: 2. Les crochets ([ ]) s'utilisent généralement de lamême façon que les parenthèses pour :

a. indicate changes or additions to quotedpassages; and

a. encadrer certains mots ou signes deponctuation insérés par l'auteur dans certainspassages cités;

b. mark off words only indirectly related to theparenthetical material.

b. intercaler un élément à l'intérieur deparenthèses.

- EXAMPLE -

(Contractors must submit a detailed planto the Publications Specialist [PS] beforecommencing such a publication.)

- EXEMPLE -

(Les entrepreneurs doivent remettre un plandétaillé à un spécialiste des publications [SP]avant de commencer une telle publication.)

Colon Deux points

3. The colon (:) is used to: 3. Les deux points (:) s'emploient :

a. indicate a pause or degree of separation thatis less than a period and greater than asemicolon;

a. pour détacher un élément de la phrase pourmieux le mettre en valeur;

b. introduce a formal statement or one thatexplains, proves or amplifies a precedingformal statement (in this case, substituting forsuch words or phrases as for, viz, namely,that is to say);

b. avant une explication, un exemple, unepreuve, une cause, une conséquence; lorsquele membre de phrase qui suit est d'une certainelongueur, les deux points qui remplacent lesmots « à savoir, comme suit, suivant, parexemple » s'emploient même quand ces motssont exprimés;

c. introduce a formal quotation; c. avant une citation ou un dialogue;

d. introduce a list; d. avant une énumération;

Page 36: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

5-2

e. introduce a final clause that summarizespreceding text; and

e. avant un membre de phrase ou uneproposition qui résume les idées quiprécèdent;

f. among elements of a proportion. f. pour séparer les éléments d'une proportion.

- EXAMPLES - - EXEMPLES -

1. Double colons are used as in a 5:2:1mixture.

1. Le double deux points est utilisé pourindiquer un mélange 5:2:1.

2. Single colons are to show ratios (2:1). 2. Le simple deux points est utilisé pourindique un rapport (2:1).

Comma Virgule

4. The comma (,) is used to: 4. La virgule (,) sert à :

a. indicate a slight pause in the text; a. indiquer une légère pause dans le texte;

b. set off an introductory adverbial clause, e.g.Owing to a loss of voltage, …;

b. séparer les mots mis en apostrophe ouen apposition, le sujet ou le complémentredoublés par pléonasme, les incises, p. ex.L'équipement isotope, NEMO 24, est…;

c. set off participle phrases, e.g. Shrouding thephoto cell, rotate the dial clockwise …;

c. séparer un adverbe qui établit un lien avec cequi précède;

d. set off or enclose a non-restrictive clause(refer to Part 1), e.g. The experimental sealantproved worthless, which was expected, since…;

d. séparer les propositions relatives qui ont unevaleur purement explicative (se référer à lapartie 1), p. ex. Les ouvriers, qui étaientfatigués, demandèrent à s'arrêter;

e. set off subordinate clauses that are joined byconjunctions, e.g. When replacing the valvestem, ensure there are no leaks;

e. séparer des propositions coordonnées pard'autres conjonctions que «et », «ou », ainsique les éléments coordonnés d'une certainelongueur;

f. set off independent clauses that are joinedby the following co-ordinating conjunctionsand, but, for, nor, and so as shownwithin the phrase "…slight warming of thesurface is acceptable, but temperatures above104 degrees may damage the …";

f. séparer, dans les énumérations, les élémentsde même fonction et de même naturegrammaticale, mots ou groupes de mots, sesuivant sans conjonction de coordination;

g. separate words or phrases in a series,especially when they have parallelconstruction, e.g. red, orange, and yellow;

g. séparer deux propositions qui n'ont pas lemême sujet ou qui s'opposent l'une à l'autre,p. ex. Elle travaille, et tu ne fais rien;

h. separate two words or phrases that mightotherwise be misunderstood, e.g. … place thewrench in the rack, above the screwdriver and…;

h. séparer les propositions juxtaposées d'unemême phrase, p. ex. Les portes s'ouvrirent, lafoule se précipita;

i. set off nouns in apposition, e.g. The isotopeequipment, NEMO 24, is …;

i. lorsqu'il y a ellipse (omission d'un ou deplusieurs mots qui ne sont pas indispensablesà la compréhension de la phrase). P. ex.Les ouvriers commencèrent à travailler, lesmachines, à tourner;

Page 37: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

5-3

j. replace a word(s) that is common to twoparts of a sentence, e.g. The Aurora has fourengines and the Sea King, two …;

j. lorsqu'il y a inversion (toute construction oùl'on donne aux mots un autre ordre que l'ordreconsidéré normal). P. ex. craintif, le cheval fitun écart;

k. set off parenthetic words or phrases from otherparts of a sentence where parentheses ordashes are not used. Parenthetic expressionssuch as also, of course, in fact, perhaps,indeed, therefore, at least, likewise, andnevertheless do not need to be marked offby commas unless emphasis on the precedingword is desired;

k. emploi de la virgule avec les conjonctions« et », « ou », « ni » servant de lien entre lesmots, lorsqu'il y a au moins trois éléments, p.ex. Elle avait envoyé et la lettre, et le rapport,et le dossier;

l. with the conjunction and to achieve clarity oremphasis; and

l. sans objet; et

m. in a number of four or more digits, e.g.3,000 (except in model numbers, NATOstock numbers, postal codes, and telephonenumbers).

m. sans objet.

NOTE

The rule in Part 2 paragraph 9., takesprecedence for numbers within the metricsystem.

NOTA

La règle énoncée dans le paragraphe 9. de laPartie 2 l'emporte pour les chiffres du systèmemétrique.

Dash Tiret

5. The dash (—) is used to set off asides andinformal speech.

5. Le tiret (—) s'emploie au même titre que desvirgules ou des parenthèses au milieu d'une phrase;notamment pour faire ressortir un élément de celle-ciet pour éviter une suite de parenthèses.

Ellipsis Points de suspension

6. An ellipsis (…) is used to: 6. Les points de suspension (…) servent à :

a. indicate that words needed to complete theconstruction or sense of a sentence areomitted, e.g. … as a result of the accident …;and

a. indiquer l'omission de mots nécessaires pourterminer la construction ou le sens de laphrase, p. ex. Je croyais… On m'avait dit…; et

b. indicate that words, sentences or paragraphs,though appropriate in their original context,have been omitted from a quotation becausethey are inappropriate or superfluous for thepurpose of the quotation, e.g. The first attempt… was a failure.

b. indiquer que des mots, des phrases ou desparagraphes, même s'ils sont exacts dansle contexte original, ont été omis, parcequ'ils étaient superflus aux fins de la citation.Les points de suspension doivent alors êtreentourés de crochets, p. ex. Nos universitésjouent un rôle unique. […] Elles marquentl'opinion publique de demain.

7. An ellipsis is followed by an appropriatepunctuation mark; e.g. an ellipsis at the end of asentence is followed by a period.

7. Les points de suspension (…) sont suivis dusigne de ponctuation approprié excepté à la fin d'unephrase où, en français, on n'ajoute pas de point aprèsles points de suspension.

Page 38: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

5-4

Exclamation Mark Point d'exclamation

8. The exclamation mark (!) is used aftersentences or expressions of exclamation.

8. Le point d'exclamation (!) se met après uneexclamation, qui peut être une simple interjection, unelocution interjective ou une proposition.

Hyphen Trait d'union

9. The hyphen (-) is used to: 9. Le trait d'union (-) sert à :

a. combine words, or words and letters toproduce a more precise term;

a. relier plusieurs mots : les mots composés,les verbes et les pronoms personnels, le« t » consonne euphonique aux verbes etpronoms personnels, les nombres composésinférieurs à cent sauf s'ils sont joints par« et », les adverbes « ci » et « là » etle mot qui les précède, et un pronom suivide « même ». Par exemple, arc-en-ciel,dis-je, répliqua-t-il, quatre-vingt-dix-huit, celui-ci, celui-là, assurance-chômage, assurance-hospitalisation, elle-même;

b. combine words that are used as modifyingadjectives when they precede nouns, e.g. unit-to-unit register;

b. relier les éléments d'un mot composécomprenant un préfixe ou une particule deliaison;

c. eliminate awkward phrasing and clarifymeaning, e.g. lock-nut versus lock nut;

c. Autres préfixes. L'usage varie en ce quiconcerne les préfixes suivants : auto, contre,entre, ex, extra, néo, pseudo, ultra, photo, post(se référer au dictionnaire);

(1) not applicable, and (1) les noms et les adjectifs formés avecles préfixes suivants prennent un traitd'union : après, arrière, avant, demi, àdemi, hors, mi, nu, outre, sans, semi,sous, vice, et

(2) not applicable; (2) les mots formés avec les préfixes suivantsne prennent pas de trait d'union : bi, bio,co, hyper, hypo, inter, mono, penta, pré,rétro, sub, supra, télé, téta, tri, trans;

d. join a single letter to a noun or participle, e.g.,X-axis;

d. sans objet;

e. link whole numbers to fractions, e.g., 3-5/8; e. sans objet;

f. indicate word divisions; f. diviser les mots en fin de ligne;

g. between elements of technical compoundunits of measure; and

g. entre les éléments des unités de mesurescomposés à des fins techniques; et

- EXAMPLES - - EXEMPLES -

1. person-year. 1. année-personne.

2. light-year. 2. année-lumière.

Page 39: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

5-5

h. between elements of compound numbers fromtwenty-one to ninety-nine and in adjectivecompounds with a numerical element first.

h. entre les éléments de nombres composésinférieurs à cent qui ne contiennent pas laconjonction « et ».

- EXAMPLES - - EXEMPLES -

1. twenty-one. 1. vingt et un.

2. twenty-first. 2. cent vingt-six.

3. 1-metre ruler. 3. quatre-vingt-dix-neuf.

4. 8-hour day. 4. dix-sept.

Oblique Barre oblique

10. The oblique or slash (/) is used to: 10. La barre oblique (/) sert à :

a. indicate a division, as in a fraction; a. indiquer la division, comme dans une fraction,p. ex. 3/4;

b. indicate ratio, as a substitute for per, usuallywhen used with abbreviations and symbols forexample m/s (metres per second);

b. indiquer le rapport, comme substitut de« par » généralement dans des abréviationset symboles, par exemple, m/s, (mètre parseconde);

c. show English and French equivalents inglossaries and bilingual text in Figures;

c. indiquer l'équivalent anglais d'un mot françaisdans les glossaires et le texte bilingue dans lesfigures;

- EXAMPLE -

square/carré

- EXEMPLE -

carré/square

d. indicate an either-or relationship betweenwords or phrases it joins, e.g. and/or (Theoblique may be used in this way only to avoidcumbersome phrasing or extensive repetition,or to make the best use of space in Figures.);and

d. séparer deux mots ou deux membres dephrase afin d'indiquer qu'on a le choix de seservir de l'un ou de l'autre des deux mots oumembres de phrase pour compléter le sens dutexte; et

NOTE

The "and/or" is usually interpreted as "or" e.g."…fastened with washer and/or wire…" resultsin a washer or a wire and not both a washer anda wire.

NOTA

Le « et/ou » est souvent interprété comme lemot « ou » par exemple la phrase '… attachéavec rondelle et/ou fil-frein…' aura commerésultat soit une rondelle soit un fil- frein et nonune rondelle et un fil-frein.

Within SOWs and associated technicaldocuments, this use of the forward slash allowsthe contractor to choose whether the sentenceought to read "and" or to read "or". Becauseof the confusion that may result from the useof this phrase, avoid using it in SOWs andassociated technical documents.

Dans les énoncés de travail et les documentstechniques connexes, l'utilisation de la barreoblique permet au fournisseur de choisir si laphrase devrait se lire « et » ou « ou ». En raisonde la confusion qui pourrait en résulter, il fautéviter de l'utiliser dans les énoncés de travail etles documents techniques connexes.

Page 40: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

5-6

e. indicate successive divisions of anorganization.

e. séparer les divisions d'une organisation.

- EXAMPLE -

DGMSSC/DMPP.

- EXEMPLE -

DGSMCA/DPPM.

Parentheses Parenthèses

11. Parentheses (), are used to: 11. Les parenthèses () s'emploient pour :

a. set off words of explanation or comment; a. intercaler dans la phrase quelqueindication, quelque élément d'information nonindispensable au sens (tel que date, renvoi,pourcentage), et dont on ne juge pas opportunde faire une phrase distincte;

b. indicate that the material they enclose is ofminor importance, or indirectly related to themeaning of the sentence;

b. isoler un appel de note (astérisque, chiffre oulettre) au milieu d'une phrase;

c. enclose acronyms immediately after theirrespective terms where the terms are used forthe first time; and

c. isoler, immédiatement après l'appellationofficielle en toutes lettres, l'acronyme ou lesigle entre parenthèses lors de la premièremention; et

d. a cross-reference instruction. d. Pour indiquer un renvoi.

Period Point

12. The period (.) is used: 12. Le point (.) se place :

a. at the end of a declarative sentence (i.e.the sentence is neither an exclamation nor aquestion);

a. àla fin d'une phrase (celle-ci étant ni uneexclamation ni une question);

b. after abbreviations when the abbreviation isalso a word, e.g. No.;

b. après certaines abréviations;

c. after a run-in heading to separate it from thetext that follows; and

c. à la fin d'un en-tête continu pour le séparer dutexte qui suit; et

d. inside quotation marks. d. à l'intérieur d'une citation entre guillemets.

Question Mark Point d'interrogation

13. The question mark (?) is used at the end of asentence that is a direct question.

13. Le point d'interrogation (?) est utilisé à la find'une phrase qui constitue une question directe.

Page 41: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

5-7

Quotation Marks Guillemets

14. Double quotation marks ("") are used to: 14. Les guillemets ouvrants et les guillemetsfermants (« ») s'emploient :

a. enclose quotations that are shorter than fivetyped lines;

a. au commencement et à la fin d'une citation etd'un discours direct;

NOTES NOTA

1. Quoted material longer than five lines isindented, and quotation marks are notused.

1. Sans objet.

2. Single quotation marks (' ') are used toenclose a quotation within a quotation.

2. Sans objet.

b. enclose words that, because of context orspecial meaning, must be set off from the restof the text, such as words that follow entitledand marked;

b. pour encadrer une citation, même si elle n'estpas précédée des deux points;

- EXAMPLE -

Place parcels marked "THIS SIDE UP" with thelabel facing upward.

- EXEMPLE -

Sans objet.

c. not applicable; c. pour faire ressortir certains mots d'un texte :néologismes, termes familiers, impropres,exagérés ou étrangers, traductions;

d. not applicable; and d. au début de chaque alinéa d'une citation;fermer après le dernier des alinéas seulement;et

e. not applicable. e. au début du chaque ligne d'une citation inclusedans une autre citation (les guillemets de la finservent pour la double citation).

NOTE

Not applicable.

NOTA

Lorsqu'une incise assez longue coupeune citation, répéter les guillemets,mais pas s'il s'agit seulement des

expressions « dit-il », « répondit-il ».

Semicolon Point-virgule

15. The semicolon (;) is used to: 15. Le point-virgule (;) sert à :

a. mark a longer pause, a more definite break ina sentence than a comma;

a. indiquer une pause de durée moyenne, pluslongue que la pause d'une virgule;

b. join statements that are too closely related inmeaning to be written as separate sentences,e.g. On start-up, open all vents; on shut-down,reclose vents and …;

b. relier deux propositions ou plus de mêmenature et offrant entre elles des rapportsd'opposition ou de cause à effet, p. ex. Lors dudémarrage, ouvrir toutes les prises d'air; lorsde l'arrêt, refermer tous les prises d'air et…;

Page 42: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

5-8

c. join clauses of a sentence when theconnecting conjunction is omitted, e.g. Tocomplete disassembly, remove both pins;place pins in storage slots before raising …;

c. pour séparer une proposition ou une suite depropositions expliquant une proposition plusgénérale;

d. form a link between the clauses of a compoundsentence in which there is a contrast ofideas, e.g. The winners will progress to furthercompletion; the losers will return to standardactivities; and

d. à la fin de chaque alinéa dans uneénumération et pour séparer les termes ou lesalinéas dans une énumération; et

e. not applicable. e. pour séparer des membres de phrasescomprenant déjà une ou plusieurs virgules,notamment lorsqu'il y a ellipse du verbe dansla deuxième proposition.

Spacing Punctuation Marks Espacement des signes de ponctuation

16. Standard spacing for punctuation marks mustbe:

16. L'espacement courant des signes deponctuation est le suivant :

NOTE

The spacing after punctuation marks differsbetween English and French.

NOTA

L'espacement des signes de ponctuation dufrançais diffère de celui de l'anglais.

a. two spaces after all marks at the end of asentence,

a. point, point d'interrogation et pointd'exclamation (et toute ponctuation signalantla fin d'une phrase) : pas d'espace avant, deuxespaces après,

b. two spaces after a colon, b. deux points : un espace avant, un espaceaprès,

c. one space after a comma or a semicolon, c. virgule et point-virgule : pas d'espace avant, unespace après,

d. no spaces on either side of a hyphen, and d. trait d'union : sans espace ni avant ni après, et

e. one space on each side of a dash. e. tiret : un espace avant, un espace après, sauflorsqu'on le combine avec le point.

Page 43: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

6-1

PART 6

METHODS OF REFERENCING

PARTIE 6

MÉTHODES DE RÉFÉRENCE

Quotations Citations

1. Refer to Part 5 for information about the styleand indention of quotations. All changes or additionsto a quotation must be indicated by brackets (refer toPart 5). All omissions of text must be indicated by anellipsis (refer to Part 5).

1. Se référer à la partie 5 pour plus derenseignements sur le style et le retrait des citations.On doit employer l'italique pour distinguer toutemodification ou ajout à une citation. On doit employerles points de suspension, entourés de crochets, pourindiquer la troncation du texte (se référer à la partie 5).

References to Other Publications Renvois à d'autres publications

2. References call attention to other publicationscontaining material that will aid in the understanding ofthe subject matter being discussed. References mustbe identified as follows:

2. Les références servent à attirer l'attentionsur d'autres publications qui contiennent desrenseignements pouvant aider à la compréhensiondu texte. Les documents de référence doivent êtreidentifiés de la manière suivante :

a. First reference to DND publications must beby National Defence Index of Documentation(NDID) number, followed by the generic title,volume number, and specific title (if all areapplicable).

a. Le premier renvoi aux publications duMDN doit préciser le numéro d'Index dedocumentation de la Défense nationale(IDDN), suivi du titre générique, du numérode volume et du titre spécifique (selon leurapplication).

- EXAMPLES - - EXEMPLES -

1. C-01-100-100/AG-006, Writing, Format,and Production of Technical Publications.Subsequent references to the same DNDpublication must be by NDID number only.

1. C-01-100-100/AG-006, Rédaction, miseen page et production de publicationstechniques. Les renvois ultérieurs à cettemême publication doivent mentionnerseulement le numéro d'IDDN.

2. When referring to a publication subdividedinto Books, the Book number (e.g. Book 2of 2) is to be presented as the last elementof the reference.

2. Dans le renvoi à une publication divisée enlivres, le numéro du livre (p. ex. Livre 2 de2) doit être placé à la fin de la référence.

b. Reference to other publications must be byappropriate identifying number and title. Ifthere is no appropriate identifying number,reference must be by the name of the author,the title of the publication and the name of thepublisher.

b. Le renvoi à d'autres publications doit préciserle numéro et le titre appropriés. Lorsqu'il n'ya pas de numéro approprié, le renvoi doitpréciser le nom de l'auteur, le titre de lapublication et le nom de l'éditeur.

- EXAMPLE -

BR 67 Admiralty Manual of Seamanship.

- EXEMPLE -

BR 67 Admiralty Manual of Seamanship.

Page 44: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

6-2

c. Reference may be made to other publicationsonly if they are available from eitherGovernment or commercial sources, and thematerial referenced in them makes them worthobtaining (refer to paragraph 5.). If neither ofthese conditions is met, the material must beincorporated into the publication being written.

c. Le renvoi à d'autres publications peut sefaire seulement de sources commercialesou gouvernementales et lorsque lesrenseignements visés dans le renvoien justifient l'acquisition (se référer auparagraphe 5.). Lorsque l'une ou l'autre deces conditions fait défaut, incorporer plutôtles renseignements nécessaires dans lapublication en cours de rédaction.

NOTE

List of References. When a publicationcontains 10 or more references to otherpublications, a "List of References" may beadded as an Annex to the publication, or to thelast Book in a series of Books.

NOTA

Liste de références. Lorsqu'une publicationpossède 10 renvois ou plus à d'autrespublications, il est possible de rajouter une listede référence comme annexe à la publication,ou au dernier livre dans le cas d'une série delivres.

Cross-referencing Procédés de renvoi

3. Cross-references call attention to other areaswithin that same publication that will aid in theunderstanding of the subject matter being discussed.Care must be taken only to be as detailed asnecessary in cross-referencing. Cross-references mustbe identified as follows:

3. Les procédés de renvoi portent à l'attentiondu lecteur des portions de texte dans la mêmepublication qui aident à la compréhension de la matièreà l'étude. On doit prendre soin en rédigeant le renvoide n'indiquer que l'essentiel. Les renvois doivent seformuler de la manière suivante :

NOTE

If there is repeated cross-references to materialfalling outside the Part or section, considerationmust be given to re-organizing the publicationto bring that material (textual or illustrative)within the Part or section.

NOTA

S'il y a une répétition de renvois portant surde la matière non incluse dans la partie ou lasection, on doit alors prendre en considérationla réorganisation de la publication pour joindrela matière (textes ou illustrations) à la partie ouà la section.

a. Book 2 (when referring to a Book division in thesame publication, i.e. under the same NDIDnumber).

a. Livre 2 (renvoi à un livre faisant partie dela même publication, c.-à-d. portant le mêmenuméro d'IDDN).

b. Part 1, Section 1 (when referring to a Sectionwithin another Part).

b. Partie 1, section 1 (renvoi à une section àl'intérieur d'un autre chapitre).

c. Section 1 (when referring to a Section withinthe same Part).

c. Section 1 (renvoi à une section à l'intérieurd'une même partie).

d. Annex A (when referring to an Annex of apublication as a whole).

d. Annexe A (renvoi à une annexe correspondantà l'ensemble de la publication).

e. Part 6, Annex B (when referring to an Annexof a Part).

e. Partie 6, annexe B (renvoi à une annexecorrespondant à une partie quelconque).

f. Part 1, Annex A, Appendix 2 (when referring toan Appendix).

f. Partie 1, annexe A, appendice 2 (renvoi à unappendice).

Page 45: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

6-3

g. Paragraph 1, (when referring to anotherparagraph) or paragraph 1.a.(2) (whenreferring to a paragraph's subsequentsubparagraphs) within the same Section, orwithin a Part that is not subdivided by Sections,or within an Annex that is not subdivided byAppendices.

g. Paragraphe 1 (renvoi à un autre paragraphe)ou paragraphe 1.a.(2) (renvoi aux alinéassubséquents d'un paragraphe) à l'intérieur dela même section ou de la même partie, nonsubdivisé en sections ou à l'intérieur d'uneannexe non subdivisée en appendices.

h. Figure 1-1 (i.e. Figure 1 in Part 1). h. Figure 1-1 (c.-à-d. la figure 1 de la partie 1).

i. Figure 4A-3 (i.e. Figure 3 in Annex A of Part 4). i. Figure 4A-3 (c.-à-d. la figure 3 de l'annexe Aà la partie 4).

j. Figure A-10 (i.e. Figure 10 in Annex A of theentire publication).

j. Figure A-10 (c.-à-d. la figure 10 de l'annexe Acorrespondant à l'ensemble de la publication).

4. References to forms must be identified asfollows:

4. Les renvois aux formulaires doivent êtreidentifiés de la façon suivante :

a. First Reference. On first reference, the formnumber and title must be listed in a publication.

a. Premier renvoi. Lors du premier renvoi dansune publication, on doit préciser le numéro duformulaire et son titre.

- EXAMPLE -

Form DND 2055, Publication DiscrepancyReport.

- EXEMPLE -

Formulaire DND 2055, Rapport d'écart auxpublications.

b. Subsequent References. On subsequentreference, only the form number must belisted.

b. Renvois ultérieurs. Lors des renvoisultérieurs, on ne doit mentionner que lenuméro du formulaire.

- EXAMPLE -

DND 2055.

- EXEMPLE -

DND 2055.

Footnotes Notes en bas de page

5. Text. When specific information or ideas aretaken from other sources, proper credit must begiven through the use of footnotes. Footnotes arenumbered sequentially throughout a document, withsuperscript Arabic numbers immediately following thenoted text. Footnotes must appear at the bottomof the page and begin at the left margin with thecorresponding superscript Arabic numeral. Footnotesmust be separated from each other by a double space.

5. Texte. Lorsque des renseignements précisou des idées ont été tirés d'autres sources, on doitreconnaître la source en la soulignant dans les notesen bas de page. Les notes en bas de page sontnumérotées séquentiellement dans un document, aumoyen de chiffres arabes, en position supérieure,placés immédiatement en fin de texte. La note doitêtre placée au bas de la page et commencer àla marge gauche et est introduite par le chiffrearabe correspondant en position supérieure. Les notesdoivent être séparées entre elles par un interlignedouble.

- EXAMPLE -

1 Maxine Ruvinsky, Practical Grammar: ACanadian Writer's Resource, 1st ed. (OxfordUniversity Press, 2006), p. 248.

- EXEMPLE -

1 Guilloton, Noëlle. Le français au bureau,5e éd., Québec, Office de la langue française,2000, p. 503.

Page 46: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

6-4

6. Consecutive references to the same work willappear as in the following example:

6. Les références consécutives provenant de lamême publication prendront la forme indiquée, enitalique, dans l'exemple suivant :

- EXAMPLE -

2 Ibid., p. 119.

- EXEMPLE -

2 ibidem, p. 391.

7. Further references to the same source may beabbreviated by showing only the last name of the authorand the page number(s):

7. Les références ultérieures provenant de lamême source peuvent être abrégées en n'indiquantque le dernier nom de l'auteur et le(s) numéro(s) depage.

- EXAMPLE -

4 Ruvinsky, p. 56.

- EXEMPLE -

4 Guilloton, p. 27.

8. Figures. Where required, footnotes must beplaced at the bottom of a Figure, within its frame. Wherethe use of numerals will lead to ambiguity, superscriptletters, asterisks, daggers or other symbols may beused. In Figures of more than one page, footnotes mustbe placed on the page to which they apply and not atthe end of the final page of the Figure.

8. Figures. Si nécessaire, des notes doivent êtreplacées en bas des figures, à l'intérieur du cadre. Siles chiffres prêtent à confusion, d'autres symboles telsque lettrines, astérisques ou croix peuvent être utilisés.Si les figures couvrent plus d'une page, les notesdoivent être placées en bas de la page à laquelle elless'appliquent et non à la fin de la dernière page.

Page 47: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-1

PART 7

WRITING FOR CLEAR COMMUNICATION

PARTIE 7

BIEN RÉDIGER POUR UNECOMMUNICATION EFFICACE

1. Short, concise and well-constructed sentencescontribute to clear communication and ease translation.To reduce ambiguities and to ensure that the intentionof the statement is clear, employ the use of articles,prepositions, punctuation marks and modifiers.

1. Des phrases courtes, concises et bienorganisées contribuent à la communication efficacedu message et en facilitent la traduction. Un moyend'éliminer toute ambiguïté consiste à employer desarticles, des prépositions, des signes de ponctuationet des qualificatifs de façon à bien clarifier l'objectif del'énoncé.

2. The following are some sample problems andsuggested solutions:

2. À cette fin, voici quelques problèmes types etdes solutions possibles :

Statement: Oil tank shut-off valve.

Does this mean to oil the valve or does it refer toa particular valve? The statement may be a nounphrase or an imperative. The word must be added toeliminate the ambiguity.

Solution: The oil tank shut-off valve or Oil the tankshut-off valve.

Énoncé de départ : Oil tank shut-off valve.

S'agit-il d'huiler le robinet d'arrêt ou de nommerun robinet particulier? Cet énoncé peut être conçucomme une locution nominale ou une locutionverbale impérative. En anglais, on doit ajouter l'article« the » pour éliminer cette ambiguïté et en faciliter lacompréhension pour la traduction.

Solution : Le robinet d'arrêt du réservoir d'huile ouHuiler le robinet d'arrêt du réservoir.

Statement: The brake pedal and accelerator.

The second article is necessary to indicate that thebrake modifies only the pedal.

Solution: The brake pedal and the accelerator.

Énoncé de départ : The brake pedal and accelerator.

Un deuxième article est nécessaire pour préciserque l'adjectif « brake » modifie seulement le nom« pedal ».

Solution : La pédale de freinage et l'accélérateur.

Statement: While adjusting belts test tension.

The use of the comma and the articles will eliminatethe possibility that belts could be taken as the subjectof the test.

Solution: While adjusting the belts, test the tension.

Énoncé de départ : While adjusting belts testtension.

L'utilisation d'une virgule et des articles élimine lapossibilité que les courroies deviennent le sujet duverbe « test ».

Solution : Au moment de régler les courroies, envérifier la tension.

Statement: Remove the bolts holding the assemblywith the left hand.

The comma separates the sentence into components.Also note the use of the relative clause replacing thepresent participle.

Solution: Holding the assembly with your left hand,remove the bolts.

Énoncé de départ : Déposer les boulons tenantl'ensemble avec la main gauche.

Une virgule peut séparer les éléments de la phrase.Noter également que l'antécédent du participeprésent est mal identifié : « boulons » ou « main ».L'ordre chronologique des événements doitégalement être rectifié.

Solution : En tenant l'ensemble avec la main gauche,déposer les boulons.

Page 48: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-2

Statement: Check the figures, verify the test results.

For clarity, either the main clauses must be separatedby a semicolon or the wordand will be inserted andpreceded by a comma.

Solution: Check the figures; verify the test results orCheck the figures, and verify the test results.

Énoncé de départ : Vérifier les chiffres, vérifier lesrésultats des essais.

Aux fins de clarté, ces propositions principalesdoivent être séparées par un point-virgule, ou alors laconjonction « et » doit être insérée.

Solution : Vérifier les chiffres; vérifier les résultatsdes essais ou Vérifier les chiffres et les résultats desessais.

Statement: …min of three min.

In both cases, does min mean minimum or minute?

Solution: A minimum of three minutes.

Énoncé de départ : …min de trois min.

Quelle est la signification de chaque « min » :minimum ou minute?

Solution : Un minimum de trois minutes.

Statement: Manufacture, packaging, and retailing.

All items in a list should be the same part of speech.

Solution: Manufacturing, packaging, and retailing.

Énoncé de départ : Fabriquer, emballage et vente dudétail.

Tous les éléments d'une énumération doiventappartenir à la même fonction grammaticale.

Solution : Fabrication, emballage et vente au détail.

Statement: Install converter disconnecting dischargelamp.

The present participles may be interpreted asadjectives. There will be no ambiguity if the presentparticiple is replaced.

Solution: To disconnect the discharge lamp, installthe converter or Install converter after disconnectingthe discharge lamp.

Énoncé de départ : Install converter disconnectingdischarge lamp.

Le participe présent peut être interprété comme unadjectif. On élimine l'ambiguïté en remplaçant leparticipe présent.

Solution : Pour débrancher la lampe à décharge,poser le convertisseur ou Poser le convertisseuraprès avoir débranché la lampe à décharge.

3. A concise style and clear visual organizationcontribute to a well-written, easily understoodpublication. In Figure 7-2, Examples 1 and 2represent the same information and requirements; theirdifferences are in organization only. Example 2 hasbeen organized so that it flows in a more logical order(take particular note of paragraphs 3., 4., and 5., inthe two examples). The examples have been formattedin a two-column style for easier comparison by theuser. Authors are encouraged to consider the needs ofpublication users and to present information in a clear,well-organized format.

3. Un style concis et une organisation visuelleclaire contribuent à créer une publication bien rédigéeet intelligible. Dans la Figure 7-2, les exemplesprésentent les mêmes renseignements et exigences;la seule différence se trouve dans leur organisation.La version améliorée est organisée de manière àprésenter les renseignements dans un ordre pluslogique (veuillez noter tout particulièrement l'ordre desparagraphes 3., 4. et 5. dans les deux exemples). Cesexemples sont présentés en format côte-à-côte pour enfaciliter la comparaison. On encourage les rédacteursà tenir compte des besoins des utilisateurs visés par lapublication et de présenter les renseignements qui s'ytrouvent dans un format intelligible et bien organisé.

Page 49: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-3

The Fog Index L'indice de compréhension

4. When selecting vocabulary, authors willconsider the reading ability of the probable user of theirpublications. The Fog Index is one of several indicesthat determine the reading level of a publication. To findthe Fog Index of a passage:

4. Les auteurs, en choisissant le vocabulaire,doivent prendre en considération la formation del'utilisateur probable de leur publication. L'indice decompréhension est l'un de plusieurs indices quidétermine le niveau rédactionnel d'une publication.Pour déterminer l'indice de compréhension d'unpassage, il faut :

a. Record the number of words in severalsuccessive sentences. Stop the sentencecount with the sentence that ends nearesta 100-word total. Divide the total numberof words in the passage by the number ofsentences to get the average sentence lengthof the passage.

a. Compter le nombre de mots dans plusieursphrases consécutives. Arrêter le compte demots avec la phrase qui s'approche le plusdu total de 100 mots. Diviser le nombre totalde mots dans le passage par le nombre dephrases pour obtenir la longueur moyenne desphrases dans le passage donné.

b. Count the number of words of three syllablesor more per 100 words. Do not count the wordsthat are proper names, that are combinationsof short, easy words (like firefighter andtypesetter) or that are verb forms madeinto three syllables by adding -d,- es or -ing(like created and opening). This gives thepercentage of hard words in the passage.

b. Compter le nombre de mots de trois syllabesou plus par groupe de 100 mots. Ne pascompter les mots propres, les mots composéssimples (comme grille-pain, garde-feu) oules verbes comptant trois syllabes et plus parsuite de leur conjugaison (ouvrir - ouvrirait,imprégner - imprégnerait). Ce calcul donne lepourcentage de mots difficiles dans le passagedonné.

c. To get the Fog Index, add the factors justcounted and multiply by 0.4.

c. Pour obtenir l'indice de compréhension,additionner les résultats calculés plus haut etmultiplier par 0.4.

Page 50: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-4

Fog IndexIndice de compréhension

Reading Level By GradeNiveau de lecture selon la scolarité

17 Graduate LevelDiplômés universitaires

16 Fourth year universityQuatrième année d'université

15 Third year universityTroisième année d'université

14 Second year universityDeuxième année d'université

13 First Year UniversityPremière année d'université

12 Grade 1212e année

11 Grade 1111e année

10 Grade 1010e année

9 Grade 99e année

8 Grade 88e année

7 Grade 77e année

6 Grade 66e année

Figure 7-1 Fog IndexFigure 7-1 Indice de compréhension

Page 51: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION
Page 52: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-5 (Blank/blanche)/7-6

EXAMPLE 1 EXAMPLE 2(Improved)

IMPELLERS IMPELLERS1. Visual Examination – General. Examineimpellers for erosion and pitting. Also examine theimpellers for cracks and wear. Replace impellers ifthey do not meet the following criteria:

1. Visual Examination – General. Examineimpellers for four faults: erosion, pits, cracks, andwear. Replace impellers if they do not meet thefollowing criteria:

a. Hold erosion paths to the following depths:(1) Erosion paths must not exceed a depth

of 0.8 mm along the rotor periphery.Measure the 2 cm of surface radiallyfrom the impeller edge toward theimpeller centre.

a. Erosion paths are acceptable if they do notexceed a depth of 0.8 mm in the last two cmsurface measured radially from the impellerperiphery toward the centre of the impelleror 2.5 mm elsewhere.

(2) Erosion paths must not exceed a depthof 2.5 mm elsewhere.

b. Erosion which breaks through at the tip ofthe impeller volute is not acceptable.

b. The impeller volute tip must be erosion free.Erosion which breaks through at the tip ofthe impeller volute is not acceptable.

c. The impeller must be 75 per cent erosionfree. This encompasses the following:(1) Pitting must not exceed erosion depths

indicated in subparagraph 1.a.

c. Allowable pitting is classified as thatwhich does not exceed the above-specifiederosion depth, but pitting must not cover anarea greater than 25 per cent of the totalarea of an individual volute.

(2) Pitting must not cover an area greaterthan 25 per cent of the volute total area.

d. The impeller must be porosity free; theimpeller must also be crack free. To ensurethis, perform the following:(1) Perform a dye penetrant test on the

suspected area.

d. Porosity and cracks are not acceptable.Perform a dye penetrant test on areassuspected of having cracks in accordancewith MIL-STD-278, Fabrication, Weldingand Inspection of Machinery, Piping andPressure Vessels of the U.S. Navy.

(2) Follow MIL-STD-278, Fabrication,Welding and Inspection of Machinery,Piping and Pressure Vessels of theU.S. Navy.

Figure 7-2 (Sheet 1 of 4) Writing for Clarity

Page 53: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-7

EXEMPLE 1 EXEMPLE 2(Version amélioré)

AUBES AUBES1. Examen visuel - Généralités. Examiner lesaubes pour des traces d’érosion et de piqûres.Examiner également les aubes pour des criqueset signes d’usure. Remplace les aubes si elles nepeuvent satisfaire aux exigences suivantes :

1. Examen visuel - Généralités. Examinerles aubes pour déceler la présence des quatredéfauts suivants : érosion, piqûres, criques et usure.Remplace les aubes si elles ne peuvent satisfaireaux exigences suivantes :

a. Mesurer les traces d’érosion selon lesprofondeurs suivantes :(1) Les traces d’érosion ne doivent pas

dépasser une profondeur de 0,8 mmle long de la périphérie du rotor.Mesurer les deux centimètres desurface radialement depuis le bord del’aube jusqu’au centre de l’aube.

a. Les traces d’érosion sont acceptables sielles ne dépassent pas une profondeur de0,8 mm dans les derniers deux centimètresde la surface mesurée radialement depuisla périphérie de l’aube jusqu’au centre del’aube ou 2,5 mm ailleurs.

(2) Ailleurs, les traces d’érosion ne doiventpas dépasser une profondeur de2,5 mm.

b. L’érosion qui traverse l’extrémité de lavolute de l’aube n’est pas acceptable.

b. L’extrémité de la volute de l’aube doitêtre libre d’érosion. L’érosion qui traversl’extrémité de la volute n’est pas admissible.

c. L’aube doit être libre d’érosion à 75 pour100. Ceci englobe les suivantes :(1) Les piqûres ne doivent pas dépasser

les profondeurs d’érosion admissiblesindiquées à l’alinéa 1.a.

c. Des piqûres admissibles sont classifiéescomme celles ne dépassant pasla profondeur d’érosion précisée plushaut,mais les piqûres ne doivent pas couvrirune surface supérieure à 25 pour cent de lasurface totale d’une seule volute.

(2) Les piqûres ne doivent pas couvrir unesurface supérieure à 25 pour 100 desurface totale de la volute.

d. L’aube doit être libre de porosité; l’aubedoit également être libre de criques. Pourvérifier la surface, effectuer les suivantes :(1) Effectuer un essai de pénétration du

colorant sur la surface soupçonnée.

d. La porosité et les criques ne sontpas acceptables. Effectuer un essaide pénétration du colorant sure lessurfaces soupçonnées d’avoir des criquesen conformité avec la publication« MIL-STD-278, Fabrication, Welding andInspection of Machinery, Piping andPressure Vessels of the U.S. Navy ».

(2) Suivre les indications de la publicationMIL-STD-278 Fabrication, Welding andInspection of Machinery, Piping andPressure Vessels of the U.S. Navy.

Figure 7-2 (feuille 1 de 4) Rédiger pour la clarté

Page 54: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-8

2. Visual Examination – Keyways. Examineimpeller keyways for deformed, cracked, or chippededges or high spots. Defects are not acceptable.Follow paragraph 5. Repair procedures.

2. Visual Examination – Keyways. Examineimpeller keyways for four unacceptable faults:deformed edges, cracked edges, chipped edges,and high spots. Follow in accordance withparagraph 4.

3. Dimensional Examination – General. Examineimpellers dimensionally in accordance with thefollowing:

3. Dimensional Examination – Keyways. Checkthe key fit in key seat sides. Check the followingclearances:

a. Examine the impellers for compliance withdimensions and surface finish as shownin Figures 4-1-1, 4-1-2, 4-1-3, and 4-1-4of Part 4 of this publication and recordreadings that meet specifications. Replaceif impeller outside diameter is less orinside diameter is more than specifieddimensions.

a. maximum clearance is 0.05 mm; and.

b. Dimensionally inspect the diameters ofrunning clearance surfaces in way ofwearing rings and interstage rings forability to meet the clearance requirementsof Figures 4-1-1, 4-1-2, 4-1-3, and 4-1-4of Part 4 of this publication and recordreadings that meet specifications. Replaceimpellers if specified clearances cannot bemaintained.

b. maximum interference is 0.008 mm.

4. Repair – Keyways. Do not repair a keywayunnecessarily. Repair as follows: Check that fitbetween key and key seat sides has a maximumclearance of 0.05 mm or maximum interference of0.008 mm.

a. High Spots. Grind off high spots inkeyways.

b. Oversize Keyway. Use a step key up to0.20 mm.

4. Dimensional Examination – Keyways.Check that fit between key and key seat sides hasa maximum clearance of 0.05 mm or maximuminterference of 0.008 mm.

c. Worn or Damaged Keyways. Remachineworn or damaged keyways to 0.60 mmoversize.

Figure 7-2 (Sheet 2 of 4) Writing for Clarity

Page 55: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-9

2. Examen visuel – Logements de clavette.Examiner les logements de clavette de l’aube pour laprésence de bords déformées, fissurés ou écalés oude piqûres saillantes dues au laminage. Les défautsne sont pas acceptables. Suivre les indications duparagraphe 5., Réparation.

2. Examen visuel – Logements de clavette.Examiner les logements de clavette de l’aubepour déceler la présence de quatre défautsinadmissibles : bords déformées, bords fissurés,bords écalés et piqûres saillantes dues au laminage.Poursuivre les réparations selon les indications duparagraphe 4.

3. Examen dimensionnel – Logements declavette. Examiner les aubes dimensionnellementconformément aux directives suivantes :

3. Examen dimensionnel – Logements declavette. Vérifier l’ajustement de la clavette dansles côtés de la rainure de clavette. Vérifier les jeuxsuivants :

a. Examiner les aubes en conformité avecles dimensions et le fini de surface tellsqu’illustrés dans les Figures 4-1-1, 4-1-2,4-1-3 et 4-1-4 de la Partie 4 de cettepublication et inscrire les résultats quisatisfont aux normes. Remplacer l’aubesi le diamètre extérieur de l’aube estinférieur aux dimensions spécifiées ou sele diamètre intérieur est supérieur auxdimensions spécifiées.

a. un jeu maximum de 0.05 mm; et

b. Examiner dimensionnellement le diamètredes surfaces de jeu tournantes sur lesanneaux d’usure et les anneaux interétagepour les capacités de satisfaire auxexigences de jeu des Figures 4-1-1, 4-1-2,4-1-3, and 4-1-4 de la Partie 4 de cettepublication et inscrire les résultats quisatisfont aux normes. Replacer les aubessi les jeux précisés ne peuvent êtreconservés.

b. une interférence maximale de 0,008 mm.

4. Réparation – Clavettes. Ne pas réparer unlogement de clavette inutilement. Effectuer lesréparations selon les indications suivantes :

a. Piqûres saillantes dues au laminage.Meuler les piqûres saillantes dues aulaminage dans les logements de clavette.

b. Logement de clavette sur dimensionné.Utiliser une clavette étagée jusqu’à0,20 mm.

4. Examen dimensionnel – Logements declavette. Vérifier que l’ajustement entre la clavetteet les côtés de la rainure de clavette possède unjeu maximum de 0,05 mm ou une interférence de0,008 mm.

c. Clavettes usées ou endommagées.Réusiner les clavettes usées auendommagées jusqu’à une sur dimensionde 0,60 mm.

Figure 7-2 (feuille 2 de 4) Rédiger pour la clarté

Page 56: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-10

5. Repair of Keyways. Examine keyways forindication of need for repair and effect repairs asneeded:

5. Dimensional Examination – General. Performthe two dimensional examinations that follow:

a. Check impellers against specifieddimensions. Check surface finish. Thereferenced figures are for information only.Perform the following:(1) Record readings that meet

specifications. See clearancerequirements in Figures 4-1- 1, 4-1-2,4-1-3, and 4-1-4.

a. Highs spots in keyways may be removed bymachining or grinding.

(2) Replace impeller if the outsidediameter is less than specifieddimensions.

b. Do not unnecessarily repair any keyway;instead, use a step key up to a maximum of0.20 mm oversize.

(3) Replace impeller if the inside diameteris more than specified dimensions.

b. Inspect the diameters of the wearing rings.Inspect the diameters of the interstagerings. See clearance requirements onreferenced figures. Perform the following:(1) Record readings that meet

specifications. See Figures 4-1-1,4-1-2, 4-1-3, and 4-1-4.

c. If key tightness cannot be corrected witha step key, remachine worn or damagedkeyways to 0.60 mm oversize.

(2) Replace impellers if specifiedclearances cannot be maintained.

6. Restoration of Critical Dimensions. Restorecritical dimensions as needed:

6. Restoration of Critical Dimensions. Restorecritical dimensions as needed:

a. Machine impeller inside and outsidediameters as necessary. Perform thefollowing:(1) Machine to specified dimensions.

a. Machine impeller inside and outsidediameters as necessary to obtaindimensions above in Figures 4-1-1, 4-1-2,4- 1-3, and 4-1-4. Record final dimensions.

(2) Record final dimensions.

Figure 7-2 (Sheet 3 of 4) Writing for Clarity

Page 57: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-11

5. Réparation des logements declavette.Examiner les logements de clavette pourdéceler des indications de défauts nécessitant desréparations et effectuer les réparations selon lesbesoins :

5. Examen dimensionnel – Généralités. Effectuerles deux examens dimensionnels qui suivent :

a. Vérifier les aubes par rapport auxdimensions spécifiées. Vérifier le fini dela surface. Les figures de référence sontincluses à titre d’information seulement.Effectuer les étapes suivantes :(1) Inscrire les résultats qui satisfont aux

normes. Voire les figures 4-1-1, 4-1-2,4-1-3 et 4-1-4 pour les exigences dejeu.

a. Les piqûres saillantes dues au laminagepeuvent être éliminées par usinage oumeulage.

(2) Replacer l’aube se le diamètreextérieur est inférieur aux dimensionsspécifiées.

b. Ne pas réparer un logement de clavetteinutilement; utiliser au lieu une clavetteétagée d’une sur dimension maximale de0,20 mm.

(3) Replacer l’aube se le diamètreintérieur est supérieur aux dimensionsspécifiées.

b. Examiner les diamètres des anneauxd’usure. Examiner les diamètres desanneaux interétage. Voire les figures deréférence pour les exigences de jeu.(1) Inscrire les résultats qui satisfont aux

normes. Voire les figures 4-1-1, 4-1-2,4-1-3 et 4-1-4.

c. Si l’ajustement serré de la clavette nepeut être rectifié avec une clavetteétagée,réusiner les clavettes usées auendommagées jusqu’à une sur dimensionde 0,60 mm.

(2) Replacer les aubes si les jeux spécifiésne peuvent être respectés.

6. Restauration de dimensions critiques.Restaurer les dimensions critiques selon lesbesoins :

6. Restauration de dimensions critiques.Restaurer les dimensions critiques selon lesbesoins. Effectuer les étapes suivantes :

a. Usiner les diamètres intérieurs et extérieursde l’aube selon les besoins. Effectuer lesétapes suivantes :(1) Usiner selon les dimensions

spécifiées.

a. Usiner les diamètres intérieurs et extérieursde l’aube selon les besoins pour obtenir lesdimensions mentionnées plus haut dans lesFigures 4-1-1, 4-1-2, 4-1-3 et 4-1-4. Inscrireles dimensions finales.

(2) Inscrire les dimensions finales.

Figure 7-2 (feuille 3 de 4) Rédiger pour la clarté

Page 58: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-12

b. Restore running clearance surfacesbetween wearing and interstage rings.Perform the following:(1) Machine to specified finish. See

Figures 4-1-1, 4-1-2, 4-1-3, and 4-1-4.(2) Machine the minimum amount of metal

required.(3) Do not exceed diameter clearances

shown in Figures 4-1-1, 4-1-2, 4-1-3,and 4-1-4.

(4) Record final dimensions.

b. Restore running clearance surfaces in wayof wearing and interstage rings to the finishshown in Figures 4-1-1, 4-1-2, 4-1-3, and4-1-4 in Part 4, Section 1 of this publication,by machining the minimum amount of metalrequired. The diametrical clearances shownin Figures 4-1-1, 4-1-2, 4-1-3, and 4-1-4 inPart 4, Section 1 must not be exceeded.Record final dimensions. Replace impellerif surfaces cannot be restored within thespecified clearances.

(5) Replace impeller if surfaces cannotbe restored within the specifiedclearances.

7. Static balance. Statically balance each impeller. 7. Static balance. Statically balance each impeller.The following are applicable:

Impeller wall thickness must not be reduced below2.8 mm.

Do not reduce impeller wall thickness below 2.8 mm.

a. Move material to affect balance by grindingin areas shown in Figure 4-1-1 of thispublication.

a. Grind areas shown in Figure 4-1-1 to affectbalance.

b. Ensure that the surfaces are smooth aftergrinding.

b. Ensure surfaces are smooth after grinding.

Figure 7-2 (Sheet 4 of 4) Writing for Clarity

Page 59: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-13

b. Restaurer les surfaces de jeu tournantesentre les anneaux d’usure et les anneauxinterétage. Effectuer les étapes suivantes :(1) Usiner jusqu’à l’obtention du fini

spécifié. Voire les figures 4-1-1, 4-1-2,4-1-3 et 4-1-4.

(2) Usiner le montant minimum de métalnécessaire.

(3) Ne pas excéder les jeux diamétrauxillustrés aux figures 4-1-1, 4-1-2, 4-1-3et 4-1-4.

(4) Inscrire les dimensions finales.

b. Restaurer les surfaces de jeu tournantespar rapport aux anneaux d’usure etaux anneaux interétage au fini illustréaux figures 4-1-1, 4-1-2, 4-1-3 et 4-1-4de la Partie 4, section 1 de cettepublication, en utilisant le montant minimumde métal nécessaire. Les jeux diamétrauxillustrés aux figures 4-1-1, 4-1-2, 4-1-3,and 4-1-4 in Partie 4, section 1 doiventêtre respectés. Record final dimensions.Inscrire les dimensions finales. Remplacerl’aube si les surfaces ne peuvent êtrerestaurées dans les jeux spécifiés.

(5) Remplacer l’aube si les surfaces nepeuvent être restaurées selon les jeuxspécifiés.

7. Équilibrage statique. Équilibrer statiquementchaque aube.

7. Équilibrage statique. Effectuer l’équilibragestatique de chaque aube. Effectuer les étapessuivantes :

La paroi de l’aube ne doit pas être usinéeà une épaisseur inférieure à 2,8 mm.

Ne pasréduire l’épaisseur de laparoi de l’aube à moins de 2,8 mm.

a. Déplacer le matériel pour accomplirl’équilibrage en meulant les zones illustréesà la Figure 4-1-1- de cette publication.

a. Meuler les zones indiquées dans lafigure 4-1-1 pour accomplir l’équilibre.

b. S’assure que les surfaces soient lissesaprès le meulage.

b. S’assurer que les surfaces soient lissesaprès le meulage.

Figure 7-2 (feuille 4 de 4) Rédiger pour la clarté

Page 60: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

7-14

Page 61: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION

C-01-100-100/AG-008

8-1/8-2

PART 8

INTELLECTUAL PROPERTY

PARTIE 8

PROPRIÉTÉ INTELLECTUELLE

Copyright Symbol Symbole du droit d'auteur

1. The © symbol may be used indicating thatthe work in question is protected by copyright. Forintellectual property owned by the Crown, the followingmarking should be used:

1. Le symbole © peut servir à indiquer quel’œuvre en question est protégée par le droit d'auteur.Dans le cas d'une propriété intellectuelle appartenantà la Couronne, utiliser l'avis suivant :

© Her Majesty the Queen in Right ofCanada as represented by the Minister ofNational Defence.

© Sa Majesté la Reine du Canada,représentée par le ministre de la Défensenationale.

Trade-mark Symbol Symbole de la marque de commerce

2. The ® symbol is used if the trademark isregistered.

2. Le symbole ® se place après le nom ou le logod'une marque de commerce officielle.

Page 62: WRITER’S GUIDE FOR TECHNICAL DOCUMENTATION