Comment écrire un bon rapport ?

by Martin Monperrus

Ce document présente quelques consignes et astuces pour l’écriture d’un bon rapport. Il s’applique à un rapport de stage en entreprise, un rapport de projet, un rapport de TP.

Un bon rapport est bien structuré, clair, concis, aéré, illustré.

Plan type d’un rapport de stage

Voir aussi les bonnes et mauvaises pratiques à la fin de ce document.

Plan type d’un rapport de projet

Bonnes pratiques

  1. Un bon rapport est factuel.

  2. Un bon rapport a un bon titre qui donne une idée de son contenu.

  3. Un bon rapport explique des problèmes et leurs solutions: le point de départ et le point d’arrivée, mais pas le chemin tortueux entre les deux. Le chemin est intéressant uniquement dans le cas où vous arrivez à construire une leçon réutilisable sur le chemin à prendre ou ne pas prendre.

  4. Un bon rapport sépare la présentation des problèmes et des solutions, de l’architecture et de l’implémentation, de la méthodologie et des résultats.

  5. La page de garde d’un bon rapport contient le titre, une date, les noms des auteurs.

  6. Un bon rapport contient une introduction et une conclusion.

  7. Un bon rapport a des définitions claires qui posent les fondations des concepts clés du travail.

  8. Un bon rapport contient des illustrations qui aèrent la lecture et facilitent la compréhension.

  9. Un bon rapport utilise du pseudo-code pour décrire les algorithmes importants. Le pseudo-code est plus compréhensible et à un plus haut niveau d’abstraction que le code implanté.

  10. Un bon rapport contient des hyperliens qui facilitent la navigation vers les documents et artefacts mentionnés.

  11. Un bon rapport est beau. Certains logiciels facilitent la production de beaux rapports (e.g. LaTeX). Les critères de beauté incluent la justification, la numérotation des sections, les liens vers les références, la non-pixelisation des illustrations.

  12. Un bon rapport a des numéros de page.

  13. Un bon rapport est dans format ouvert et bien supporté comme par exemple PDF.

  14. Un bon rapport a une conclusion qui rappelle le résultat fort.

  15. Une listing de code est lisible et pas trop grand (< 10 lignes).

Mauvaise pratiques

  1. Réutiliser du texte sans le citer et donner du crédit à la source (e.g. du plagiat)

  2. Avoir des parties orphelines (e.g. une seule sous-section, une seule sous-sous-section).

  3. Raconter l’histoire de ce que vous avez fait (le premier jour, XXX, ensuite, YYY).

  4. Contenir trop de code.

  5. Contenir du code illisible.

  6. Contenir des traces d’exécution ou des logs illisibles.

  7. Donner trop de détails d’implémentation (la variable XX contient l’information YYY).

  8. Être trop vague (“dans certains cas, XX”). dire à la place: “Dans le cas où YYY, XX”.

  9. Utiliser des listes à puce (quelques listes bien choisies peuvent être appropriées mais c’est dangereux).

  10. Contenir des fautes d’orthographe, ou de typographie.

  11. Utiliser trop de polices en gras ou en italique.

  12. Utiliser le passé constamment.

  13. Utiliser trop de parenthèses.

  14. Avoir des paragraphes d’une seule ligne, des phrases seules.

  15. Avoir des phrases qui ne sont pas des phrases (e.g. sujet manquant, verbe manquant)

  16. Utiliser un format propriétaire comme DOCX.

Tagged as: