Guide de rédaction des rapports techniques et de laboratoire Le
Transcription
Guide de rédaction des rapports techniques et de laboratoire Le
Guide de rédaction des rapports techniques et de laboratoire Le présent document fournit des lignes directrices sur la façon de rédiger les rapports techniques en général et les rapports de laboratoire officiels pour le cours MCG 4340 en particulier. 1. Exigences générales Le rapport doit être tapé d’un seul côté d’une feuille 21,5 cm x 28 cm (8 ½ po x 11 po) en utilisant une police lisible de 12 points pouvant se terminer par des empattements (comme la police romaine). Il faut utiliser un interligne de 1,5 ou double. Les marges supérieure, inférieure et de droite doivent être de 1 pouce (25 mm) et la marge de gauche de 1 ½ po (33 mm) pour la reliure. Il faut mettre les titres en évidence en utilisant une police plus grosse et les caractères gras. Une page de titre doit faire partie du rapport qui doit être relié (et non agrafé). Le rapport peut être rédigé en anglais ou en français. 2. Organisation Le rapport dont les différentes sections doivent être présentées selon l’ordre établi devrait être organisé comme suit. Les chapitres et les sous-sections doivent être numérotés : par exemple, 1. correspondrait à un chapitre, 1.1 à une section principale au sein du chapitre et 1.1.1 à une sous-section de la section. Page de titre Résumé – un sommaire concis d’environ un ou deux paragraphes du rapport. Remerciements (s’il y a lieu – ne font habituellement pas partie d’un rapport de laboratoire) Table des matières Liste des graphiques Liste des tableaux Nomenclature – tous les symboles mathématiques doivent être définis, sauf les plus connus. Si seulement quelques variables sont utilisées, elles peuvent être expliquées la première fois qu’elles sont présentées dans le texte. Cependant, si plus d’une dizaine de symboles sont requis, ils doivent être définis dans une section Nomenclature distincte. Les symboles doivent être présentés dans l’ordre suivant : lettres latines, lettres grecques (en ordre alphabétique dans les deux cas), autres symboles puis les indices inférieurs et supérieurs, de nouveau en ordre alphabétique. Les unités doivent être fournies pour toutes les variables de dimension; elles le seront normalement dans le système métrique sauf si des raisons particulières exigent d’utiliser le système anglais. Si vous utilisez de nombreux acronymes ou termes spécialisés, veuillez en fournir une définition dans un glossaire. Corps du rapport – comprendra plusieurs sections principales, habituellement les suivantes : 1. Introduction – bref aperçu des objectifs, de la raison du projet. 2. Contexte, théorie et recherche bibliographique – renseignements généraux qui permettront de comprendre le projet, y compris la théorie requise pour interpréter les résultats ultérieurement. Dans le cas d’un projet de recherche, cette section consistera principalement en un examen des travaux menés auparavant dans le champ d’études. 3. Appareils et méthodes utilisés dans le cadre de l’expérience – cette section comprend des énoncés sur la précision des mesures prises à l’aide des instruments (se reporter au paragraphe 5 ci-dessous). Pour le cours MCG 4340, veuillez noter les changements que vous avez apportés aux directives fournies dans le manuel. 4. Résultats et discussion – assurez-vous de répondre à toutes les questions figurant dans le manuel de laboratoire. Dans la mesure du possible, faites des affirmations quantitatives plutôt que qualitatives. 5. Conclusions et recommandations – uniquement les principales constatations. Ne résumez pas le rapport en entier puisque cela a déjà été fait dans le résumé. Les conclusions doivent être clairement justifiées à l’aide de données ou de la théorie présentée; elles ne devraient pas reposer sur des hypothèses non fondées. Références – de plus amples renseignements sont fournis ci-après. Tous les ouvrages énumérés dans les Références doivent avoir été mentionnés dans le rapport. Les ouvrages qui, selon vous, sont utiles, mais qui n’ont pas été cités dans le texte devraient être mentionnés séparément dans la Bibliographie. Annexes – contiennent des détails qui ne sont pas suffisamment importants pour être inclus dans le rapport, mais qui permettront au lecteur de suivre vos travaux, comme les fonctions dérivées ou les méthodes de calcul détaillées, les analyses détaillées des erreurs, les mises en tableau des données et les programmes d’ordinateur. Pour économiser de l’espace, vous pouvez disposer les programmes et les listes différemment, c'est-à-dire que contrairement au rapport principal, vous pouvez utiliser un interligne simple et des caractères de 10 points. Chaque annexe doit être désignée à l’aide d’une lettre (A, B, etc.) et d’un titre et énoncée dans la Table des matières. Le rapport devrait comprendre les renvois aux annexes. Les pages doivent être numérotées en chiffres arabes à compter de la première page du corps du rapport. Toutes les pages précédant le corps du rapport sont numérotées en chiffres romains minuscules (par exemple, vi) et la numérotation commence avec le Résumé à la page i. Étant donné que le Canada a officiellement adopté le système métrique de mesure, les résultats doivent être présentés en unités internationales. Il existe quelques exceptions à cette règle, comme dans le cas du système en pouce pour les filets de vis. 3. Figures et diagrammes Toutes les figures doivent être lisibles. Les lettres doivent avoir une taille d’au moins 10 points et la largeur des lignes doit être suffisante pour permettre une bonne reproduction (0,020" (0,5 mm) est la largeur recommandée). Toutes les figures doivent être mentionnées dans le texte. Elles peuvent faire partie du texte se trouvant près du paragraphe où elles sont mentionnées ou elles peuvent être regroupées à la fin d’une section. Chaque figure doit s’accompagner d’une légende fournissant suffisamment de renseignements pour que le lecteur puisse la comprendre sans devoir se rapporter au texte principal. Les figures doivent être numérotées séparément dans chaque section, par exemple, les figures 2.1, 2.2, etc. se trouvent dans la Section 2 du rapport. 4. Présentation des données – des graphiques La meilleure façon de présenter des données et des calculs consiste à utiliser des graphiques, même si parfois le recours à des tableaux conviendra peut-être mieux. Vous ne devriez pas présenter à la fois des graphiques et des tableaux pour la même série de données dans le corps du rapport. Par contre, vous pourriez ajouter les tableaux de données brutes à une annexe. Les graphiques doivent être conformes aux normes suivantes : Les mesures individuelles doivent être représentées par des points. Il ne faut pas utiliser le petit point, mais des symboles clairement visibles comme ", G, O, L, � ou �. Ces symboles peuvent en outre être utilisés en tant que légendes des différentes séries de données. Plusieurs mesures prises à une période donnée peuvent être présentées comme la valeur moyenne à l’aide d’intervalles d’erreurs plus ou moins l’écart-type de la moyenne pour indiquer la plage de dispersion. Il ne faut pas joindre les points expérimentaux à l’aide de lignes ou de courbes à moins que ce ne soit absolument nécessaire pour relier des données très dispersées. En effet, il est très facile de donner une fausse impression lorsque l’on trace une ligne, car les lecteurs ont tendance à croire que la ligne a été adaptée ou qu’elle représente le véritable comportement du système. Ce genre de lignes ne doit présenter que la tendance générale des données et ne doit pas relier chaque point. Habituellement, les feuilles de calcul joignent tous les points par des lignes; ces dernières doivent en général être supprimées. En règle générale, les seules données expérimentales représentées au moyen de courbes plutôt que de points sont celles provenant d’instruments enregistrant les données continuellement, comme une courbe de tension-effort d’un essai de tension ou un enregistrement au fil du temps d’un thermocouple. Les quantités calculées issues d’une courbe adaptée aux données ou à un modèle théorique sont toujours représentées au moyen de lignes, jamais à l’aide de points. Les points servent uniquement à représenter les données expérimentales. Dans ce cas également, il faut supprimer les lignes créées automatiquement par les feuilles de calcul pour représenter les points. Il faut utiliser différents genres de lignes, par exemple, traitillées, pointillées, etc. si vous devez représenter différentes courbes. Tous les axes doivent être identifiés clairement avec la variable représentée et ses unités de mesure, par exemple, Pression (kPa). Il faut éviter de représenter un trop grand nombre de séries de données et de courbes sur le même graphique. Les échelles logarithmiques sont utilisées lorsque l’éventail de données est trop grand pour être représenté sur une échelle linéaire. Si la plus grande valeur représentée est dix fois plus grande que la plus petite, une échelle logarithmique permettra bien souvent de rendre les valeurs faibles plus visibles. Les échelles logarithmiques servent également lorsque l’on s’attend à ce que les données suivent certaines formes mathématiques. Par exemple, la représentation semi-logarithmique (une échelle logarithmique, une échelle linéaire) sert à représenter les vitesses de réaction parce qu’elles suivent habituellement la loi d’Arrhenius, qui consiste en une droite lorsqu’elle est tracée sur un graphique formé d’une échelle logarithmique (1/T) et d’une échelle linéaire. On a recours bien souvent à un graphique log-log pour déduire la loi de puissance entre des quantités. L’équation y axb devient une équation linéaire avec le point d’interception (log a) et la pente b si on la représente sur des coordonnées log-log. Ainsi, on obtient l’équation suivante si l’on prend les logarithmes de chaque côté : log y = log a + b log x Les feuilles de calcul standards permettent de créer des graphiques semi-logarithmiques et des graphiques log-log. Les échelles logarithmiques ne comportent pas de zéro puisque log(0) n’est pas défini. Il convient de préciser que les échelles logarithmiques ne sont qu’une manière de transformer les coordonnées, c’est la variable en soi, et non pas son logarithme, qui est présentée sur l’échelle. Vous trouverez en annexe quelques exemples de graphiques. 5. Présentation des données – Erreurs Toute présentation de mesures doit être accompagnée d’un énoncé honnête au sujet de leur exactitude. Voici les deux genres d’erreurs qui se produisent dans la plupart des mesures : - l’erreur systématique est causée par l’instrument de mesure, par exemple, calibration erronée, dérive du point zéro, perturbations causées par les sondes (par exemple, dans la circulation des fluides), inertie mécanique ou thermique (défaut de suivre correctement les changements ou les fluctuations rapides) ou influences externes (par exemple, transmission de la chaleur des environs à un thermomètre). Il est souvent possible d’évaluer ces erreurs et de les compenser en calibrant selon une norme connue ou en élaborant une théorie simple pour la réponse de l’instrument. L’erreur systématique peut en outre se produire si une personne prend continuellement des mesures en utilisant une technique déficiente (par exemple, elle regarde une échelle en inclinant la tête). -l’erreur aléatoire est causée par une erreur humaine au moment des observations, par un bruit électronique ou par des fluctuations aléatoires de la quantité mesurée. Ces erreurs produisent une dispersion de mesures concernant une valeur moyenne et peuvent être évaluées en prenant des mesures répétées de la même quantité ou en répétant l’expérience. L’erreur aléatoire au moment de la lecture d’une échelle sera de ± (la moitié de la plus petite mesure qu’une personne puisse lire ou interpoler de l’échelle). Par exemple, si une personne peut lire une échelle graduée en mm entiers au 0,5 mm près, l’erreur sera donc de ±0,25 mm. - propagation d’erreur – Des quantités calculées d’après plusieurs valeurs mesurées comporteront une erreur aléatoire qui dépend des erreurs des mesures combinées. Si une quantité P représente une fonction des valeurs mesurées x, y, z...., ayant chacune une erreur ЄX, ЄY, ЄZ ....., alors l’erreur dans P est Cela produit des résultats simples pour certaines formes de P. Si P = x + y, alors Si P = xy, alors Si P = Axn, alors Les Є sont des erreurs absolues en unités de la quantité mesurée; les erreurs relatives ou en pourcentage correspondantes seraient ЄP/P, ЄX/x, etc. On considère acceptable de rejeter une, et une seule, mesure qui dévie clairement beaucoup plus de la moyenne que les autres données. Cette façon de procéder est acceptée parce qu’il est possible de faire une erreur au moment de lire une valeur, mais de nombreuses mesures « aberrantes » laissent entendre soit que l’équipement est défectueux ou soit qu’il faut examiner les causes du comportement imprévu du système. Le nombre de chiffres significatifs que comportent les données expérimentales doit indiquer la précision de la mesure. Ce principe doit être suivi pour toute quantité calculée à partir de ces mesures. Au moment de multiplier ou de diviser des nombres, la réponse doit avoir le même nombre de chiffres significatifs que le nombre le moins précis utilisé dans l’opération. Dans le cas des additions et des soustractions, la réponse doit avoir le même nombre de décimales (et non de chiffres significatifs) que la donnée la moins précise. Pour les calculs plus complexes, le nombre de chiffres significatifs peut être déterminé au moyen de l’équation de la propagation d’erreur. Pour obtenir de plus amples renseignements sur ce sujet, veuillez consulter le guide Marks’ Standard Handbook for Mechanical Engineers, p. 2-4. 6. Équations Les équations devraient être préparées à l’aide de l’éditeur d’équations de WordPerfect ou de Word. À l’exception des équations très simples, il est difficile d’insérer une équation qui se lit bien dans du texte ordinaire. Il ne convient pas de rédiger une équation comme vous le feriez dans une feuille de calcul, par exemple, y = 3*x^2 pour y = 3x2. La plupart des équations devraient être décalées du texte comme nous l’avons fait dans la section précédente, mais les équations très courtes peuvent être écrites sur une même ligne, comme . Seules les équations que vous comptez mentionner plus tard dans le texte doivent être numérotées. Vous pouvez utiliser simplement les chiffres 1, 2, 3.... etc., mais vous pouvez également les numéroter en fonction du chapitre dans lequel elles figurent, comme 1.1, 1.2, 1.3, etc. Tous les symboles utilisés dans une équation doivent être définis dans le rapport, soit dans le texte où chaque symbole est présenté la première fois ou soit dans une nomenclature au début du rapport, après la table des matières. Vous devriez toujours créer une nomenclature si vous utilisez un grand nombre de symboles ou si votre rapport est très long. N’obligez pas vos pauvres lecteurs à fouiller dans les pages précédentes pour trouver la définition du symbole! Vous pouvez fournir à la fois une nomenclature et les définitions des symboles dans le texte si vous croyez que vos lecteurs pourront ainsi plus facilement suivre le texte. Une équation fait partie d’une phrase et le texte qui précède et qui suit l’équation doit être ponctué comme si vous deviez lire l’équation ou l’écrire en mots. Voici un exemple : La composition du combustible est décrite par la distribution f(I), donnée par (1) où ", $ et ( représentent les paramètres de la distribution. Certains éditeurs de texte (comme Word) mettraient automatiquement la première lettre de « où » en majuscule dans cet exemple. Du point de vue de la grammaire, cela constitue une erreur puisque ce mot ne commence pas une nouvelle phrase. Vous devez changer la majuscule pour la minuscule si cela se produit. À vrai dire, il devrait y avoir une virgule après l’équation, mais celle-ci est habituellement omise. 7. Références Les références visent à permettre au lecteur de déterminer la source originale de tous les renseignements importants fournis dans le rapport. La source de tout élément d’information tiré d’un autre ouvrage qui est reproduit dans le rapport, qu’il s’agisse de passages, de données, de graphiques ou de diagrammes, doit être dûment citée. Dans le cas des passages, il faut les mettre entre guillemets et ajouter leur référence; pour les autres types d’éléments d’information, il faut inscrire (Tiré de … ) dans la légende. La reproduction d’éléments d’information tirés d’ouvrages d’autres auteurs sans les citer en référence constitue du plagiat et peut donner lieu à des sanctions pour fraude scolaire. Il existe deux systèmes acceptés en génie pour citer les références à des publications : - le système numérique (le plus commun) : l’ouvrage est cité dans le texte accompagné d’un numéro entre crochets [4]. Les nombres sont assignés dans l’ordre dans lequel les ouvrages sont cités dans le texte et les ouvrages sont énumérés dans cet ordre dans la liste des références. Si un ouvrage est cité plus d’une fois, le même numéro est utilisé pour chaque citation. Les citations demandent moins d’espace dans le texte avec ce système. Par contre, si vous révisez le manuscrit et y ajoutez des références, vous devrez numéroter à nouveau les références à partir de la première nouvelle référence. - le système auteur-date : l’ouvrage est cité dans le texte ainsi : Smith et Jones (1975), ou, s’il y a plus de deux auteurs, il faut inscrire Smith et autres (1975). Dans la liste des références, les ouvrages sont énoncés en ordre alphabétique selon le nom du premier auteur. Dans les deux cas, toutes les références sont fournies ensemble dans une liste figurant à la fin du rapport. Les références ne doivent pas être fournies dans les notes en bas de page : cette façon de présenter les citations n’est pas acceptable en génie, même s’il s’agit de la pratique courante en sciences humaines. Dans la liste des références, chaque ouvrage est cité avec le nom de tous les auteurs, le titre et l’année de publication. Pour les revues spécialisées, il faut fournir le nom de la revue, le numéro du volume et les numéros de page; pour les documents de conférence, il faut inscrire le titre et l’endroit de la conférence et les numéros de page dans les actes; et pour les livres et les rapports : l’éditeur et la ville. Les références aux éléments d’information tirés du Web doivent comprendre l’adresse URL et la date à laquelle l’information a été affichée. Veuillez éviter d’utiliser un très grand nombre de citations provenant du Web puisque les sites Web changent fréquemment et que les éléments d’information mentionnés pourraient éventuellement ne plus être accessibles. Voici des formulations types de références : à une revue spécialisée : Smith, A., Jones, B. et Bloggs, W. (1993), Décomposition à haute température des rapports de laboratoire, Canadian Journal of Chemical Engineering, volume no, page xx. à un document de conférence : Souffle, J. et Neige, M. (1996), Émissions toxiques issues de l’incinération des rapports de laboratoire, Conférence sur l’incinération, Toronto, page xx. à un livre : Étudiante, A. et Schueler, M. (2001), Guide de recyclage des rapports de laboratoire, Presse de l’Université d’Ottawa, Ottawa. Si vous voulez renvoyer le lecteur à une page précise du livre, ajoutez la citation dans le texte : « Smith [25, p. 345] fait ressortir que... » ou « Smith (1983, p. 345) met en évidence que... ». Si le livre n’a pas d’auteur, comme dans le cas d’un guide d’utilisateur d’un appareil, inscrivez le nom de l’entreprise comme auteur. à des renseignements verbaux : Chrétien, J. (2002), communication personnelle. Si vous avez des doutes sur la façon de formuler les références, suivez la disposition adoptée dans les revues de génie réputées. Ce qui compte le plus dans le cas des références, c’est de donner suffisamment de renseignements à vos lecteurs pour qu’ils puissent trouver l’ouvrage à la bibliothèque. Préparé par W. Hallett MCG 4340 – Exemples de graphiques (En haut à gauche) Le graphique a été tracé par une feuille de calcul; (à droite) le même graphique « nettoyé » et disposé pour la présentation. Ci-dessous : deux graphiques dont les courbes sont correctement identifiées. Comparativement à la légende, l’identification des courbes et des points facilite grandement la lecture du graphique. (Ci-dessus) Les mêmes données tracées sur une échelle linéaire (gauche) et sur une échelle log-log (droite). (En haut à gauche) points mesurés reliés à l’aide d’une ligne. (À droite) échelles logarithmiques. (Ci-dessous) les mêmes données tracées sur une échelle linéaire (gauche) et sur une échelle semi-logarithmique (droite). Préparé par W. Hallett