Guide de rédaction de rapports techniques: Guides d'étude: …: École d'ingénierie et d'informatique: Écoles et services: Université du Sussex – ecrire un livre dans word

Télécharger la version pdf pour impression

Table des matières

1. Introduction

2 structure

3 présentation

4 Planifier le rapport

5 Rédaction du premier brouillon

6 Révision du premier projet

7 Diagrammes, graphiques, tableaux et mathématiques

8 La mise en page du rapport

9 rubriques

10 Références aux diagrammes, graphiques, tableaux et équations

11 Originalité et plagiat

12 Finalisation du rapport et relecture

13 Le résumé

14 relecture

15 Traitement de texte / publication assistée par ordinateur

16 lectures recommandées

1. Introduction

Un rapport technique est un rapport formel conçu pour transmettre des informations techniques dans un format clair et facilement accessible. Il est divisé en sections qui permettent à différents lecteurs d’accéder à différents niveaux d’information. Ce guide explique le format généralement accepté pour un rapport technique; explique les objectifs de chaque section; et donne des conseils sur la manière de préparer et d’affiner un rapport afin de produire un document précis et professionnel.

2 structure

Un rapport technique devrait contenir les sections suivantes;

Section Détails
Titre de page Doit inclure le titre du rapport. Les rapports d'évaluation, dans lesquels la longueur du mot a été spécifiée, exigent souvent également le nombre de mots récapitulatif et le nombre de mots du texte principal.
Résumé Un résumé de l'ensemble du rapport, y compris les caractéristiques, résultats et conclusions importants
Contenu Numéros et répertorie tous les en-têtes de section et de sous-section avec les numéros de page
introduction Indique les objectifs du rapport et commente la manière dont le sujet du rapport doit être traité. Cela mène directement au rapport lui-même. Ne doit pas être une copie de l'introduction dans un document de laboratoire.
Les sections qui composent le corps du rapport Divisé en sections numérotées et dirigées. Ces sections séparent les différentes idées principales dans un ordre logique
Conclusions Un bref résumé logique du ou des thèmes développés dans le texte principal
Références Détails des sources publiées des documents mentionnés ou cités dans le texte (y compris les notes de cours et les adresses URL des sites Web utilisés).
Bibliographie Autres sources publiées de matériel, y compris des sites Web, non mentionnées dans le texte, mais utiles pour une lecture de fond ou une lecture plus approfondie.
Remerciements Liste des personnes qui vous ont aidé à rechercher ou à préparer le rapport, y compris vos correcteurs
Annexes (le cas échéant) Tout autre matériel essentiel à la compréhension de votre rapport (par exemple, diagrammes à grande échelle, code informatique, données brutes, spécifications), mais non requis par un lecteur occasionnel

3 présentation

Pour les rapports techniques requis dans le cadre d’une évaluation, les directives de présentation suivantes sont recommandées;

Scénario Le rapport doit être imprimé recto sur du papier A4 blanc. Les rapports manuscrits ou imprimés par matrice de points ne sont pas acceptables.
Marges Les quatre marges doivent avoir au moins 2,54 cm
Numéros de page Ne numérotez pas le titre, le résumé ou les pages de contenu. Numérotez toutes les autres pages consécutivement à partir de 1.
Contraignant Une agrafe unique dans le coin supérieur gauche ou 3 agrafes espacées dans la marge gauche. Pour les rapports plus longs (rapport de projet de la troisième année, par exemple), des classeurs peuvent être utilisés.

4 Planifier le rapport

