MODULE No 1.a

Titre : Quelques indications pour l’écriture des documents techniques

But : Rendre les documents techniques plus facilement lisibles et plus facilement modifiables

Antécédents : aucun

Ce module contient une liste de 17 éléments utiles pour la rédaction de vos TP. Après chaque élément un nombre entre parenthèse indique l’importance de l’élément (5 = Importance max., 1 = Importance min »)

 

Corps

  1. Écrire des phrases très courtes (3)
  2. Ne pas employer de synonymes (5).
  3. Ne pas employer des qualificatifs (surtout laudatifs ou dépréciatifs) (5).
  4. Ne pas employer de futur (3).
  5. Employer le verbe « devoir » au présent quand quelque chose doit absolument arriver et employer « devoir » au conditionnel quand quelque chose est souhaitable. (4)
  6. Insérer les tables des figures, des tableaux et l’index. (3)
  7. Pour les chapitres et les sous-chapitres qui les constituent il faut employer Titre 1, Titres 2 etc. le numéro du chapitre devrait être inséré comme un champ NumLglAuto (Menu Insertion, élément Champ). (3)

Exemple.

1. Introduction

1.1 But du document

  1. Toutes les figures et les tableaux doivent avoir une légende centrée. La légende doit être après la figure et avant les tableaux. (Menu Insertion, sous-menu Référence, élément Légende). (3)

Exemple pour une figure

 

Figure 1 : Disjoncteur

Exemple pour un tableau

Tableau 1 : Poètes

 

Nom

Profession

Naissance

Nationalité

Mort

Mallarmé Stéphane

Poète

1842

Française

1898

Joyce James

Écrivain

1882

Irlandaise

1942

  1. La première ligne d’un tableau doit être un titre (dans le menu Tableau cocher Titre) (2)
  2. Lorsque l’on traite un sujet avec au moins deux éléments au même niveau il est préférable de faire des énumérations. (3)

Exemple (mauvais)

Les utilisateurs peuvent lire les dates, saisir le nom et la nationalité…

Exemple (bon)

Les utilisateurs peuvent

  • lire les dates ;
  •  saisir :
    • le nom,
    •  la nationalité…
  1. Lorsque l’on fait référence à un élément numéroté, à une figure ou à un tableau il fait insérer un renvoi (Menu Insertion, sous-menu Référence, élément Renvoi) (4)

Exemple

La Figure 1 : Disjoncteur, présente….

  1. Il faut mettre une espace insécable avant : « : » « ; », « ? », « ! » et entre les guillemets à chevrons et le texte (« xxxx »). Note : « espace » en typographie est féminin » ! (3)
  2.  Il ne faut pas mettre deux espaces après le point (comme il faut faire quand on écrit en anglais). (2)
  3. Les mots étrangers et les noms des produits doivent être en italique. (2)
  4. Il ne faut pratiquement jamais forcer des sauts de page. Si on ne veut pas qu’un titre ou une phrase n’apparaissent pas isolés en fin de page il faut « lier les paragraphes et/ou les lignes » dans le menu Format, élément paragraphe (il faut toujours aussi forcer dans le même élément « éviter veuves et orphelins ») (2)
  5. Les chapitres, lorsque l’on veut imprimer recto verso, doivent terminer avec un saut de section et début de la nouvelle section sur page impaire. (2)
  6. Il est une bonne pratique de séparer les paragraphes avec 4..6 points (menu Format, élément paragraphe. De cette manière on ne doit pas introduire des sauts de ligne inutiles. (3)

 

Conséquent : pouvoir rédiger un document technique facilement modifiable

Note 01 : Dans une entreprise « sérieuse » il existe des modèles de documents pour chaque type de documents où, à l’aide de macros, l’on automatise certaines fonctions répétitives.