Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

INF 229 Notes de cours Rédaction technique en informatique version 5.0 octobre

INF 229 Notes de cours Rédaction technique en informatique version 5.0 octobre 2009 Sylvie Dumas et Luc Lavoie Données de publication Version Date Auteur Commentaires 5.0 2009-10 Sylvie Dumas, Luc Lavoie Cinquième édition. Table des matières conforme au contenu du cours INF229. 4.0 2009-09 Sylvie Dumas Quatrième édition. Modification de la mise en forme, ajout d’annexes. 3.3.0 2005-11-21 Luc Lavoie Rédaction du chapitre 7 3.2.2 2005-11-14 Genilog, inc. Correction de coquilles 3.2.1 2003-09-02 Genilog, inc. Corrections mineures au chapitre 4 3.2 2003-09-15 Genilog, inc. Ajouts aux chapitres 2 et 3 3.1 2003-09-08 Genilog, inc. Corrections mineures, nouvelles figures 3.0 2002-02-15 Genilog, inc. Troisième édition. 2.0 1995 LDA Divers ajouts et modification de la présentation. 1.0 1994 LDA Première version de la méthode. Remerciements Les auteurs sont grandement redevables aux nombreux formateurs et enseignants qu’ils ont croisés tout au long de leur carrière. Les influences furent multiples et croisées de telle sorte que l’origine de telle idée, de telle technique ou de tel tableau n’est plus retraçable. Il nous faut toutefois remercier plus particulièrement Julie Bonneau, Pascal Gemme, Danielle Lafontaine et Patrice Roy dont les contributions furent déterminantes. Tout commentaire ou toute demande de renseignement peut être acheminé à : Luc LAVOIE luc.lavoie@usherbrooke.ca © Les marques déposées ou non ainsi que les noms de produits enregistrés appartiennent à leurs propriétaires respectifs. INF 229 − Rédaction technique en informatique page i version 5.0 – 2009-10-07 T Ta ab bl le e d de es s m ma at ti iè èr re es s Liste des tableaux et des figures .........................................................................4 1 Introduction................................................................................................. 1 1.1 Objet et portée du recueil de notes........................................................................................................1 1.2 Contenu..................................................................................................................................................1 1.3 Mise en contexte ....................................................................................................................................2 2 Fonctions et types de documents ................................................................. 3 2.1 Principales raisons expliquant la piètre qualité des documents produits ..............................................3 2.2 Quelques concepts erronés concernant la documentation....................................................................3 2.3 Méthodes de rédaction...........................................................................................................................4 2.4 Impact du génie logiciel sur la rédaction technique ...............................................................................4 2.5 Objectifs de rédaction ............................................................................................................................5 2.6 Critères menant à un document de qualité............................................................................................6 2.7 Fonctions et types de documents ..........................................................................................................7 3 Rédaction..................................................................................................... 8 3.1 Règles générales ...................................................................................................................................8 3.2 Rappels grammaticaux ........................................................................................................................13 3.3 Outils d’aide à la rédaction...................................................................................................................13 3.4 Outils d’aide à la présentation..............................................................................................................15 3.5 Normes et standards............................................................................................................................15 4 Documents généraux..................................................................................17 4.1 Lettre et courriel ...................................................................................................................................17 4.2 Compte-rendu et procès-verbal ...........................................................................................................17 4.3 Note technique .....................................................................................................................................17 4.4 Rapport technique................................................................................................................................17 4.5 Procédure et directive ..........................................................................................................................17 5 Documents techniques ............................................................................... 18 5.1 Définition des besoins..........................................................................................................................18 5.2 Spécifications des exigences...............................................................................................................18 5.3 Spécification de conception .................................................................................................................18 5.4 Spécification des essais.......................................................................................................................18 5.5 Guide d’utilisation.................................................................................................................................18 6 Documents contractuels.............................................................................19 6.1 Appel d’offres .......................................................................................................................................19 6.2 Cahier des charges..............................................................................................................................19 6.3 Offre de service....................................................................................................................................19 6.4 Devis ....................................................................................................................................................20 7 Mesure de l’efficacité des documents.........................................................21 7.1 Types d’erreur qui affectent l’efficacité des documents.......................................................................21 7.2 Définition de l’efficacité en regard des tâches de l’utilisateur ..............................................................22 INF 229 − Rédaction technique en informatique page ii version 5.0 – 2009-10-07 7.3 Mesure de l’efficacité en regard des tâches de l’utilisateur .................................................................23 7.4 Mesure de l’efficacité en regard du coût de production .......................................................................24 7.5 Évaluation la fiabilité et la facilité de mise à jour d’un document.........................................................25 7.7 Exercice :..............................................................................................................................................26 8 Processus de développement documentaire.................................................27 8.1 Présentation du processus...................................................................................................................27 8.2 Analyse : définir les besoins.................................................................................................................32 8.3 Conception : préparer une table des matières structurée....................................................................40 8.4 Modélisation : préparer et valider les modèles ....................................................................................46 8.5 Assemblage : préparer le brouillon ......................................................................................................47 8.6 Correction : réviser et valider le brouillon.............................................................................................48 8.7 Mise en forme.......................................................................................................................................48 8.8 Revue linguistique................................................................................................................................48 Annexe A : Planifier un texte.........................................................................49 Questions à se poser avant d’écrire tout texte...............................................................................................49 Qu’est-ce qu’un plan ? (Inspiré du CCDMD)..................................................................................................49 Éléments essentiels........................................................................................................................................49 Forme d’un plan..............................................................................................................................................50 Points à vérifier une fois le plan rédigé ..........................................................................................................50 Types de plans ...............................................................................................................................................51 Trucs pour un bon plan ..................................................................................................................................51 Annexe B : Le rapport.................................................................................... 53 Types 53 Caractéristiques..............................................................................................................................................53 Importance du destinataire.............................................................................................................................53 Caractéristiques du rédacteur ........................................................................................................................54 Étapes du travail − Le rapport en dix étapes..................................................................................................54 I - PRÉPARATION............................................................................................................................................ 54 II - STRUCTURATION ...................................................................................................................................... 55 III - LA RÉDACTION ......................................................................................................................................... 56 IV - PRÉSENTATION ....................................................................................................................................... 57 Conseils pour la rédaction du rapport ............................................................................................................57 Annexe C : Tests d’utilisabilité.......................................................................60 Introduction.....................................................................................................................................................60 Qu’est-ce que les tests d’utilisabilité ? ...........................................................................................................60 Comment les mettre en œuvre ?....................................................................................................................60 Étude de cas...................................................................................................................................................61 Annexe D : Conventions de présentation et de typographie ...........................62 Introduction.....................................................................................................................................................62 La mise en page.............................................................................................................................................62 Formats de papier............................................................................................................................................. 62 Marges.............................................................................................................................................................. 62 La mise en forme de caractères.....................................................................................................................63 Emploi de l’italique............................................................................................................................................ 63 Emploi du soulignement.................................................................................................................................... 64 Emploi du gras.................................................................................................................................................. 64 Emploi des guillemets ....................................................................................................................................... 64 La mise en forme de paragraphes .................................................................................................................65 Interlignes ......................................................................................................................................................... 65 INF 229 − Rédaction technique en informatique page iii version 5.0 – 2009-10-07 Espacement de ponctuation.............................................................................................................................. 65 Énumérations.................................................................................................................................................... 66 Notes de bas de page et de fin de document.................................................................................................... 66 Citations............................................................................................................................................................ 67 Références bibliographiques............................................................................................................................. 67 Les tableaux et les figures..............................................................................................................................69 Tableaux ........................................................................................................................................................... 69 Figures.............................................................................................................................................................. 70 Autres mises en forme....................................................................................................................................70 Sigles et symboles français............................................................................................................................... 70 Caractères spéciaux ......................................................................................................................................... 70 Noms de personnes.......................................................................................................................................... 70 Noms de sociétés et d’organismes publics ou privés........................................................................................ 71 Adresses postales............................................................................................................................................. 71 Numéros de téléphone et de télécopie ............................................................................................................. 71 Nombres ........................................................................................................................................................... 72 Dates ................................................................................................................................................................ 72 Heures .............................................................................................................................................................. 72 Unités monétaires............................................................................................................................................. 73 Abréviations ...................................................................................................................................................... 73 Sigles et les acronymes .................................................................................................................................... 74 Coupures de mots en fin de ligne ..................................................................................................................... 74 La ponctuation .................................................................................................................................................. 75 Références bibliographiques ..............................................................................76 Langue générale.............................................................................................................................................76 Langue technique...........................................................................................................................................76 Langue administrative ....................................................................................................................................78 Rédaction scientifique ....................................................................................................................................78 Normes ...........................................................................................................................................................79 Le français sur le Web....................................................................................................................................79 La rédaction technique sur le Web.................................................................................................................80 INF 229 − Rédaction technique en informatique page iv version 5.0 – 2009-10-07 L Li is st te e d de es s t ta ab bl le ea au ux x e et t d de es s f fi ig gu ur re es s Tableau 1 – Méthodes de rédaction...........................................................................................................................4 Tableau 2 – Types de documents techniques............................................................................................................7 Tableau 3 – Mesure de l'efficacité des documents en regard des tâches de l’utilisateur. .......................................24 Tableau 5 – Application d'une méthode structurée à la documentation...................................................................27 Tableau 6 – Équipe de planification de la documentation........................................................................................32 Tableau 7 – Sujets classés par….............................................................................................................................34 Tableau 8 – Différences entre les esquisses classique et structurée. .....................................................................41 Tableau 9 – Emploi de l’italique................................................................................................................................63 Tableau 10 – Espacement de ponctuation...............................................................................................................65 Figure 1 – Niveau d'intervention du rédacteur dans différents types de documents. ................................................6 Figure 2 – Critères et niveaux de qualité....................................................................................................................7 Figure 3 – Schéma de la communication : Roman Jakobson (1963). .......................................................................9 Figure 4 – Niveaux de langue (origine inconnue).....................................................................................................10 Figure 5 – Les types d'erreur en documentation......................................................................................................22 Figure 6 – Exemple de tables des matières. ............................................................................................................23 Figure 7 – Diagramme de développement de la documentation..............................................................................31 Figure 8 – Structure des lectorats ............................................................................................................................35 Figure 9 – Exemple de matrice sujets/lectorats complétée......................................................................................36 Figure 10 – Compromis dans le choix des documents. ...........................................................................................37 Figure 11 – Exemples de rapport de documentation. ..............................................................................................38 Figure 12 – Défauts des tables des matières classiques.........................................................................................40 Figure 13 – Exemple de module HUGUES.................................................................................................................42 INF 229 − Rédaction technique en informatique page 1 de 81 version 5.0 – 2009-10-07 1 1 I In nt tr ro od du uc ct ti io on n 1.1 Objet et portée du recueil de notes Le présent recueil de notes est l’assemblage de divers éléments utilisés par les auteurs dans plusieurs formations et activités pédagogiques au cours des dix dernières années. Son contenu a été utilisé auprès de divers lectorats tels que : o rédacteurs techniques et responsables de la documentation appelés à rédiger et produire des documents techniques ; o chargés de projets, responsables de produits et analystes de processus appelés à superviser ou à gérer une production documentaire ; o analystes informatiques et informaticiens impliqués dans le processus de documentation ; o responsables de l’assurance de la qualité appelés à valider des processus documentaires. Nous avons donc voulu réunir ces éléments pour permettre à ceux‐ci d’y référer commodément durant et après leur formation. 1.2 Contenu Les principales rubriques sont les suivantes : o Introduction à la rédaction technique et scientifique. o Types de documents : lettre, procédure, directive, note technique, rapport, etc. o Communication en langue claire et simple. o Conception graphique des documents en contexte multimédia. o Normes et standards : ISO, IEEE, OLFQ, etc. o Processus de rédaction et de contrôle de qualité des documents en technologies de lʹinformation : 1. Présentation du processus. 2. Analyse : définir les besoins. 3. Conception : préparer une table des matières structurée. 4. Modélisation : préparer et valider les modèles. 5. Assemblage : préparer le brouillon. 6. Correction : réviser et valider le brouillon. 7. Mise en forme. 8. Revue linguistique. INF 229 − Rédaction technique en informatique page 2 de 81 version 5.0 – 2009-10-07 1.3 Mise en contexte L’évolution des technologies entraîne une croissance des besoins de documentation. La clientèle à laquelle cette documentation est destinée est très variée. La qualité de la documentation produite est donc essentielle. La complexité croissante des technologies et des produits qui en sont issus impose un rehaussement des critères de qualité et une standardisation plus poussée. Les fluctuations de la main‐ d’œuvre exigent une plus grande rigueur au niveau du contenu des documents en général et des procédures en particulier. La situation que l’on retrouve sur le marché est plutôt uploads/s1/ inf229-notes-de-cours-501c.pdf