Dans mon rôle de professeur à la Haute école d'ingénierie et d'architecture de Fribourg, j'ai eu à maintes reprises l'occasion de corriger des rapports d'étudiants. Je constatais souvent les mêmes erreurs et j'ai alors décidé d'écrire cet article pour vous éviter de refaire ces mêmes erreurs.

Structure du rapport

Évitez de structurer votre rapport sur un axe temporel. Un rapport final n'est pas un journal de travail et vous décrivez votre travail à la fin du projet. L'ordre des chapitres ne représente pas l'évolution de votre projet dans le temps.

Les sections suivantes décrivent la structure traditionnelle d'un rapport final.

Page de garde

Vous pouvez concevoir la page de garde comme vous voulez, mais assurez-vous de mettre les éléments suivants :

• Le nom de l'école et logo officiel (utilisez le logo "large" avec le nom complet de l'école)
• Le nom de la filière d'étude
• Le titre du rapport
• La nature du projet (projet de semestre 5, projet de bachelor, ...)
• L'année académique
• Le ou les auteurs
• Le lieu (Fribourg) et la date de publication
• Le nom, l'entreprise et le logo du mandant (s’il y a en un)
• Le nom des superviseurs
• Le numéro de version (par exemple v0.4.2)

Pour un travail de bachelor, ajoutez encore :

• Le nom des experts

Tableau de versions

Indiquez dans un tableau ce qui a changé entre les versions. Cette information doit permettre à une personne qui vous suit régulièrement de ne lire que ce qui a changé entre deux versions.

Sommaire exécutif

Les lecteurs commencent très souvent par lire le sommaire exécutif de votre rapport. Ce sommaire permet au lecteur de savoir s’il va lire la suite de votre rapport ou non, et ça vaut la peine d'en soigner la rédaction.

Ne dépassez pas une demi-page pour le sommaire. Expliquez brièvement le contexte, l'approche que vous avez eu pour résoudre les problèmes et mentionnez vos résultats.

Le sommaire exécutif est souvent la dernière chose que vous écrirez, mais il doit figurer au début de votre rapport. C'est également une bonne idée de traduire ce sommaire dans une deuxième langue (par exemple, en français si le rapport est en anglais).

Table des matières

Numérotez les chapitres, car vous pourrez plus facilement y faire référence.

Assurez-vous de ne pas laisser de chapitres seuls. Si vous avez par exemple, un chapitre 1.4.1, mais que vous n'avez pas de chapitre 1.4.2, alors ça ne vaut pas la peine de diviser le chapitre 1.4. Renommez le chapitre 1.4 si nécessaire ou ajoutez-y un chapitre 1.4.2

Liste des abréviations, glossaire

Il est important de mettre une liste des abréviations et un glossaire au début de votre rapport. Ça permet au lecteur de se préparer et il ne sera pas surpris quand il verra ces abréviations dans le document.

Introduction

L'introduction présente le contexte ou l'historique des travaux déjà faits sur le sujet. Vous décrivez dans ce chapitre la nature du problème ainsi que son importance.