Il existe d’excellents manuels contenant des conseils sur le processus d’écriture et sur la façon de commencer (voir Article 16). Voici une liste de contrôle des principales étapes;

  • Recueillez vos informations. Les sources incluent des documents de laboratoire et des notes de cours, la bibliothèque universitaire, les ouvrages de référence et les revues du bureau du département. Conservez un enregistrement précis de toutes les références publiées que vous souhaitez utiliser dans votre rapport, en notant les informations suivantes;

    Article de journal:
    auteurs)
    titre de l'article
    nom du journal (italique ou souligné)
    Année de publication
    numéro de volume (gras)
    numéro d'édition, s'il est indiqué (entre parenthèses)
    Numéros de page

    Livre:
    auteurs)
    titre du livre (italique ou souligné)
    édition, le cas échéant
    éditeur
    Année de publication

    N.B. la liste des manuels recommandés à la section 2 contient toutes ces informations dans le format correct.

  • Phase créative de la planification. Ecrivez les sujets et les idées de votre matériel de recherche dans un ordre aléatoire. Ensuite, organisez-les en groupes logiques. Notez les sujets qui ne correspondent pas à des groupes au cas où ils vous seraient utiles ultérieurement. Placez les groupes dans une séquence logique qui couvre le sujet de votre rapport.
  • Structurer le rapport. En vous servant de votre séquence logique d’idées groupées, écrivez un aperçu du rapport avec les titres et les sous-titres.

N.B. la liste des manuels recommandés en Article 16 contient toutes ces informations dans le format correct.

5 Rédaction du premier brouillon

Qui va lire le rapport? Pour les travaux de cours, les lecteurs peuvent être des camarades de classe et / ou des correcteurs. Dans les contextes professionnels, les lecteurs peuvent être des gestionnaires, des clients, des membres de l'équipe de projet. La réponse aura une incidence sur le contenu et le niveau technique et constitue une considération majeure dans le niveau de détail requis dans l'introduction.

Commencez à écrire avec le texte principal, pas l'introduction. Suivez vos grandes lignes en termes de titres et de sous-titres. Laissez les idées couler; ne vous inquiétez pas à ce stade du style, de l’orthographe ou du traitement de texte. Si vous êtes bloqué, revenez à votre plan d'ensemble et prenez des notes préparatoires plus détaillées pour que l'écriture coule à nouveau.

Faites des croquis approximatifs de diagrammes ou de graphiques. Conservez une liste numérotée de références au fur et à mesure de leur rédaction et mettez les citations entre guillemets (voir Article 11).

Écrivez la conclusion suivante, suivie de l'introduction. N'écrivez pas le résumé à ce stade.

6 Révision du premier projet

C'est à ce stade que votre rapport commencera à prendre forme en tant que document technique professionnel. En révisant ce que vous avez rédigé, vous devez garder à l’esprit le principe important suivant:

  • L'essence d'un rapport technique réussi réside dans la précision et la concision avec laquelle il transmet les informations souhaitées au lectorat souhaité.

Au cours de l'année 1, terme 1, vous apprendrez à écrire l'anglais formel pour la communication technique. Cela inclut des exemples des pièges les plus courants dans l’utilisation de l’anglais et comment les éviter. Utilisez ce que vous avez appris et les livres recommandés pour vous guider. Plus important encore, lorsque vous lisez tout ce que vous avez écrit, vous devez vous poser ces questions.

  • Est-ce que cette phrase / ce paragraphe / cette section dit ce que je veux et veut dire?
    Sinon, écrivez-le différemment.
  • Y a-t-il des mots / phrases / paragraphes qui pourraient être supprimés sans affecter les informations que je tente de transmettre?
    Si oui, supprimez-les.

7 Diagrammes, graphiques, tableaux et mathématiques

Il arrive souvent que les informations techniques soient communiquées de la manière la plus concise et la plus claire par des moyens autres que les mots. Imaginez comment vous décririez un circuit électrique en utilisant des mots plutôt qu’un schéma de circuit. Voici quelques directives simples.

Des diagrammes Gardez-les simples. Dessinez-les spécifiquement pour le rapport. Placez de petits diagrammes après la référence du texte et aussi près que possible de celle-ci. Pensez à l'emplacement des grands diagrammes.
Graphiques Pour des conseils détaillés sur le traçage de graphique, voir la 'guide pour la rédaction d'un rapport de laboratoire'
les tables Une table est-elle le meilleur moyen de présenter vos informations? Considérez des graphiques, des diagrammes à barres ou des camemberts.
Les tableaux dépendants (petits) peuvent être placés dans le texte, même dans le cadre d'une phrase.
Les tableaux indépendants (plus grands) sont séparés du texte par des numéros et des légendes. Placez-les aussi près que possible de la référence du texte. Les tableaux compliqués doivent figurer en annexe.
Mathématiques N'utilisez les mathématiques que lorsque c'est le moyen le plus efficace de transmettre l'information. Des arguments mathématiques plus longs, s’ils sont vraiment nécessaires, devraient être annexés. Vous recevrez des documents de cours sur la bonne disposition pour les mathématiques.