Il est intéressant d'également mentionner les objectifs dans l'introduction. Faites bien attention de ne pas confondre objectif avec activité. Un objectif est un délivrable que vous fournissez à la fin du projet (par exemple "un prototype" ou "une application). Vous décrirez l'objectif par un substantif (un nom). Une activité est une action qui vous permet d'atteindre l'objectif (par exemple "faire l'état de l'art", "développer" ou "tester"). L'activité est décrite par un verbe.

Contexte

Vous aurez présenté le contexte dans l'introduction et vous pouvez développer dans ce chapitre. Expliquez pourquoi vous faites ce projet et précisez les besoins que vous couvrez ou les problèmes que vous résolvez.

Analyse

Dans l'analyse, vous faites l'état de l'art dans le domaine de votre projet. Vous étudiez les outils et les "frameworks" disponibles et vous étudiez ce qui a déjà été fait. Vous prenez en compte les contraintes du projet et vous comparez les options. À la fin de l'analyse, le lecteur doit être convaincu que vous connaissez votre sujet et que vous avez su faire les bons choix.

Conception

Avec la conception, vous montrez les travaux et les réflexions que vous avez faites avant de réaliser votre projet. Pour du logiciel, ça peut être de faire des diagrammes de classes, des algorithmes en pseudo-code ou des esquisses d'interface utilisateur. Vous démontrez au lecteur que vous avez pris le temps de bien réfléchir avant de commencer la réalisation.

Réalisation / Implémentation

Dans ce chapitre, vous décrivez la réalisation pratique de votre projet. Vous pouvez donner des précisions sur les structures de données que vous utilisez, la manière dont vous avez réalisé les algorithmes ou les détails de bibliothèques que vous avez utilisées.

Pour un projet informatique, les commentaires dans votre code sont une bonne source d'inspiration pour rédiger ce chapitre.

Tests et validations

Le chapitre des tests et validations est souvent négligé. On n'y pense qu'à la fin et on n'a plus le temps de bien l'écrire. Et souvent, on ne sait pas trop quoi écrire, car on a aussi oublié de faire les tests en premier lieu.

Un bon ingénieur sait l'importance de délivrer un produit de qualité et fiable. Il planifie les tests dès le début du projet et démontre dans ce chapitre que son système satisfait aux standards.

Pour un projet informatique, ce chapitre décrit les tests unitaires, les tests d'intégration et les tests système. Vous pouvez décrire les résultats des tests dans une table en indiquant :

• Le nom du test
• La fonctionnalité qui est vérifiée par le test
• Le résultat attendu
• Le résultat obtenu
• Un commentaire

Décrivez aussi les mécanismes que vous avez mis en place pour vérifier votre programme (CI/CD, analyse statique de code...) et évaluez les performances de votre solution (en temps CPU et en mémoire).

Évolutions possibles et futurs travaux

Pendant votre projet, vous aurez de nouvelles idées, mais vous ne pourrez pas toutes les réaliser par manque de temps. Ce chapitre vous permet de mentionner ces idées et de donner des pistes pour faire évoluer ou pour améliorer votre projet.

Conclusion

La conclusion se concentre sur les résultats de votre projet. Vous écrivez comment vous avez répondu aux attentes du mandant et vous revenez sur les objectifs initiaux. Si vous n'avez pas atteint les objectifs, expliquez pourquoi et décrivez ce que vous avez fait à la place.

Pensez à bien soigner la conclusion. Certains lecteurs avertis commencent par lire le sommaire exécutif, puis ils lisent la conclusion, et s’ils aiment ce qu'ils lisent, alors ils lisent l'ensemble de votre rapport.

Complétez ce chapitre avec une conclusion personnelle. Faites preuve d'imagination et évitez de commencer par "j'ai bien aimé ce projet..." Vous pouvez aussi parler de comment vous avez géré le projet et dire ce que vous feriez différemment. N'hésitez pas à écrire cette partie à la première personne et à écrire "Je ..."

Remerciements

N'oubliez pas de remercier les personnes qui vous ont aidé pour ce projet, ça fait toujours plaisir. Remerciez les superviseurs, les mandants, les experts ainsi que la famille ou vos amis qui ont corrigé vos fautes d'orthographe.

Références et bibliographie

Mentionnez ici toutes les sources que vous avez utilisées dans votre rapport. Assurez-vous que tous les éléments de cette liste sont cités dans votre rapport. Ça ne sert à rien de mettre une référence juste parce que ça fait joli.

Citez les articles, les livres, et aussi les sites Internet que vous utilisez. Pour les sites Internet, précisez la date à laquelle vous avez lu l'information. Pour éviter que du contenu disparaisse, vous pouvez citer des URLs en passant par la "WayBack Machine" de l'Internet Archive

Vous trouverez plus de détails à ce sujet dans l'article de Laurenz Altwegg "References and Bibliography" :

References and Bibliography

Jacques Supcik ・ Nov 15 '21

#writing

Annexes

Les éléments suivants se retrouvent souvent dans les annexes :

• La version définitive du cahier des charges
• La planification (diagramme de Gant ou liste de "Sprints")
• Les codes informatiques (ou des extraits)

Technique d'écriture rapide et efficace

Si vous écrivez votre rapport paragraphe par paragraphe en vous efforçant de choisir les bons mots et corrigeant toutes les fautes d'orthographe, vous risquez alors de déprécier la cohérence et le flux de vos idées. Et comme vous aurez déjà passé beaucoup de temps sur votre texte, votre relecture sera superficielle et vous laisserez passer des fautes d'orthographe.

Une technique éprouvée pour écrire un document technique est de faire une première passe en écrivant le document dans un flux continu, sans faire attention à l'orthographe ou à la grammaire. L'idée est de mettre les idées dans le rapport dans un enchaînement logique. Ne cherchez pas les tournures de phrases parfaites, mais écrivez simplement vos pensées le plus vite possible.

Refaites ensuite une deuxième passe dans votre rapport et soignez maintenant la forme. Relisez chaque paragraphe et corrigez toutes les fautes. N'hésitez pas à vous faire aider par des logiciels de correction tels que LanguageTool ou Antidote et ne passez pas au paragraphe suivant tant que vous n'êtes pas satisfait.

Règles de style

On n'écrit pas un rapport scientifique comme un blog ou comme un roman policier. Le but du rapport, c’est de documenter votre travail et ça ne sert à rien de faire des phrases compliquées. Privilégiez la simplicité, mais ne négligez pas la forme. Un rapport qui ne suit pas certaines règles n'est souvent pas agréable à lire.

Utilisez la voie active

Souvent, pour éviter d'écrire "je" ou "nous", nous choisissons de tourner la phrase au passif. Cette pratique rend le texte ennuyeux et lourd. Privilégiez donc autant que possible la voie active.

Considérer, par exemple, la phrase suivante" :

"Nous avons choisi un langage de programmation adapté au problème"

Pour éviter le "nous", on pourrait écrire :

"Un langage de programmation adapté au problème a été choisi"

On a alors une phrase au passif qui n'est pas franchement intéressante. Nous pouvons retourner la phrase à l'actif en évitant le "nous" avec :

"Une comparaison sur différents critères a permis de choisir un langage de programmation adapté au problème"

... et le tour est joué, la phrase est maintenant à l'actif.

Écrivez au présent

Le rapport présente la situation telle qu'elle est à la fin du projet et le plus simple, c’est d'écrire toutes les phrases au présent. Vous pouvez utiliser le passé dans l'introduction et le futur dans la conclusion si le contexte s'y prête, mais de manière générale, écrivez au présent.

Expliquez le "pourquoi" des choses

Vous avez passé de nombreuses heures à travailler dur votre projet et certaines choses semblent aller de soi. Mettez-vous à la place du lecteur et demandez-vous si ce que vous avez écrit est compréhensible par quelqu'un qui découvre votre travail.

Si vous écrivez "Il est clair que", ou "il va de soi que", est-ce vraiment si clair que ça pour le lecteur ? Votre rapport doit répondre aux questions, et ne pas en soulever d'autres.

Il en va de même avec les expressions "il faut", ou "on doit"; si vous écrivez "il faut", vous devez expliquer pourquoi c'est comme ça. Notez qze vous prendrez moins de risque en écrivant "on peut" au lieu de "on doit".

Si en lisant votre rapport, le lecteur se dit "mais pourquoi il écrit ça!" vous faites alors quelque chose de faux.

Utilisez des formes positives pour les phrases

Évitez le plus possible le mot "pas". Au lieu d'écrire "le système ne résout pas le problème dans le temps imparti", écrivez "le système prend plus de temps que toléré pour résoudre le problème".

Ne mettez pas l'accent sur les points négatifs de votre projet, mais parlez plutôt de tout ce qui s'est bien passé.

Évitez aussi d'écrire "nous avons dû faire...". Une telle phrase donne l'impression que c'était une corvée et sonne de manière négative. Préférez une tournure positive ou alors neutre : "nous avons fait...".

Éviter "malheureusement"

Le dictionnaire "Le Robert" définit le malheur comme "Évènement qui affecte péniblement, cruellement (qqn)." C'est souvent trop fort dans un rapport scientifique et ça donne une image négative à votre travail.

Évitez "s'occupe de"

Le verbe pronominal "s'occuper de" est souvent mal utilisé et alourdit inutilement la phrase. Au lieu d'écrire "Le compilateur s'occupe de traduire le programme", écrivez simplement "Le compilateur traduit le programme". Dès que vous pensez à écrire "s'occupe de", réfléchissez si vous pouvez vous en passer.

Typographie

Vous disposez aujourd'hui d'outils modernes pour produire des documents de haute qualité. Comme futur ingénieur et étudiant dans une haute école, je ne peux que vous recommander LaTeX pour produire vos documents. LaTeX vous permet de séparer votre document en plusieurs fichiers et vous avez accès à de nombreuses bibliothèques pour mettre en forme pratiquement n'importe quel document. Si vous ne voulez pas installer la suite LaTeX sur votre machine, vous pouvez utiliser les services de Overleaf. Pour apprendre LaTeX, je vous recommande l'excellent The Not So Short Introduction to LaTeX 2ε de Tobias Oetiker. Vous trouverez également beaucoup de documentation sur le site de Overleaf ou sur Wikibooks

Voici encore quelques modèles de documents LaTeX publiés par de très bons anciens étudiants de l'école :

• Modèle de rapport publié par Lucy Linder
• Modèle de rapport publié par Marc Demierre
• Modèle de rapport pour le projet intégré publié par Sylvain Julmy
• Modèle de rapport pour thèse de Master HES-SO publié par Marc Demierre

Pas de souligné

En typographie moderne, on ne souligne plus le texte que l'on veut mettre en évidence. Cette pratique se faisait avec les machines à écrire mécaniques, mais avec les traitements de texte modernes, on préfère utiliser différentes polices et différents poids (semi-gras, gras…) pour remplacer le souligné.

Indentation des paragraphes

Un nouveau paragraphe commence soit par un espace horizontal au début de la première ligne, soit par espacement vertical. Mais attention, cette règle n'est valable pour les paragraphes qui en suivent un autre. Elle ne s'applique en général pas pour le premier paragraphe d'un chapitre, ni si le paragraphe est déjà précédé par un espace blanc vertical (par exemple, à la suite d'un tableau ou d'une illustration).

À mon avis, le plus simple est d'opter pour l'espace vertical entre les paragraphes. Avec LaTeX, vous pouvez utiliser le "package" parskip.

Commencez chaque chapitre ou sous-chapitre par une courte introduction

Évitez d'enchaîner un chapitre et un sous-chapitre sans mettre de texte pour introduire le chapitre.

De même, ne commencez pas un chapitre par un tableau, une illustration ou une liste à puce. Commencez toujours par du texte.

Illustrations

Les illustrations et les figures sont indispensables dans un rapport scientifique. N'hésitez pas à en abuser, mais faites attention à utiliser la même police d'écriture et la même grandeur de lettres que dans le texte principal.

Si votre illustration est trop grande, organisez les éléments de manière différente, mais n'utilisez pas de police plus petite que dans votre rapport.

Si vous faites des "screenshots" ou que vous mettez des "listings", évitez le "Dark Mode". Le "Dark Mode" s'est très bien à l'écran, mais dans un rapport imprimé sur du papier blanc, ça fait un trop grand contraste et ce n'est pas élégant.

Numérotez toutes les figures, les tables, les listings et référencez-les dans le texte

Les images ne sont pas que pour faire joli; elles permettent d'illustrer ce que vous avez écrit dans le texte. Toutes vos images auront donc un numéro et une légende, et on doit retrouver dans le texte une référence à l'image. Par exemple : "Comme illustré par la figure 12, ...". Cette règle vaut également pour les tables et les listings.

Ethique

Avec Internet et Wikipedia, c'est facile de copier des informations que vous trouvez en ligne. Ce n'est pas interdit de le faire, mais vous devez absolument citer toutes les sources que vous utilisez. Ça vaut pour tous les éléments de votre rapport : les textes, les illustrations, le code, ...

Mentionnez aussi toute utilisation d'intelligence artificielle (ChatGPT) pour produire du contenu.

L'article 29 du règlement sur la formation de base (bachelor et master) en HES-SO stipule que :

Toute fraude y compris le plagiat ou la tentative de fraude dans les travaux d’évaluation, les examens et le travail de bachelor ou le travail de master, entraîne la non-acquisition des crédits ECTS correspondants voire l’invalidation du titre et peut faire l’objet d’une des sanctions prévues à l’article 30.

Ne prenez pas de risque, citez toutes vos sources.

Conclusion

Je n'avais pas prévu d'écrire un article aussi long, mais j'espère que les conseils et les règles que je décris vous permettront de bien rédiger vos rapports d'étude et également les rapports professionnels que vous écrirez plus tard.

Remerciements

Merci à Rudolf Scheurer pour ses commentaires et suggestions constructifs.

Crédit

L'image en tête d'article est une photo de Markus Spiske sur Unsplash