8 La mise en page du rapport

L’apparence d’un rapport n’est pas moins importante que son contenu. Un rapport attrayant et clairement organisé a de meilleures chances d'être lu. Utilisez une police standard de 12 points, telle que Times New Roman, pour le texte principal. Utilisez des tailles de police différentes, gras, italique et souligné le cas échéant, mais sans excès. Trop de changements de style peuvent paraître très difficiles.

9 rubriques

Utilisez des titres et des sous-titres pour séparer le texte et guider le lecteur. Ils doivent être basés sur la séquence logique que vous avez identifiée au stade de la planification, mais avec suffisamment de sous-titres pour diviser le matériau en morceaux gérables. L'utilisation de la numérotation, de la taille et du style du texte peut clarifier la structure comme suit:

3 méthodes d'exploitation de l'énergie des vagues

3.1 Systèmes à terre

3.2 Systèmes en eau profonde

3.2.1 "Canard" dispositifs
3.2.2 Radeaux

10 Références aux diagrammes, graphiques, tableaux et équations

  • Dans le texte principal, vous devez toujours faire référence à tout diagramme, graphique ou tableau que vous utilisez.
  • Étiquetez les diagrammes et les graphiques comme suit;

    Figure 1.2 Graphique de la production d’énergie en fonction de la hauteur des vagues.

    Dans cet exemple, le deuxième diagramme de la section 1 serait désigné par "… voir la figure 1.2 …"

  • Étiquetez les tables de la même manière;

    Tableau 3.1 Spécifications de performance d'une gamme de dispositifs GaAsFET disponibles dans le commerce

    Dans cet exemple, on pourrait faire référence au premier tableau de la section 3 par "… avec référence aux spécifications de performances fournies dans le tableau 3.1 …".

  • Numéroter les équations comme suit;

    F (dB) = 10 * logdix(F) (3.6)

    Dans cet exemple, la sixième équation de la section 3 pourrait être désignée par "… le facteur de bruit en décibels donné par eqn (3.6) …"

11 Originalité et plagiat

Chaque fois que vous utilisez les faits ou les idées d'autres personnes, vous devez l'indiquer dans le texte avec un numéro qui fait référence à un élément de la liste de références. Les phrases, phrases ou paragraphes copiés sans modification doivent être placés entre guillemets et référencés par un numéro. Les documents qui ne sont pas reproduits sans modification ne doivent pas figurer entre guillemets, mais doivent néanmoins être référencés. Il ne suffit pas d’énumérer les sources d’information à la fin du rapport; vous devez indiquer les sources d'informations individuellement dans le rapport à l'aide du système de numérotation de référence.

Les informations qui ne sont pas référencées sont supposées être soit une connaissance commune, soit votre propre travail ou vos propres idées. si ce n’est pas le cas, il est supposé plagié, c’est-à-dire que vous avez sciemment copié les mots, les faits ou les idées de quelqu'un d’autre sans référence, en les faisant passer pour vous. C'est un infraction grave. Si la personne copiée est un camarade de classe, cette infraction est appelée «collusion» et est également grave. Les commissions d’examen peuvent et imposent des sanctions pour ces infractions allant de la perte de notes à la déchéance du diplôme.

Cet avertissement s’applique également aux informations obtenues à partir d’Internet. Il est très facile pour les marqueurs d’identifier des mots et des images copiés directement à partir de sites Web. Si vous faites cela sans mentionner la source de vos informations et mettre les mots entre guillemets, votre rapport sera envoyé à l'enquêteur et vous pourrez être convoqué devant un panel disciplinaire.

12 Finalisation du rapport et relecture

Votre rapport devrait maintenant être presque complet avec une introduction, le texte principal en sections, les conclusions, des références correctement formatées, une bibliographie et toutes annexes. Vous devez maintenant ajouter les numéros de page, le contenu et les pages de titre et rédiger le résumé.

13 Le résumé

Le résumé, avec le titre, doit indiquer la portée du rapport et donner les principaux résultats et conclusions. Il doit être intelligible sans le reste du rapport. De nombreuses personnes peuvent lire et se référer à un résumé de rapport, mais seules quelques-unes peuvent lire le rapport complet, comme cela se produit souvent dans une organisation professionnelle.

  • But – une version courte du rapport et un guide pour le rapport.
  • Longueur – courte, généralement pas plus de 100 à 300 mots
  • Contenu – fournit des informations et pas seulement une description du rapport.

14 relecture

Cela fait référence à la vérification de chaque aspect d'un travail écrit, du contenu à la mise en page, et constitue un élément absolument nécessaire du processus d'écriture. Vous devez acquérir l’habitude de ne jamais envoyer ni soumettre d’ouvrage écrit, du courrier électronique au cours, sans au moins un et de préférence plusieurs processus de relecture. En outre, il n’est pas possible pour vous, en tant qu’auteur d’un long écrit, de relire vous-même vos relectures; vous êtes trop familier avec ce que vous avez écrit et vous ne remarquerez pas toutes les erreurs.

Lorsque vous avez terminé votre rapport et avant de l’agrafer, vous devez le vérifier très attentivement vous-même. Vous devriez ensuite le donner à quelqu'un d'autre, par exemple l’un de vos camarades, à lire attentivement et à vérifier les erreurs de contenu, style, structure et mise en page. Vous devriez enregistrer le nom de cette personne dans vos remerciements.

15 Traitement de texte / publication assistée par ordinateur

Avantages Désavantages
Les packages de traitement de texte et de publication assistée par ordinateur offrent une grande marge de manœuvre pour la révision sans fin d'un document. Cela inclut les mots, l'ordre des mots, le style et la mise en page. Les logiciels de traitement de texte et de publication assistée par ordinateur ne compensent jamais le contenu médiocre ou inexact
Ils permettent la production incrémentielle d'un long document en portions qui sont stockées et combinées ultérieurement Ils peuvent perdre beaucoup de temps en ralentissant l'écriture et en distrayant l'auteur avec les mécanismes de manipulation des textes et des graphiques.
Ils peuvent être utilisés pour donner à un document un aspect élégant et professionnel. L'utilisation excessive de 'couper-coller' conduit à une répétition fastidieuse et à une écriture bâclée.
Ils rendent le processus de relecture et de révision extrêmement simple. Si le premier brouillon est un traitement de texte, il peut sembler tellement élégant que l’écrivain est persuadé qu’il n’a pas besoin de relecture ni de révision!

Deux astuces utiles;

  • Ne vous embêtez pas avec le style et la mise en forme d'un document jusqu'à l'avant-dernière ou la dernière version.
  • N'essayez pas de finaliser les graphiques tant que le contenu du texte n'est pas terminé.

16 lectures recommandées

  • Davies J.W. Compétences en communication – Un guide pour les étudiants en génie et en sciences appliquées (2e éd., Prentice Hall, 2001)
  • van Emden J. Communication efficace pour la science et la technologie (Palgrave 2001)
  • van Emden J. Un manuel de rédaction pour les ingénieurs 2e éd. (Macmillan 1998)
  • van Emden J. et Easteal J. Rédaction technique et prise de parole, une introduction (McGraw-Hill 1996)
  • Pfeiffer W.S. Guide de poche pour la rédaction technique (Prentice Hall 1998)
  • Eisenberg A. Communication technique efficace (McGraw-Hill 1992)

Dr Helen Prance
Ecole d'Ingénierie et Design
L'Université du Sussex

Mis à jour le 04.2010


#ecrire un livre sur son histoire
#ecrire un livre sur sa grossesse
#comment écrire un livre technique pdf