Report writing guide

Un rapport de TP est un document qui permet :

1. de rendre compte
   • de ce que vous avez fait ;
   • de ce que vous avez compris ;
   • de ce que vous n'avez pas compris, et de la démarche que vous avez entreprise pour avancer vers la compréhension ;
2. de vous évaluer.

La forme¶

• Le document doit être rédigé dans un niveau de langue soutenu. Vous devez faire attention à éviter les abréviations, les fautes de typographie, et dans la mesure du possible les fautes d'orthographe.
• Il doit contenir un titre, des auteurs, un code voir un nom d'unité, une date de production et éventuellement des dates correspondant aux séances de TP.
• Sauf consigne contraire, il doit être rendu sous la forme d'un fichier non modifiable, type pdf.
• Il doit contenir une introduction, une table des matières et une conclusion.
• Les réponses aux différentes questions posées dans le sujet de TP doivent être clairement identifiables par un style de document approprié et un respect de la nomenclature du sujet de TP.
• Il doit être facile d'identifier quelles questions ont été traitées, avec une différenciation selon le niveau d'aboutissement (traitée complètement, abordée mais problème non résolu, pas abordée par manque de temps ...). Par exemple un tableau récapitulatif peut être ajouté en début ou en fin de document avec la liste des questions et un pourcentage de complétion.
• Les images, photos, screenshots sont possibles, mais doivent être insérés en tant que figure, et ne font donc pas office de réponse. Comme pour toute figure, elles doivent être légendées et numérotées afin de pouvoir y faire référence dans le texte. Dans le cas du screenshot, si celui ci contient du texte (par exemple une copie d'écran d'un fichier texte ou d'une ligne de commande), c'est une erreur ! Il faut plutôt copier coller le texte, afin que ce copier coller puisse être fait dans l'autre sens depuis le pdf par le lecteur (et l'évaluateur).
• Le rapport est une production personnelle. Toute phrase issue de wikipédia, recopiée depuis un livre, un rapport d'un⋅e autre étudiant⋅e ou un site internet, ou bien produite par un robot conversationnel doit être très clairement identifiée comme telle.
• Éviter absolument les listings de code. En général, si vous devez rendre du code, celui-ci est rendu dans un fichier séparé. Vous pouvez faire référence à ce fichier voir si c'est vraiment nécessaire copier coller un petit extrait (quelques lignes).

Méthodologie¶

• Vous devez en séance prendre des notes et collecter le matériel nécessaire à la rédaction du rapport, mais surtout pas rédiger (sauf cas particulier du rapport demandé en fin de séance).
• La rédaction est un exercice en tant que tel, qui demande une prise de recul sur le travail effectué.
• Tous les auteurs mentionnés sont collectivement impliqués dans la qualité du document produit. Il est essentiel que le document soit relu, si possible plusieurs fois, par tous les auteurs.
• Vous pouvez pour vous aider ajouter un numéro de version à votre document, ce qui permet de suivre son évolution au grès des relectures.
• Vous pouvez utiliser word, latex, markdown, n'importe quoi, pourvu que vous produisiez un pdf pouvant être qualifié de document de qualité.

L'évaluation¶

Le professeur qui évaluera votre rapport va l'évaluer au milieu de 12 à 24, voir 48 (ou même 62 pour les filières à trois groupes) autres rapports. Un rapport de qualité sur la forme va vous distinguer très nettement et vous apporter une évaluation bien plus souple qu'un rapport qui, même s'il contient "les bonnes réponses" est bâclé, bourré de fautes d'orthographe, n'a pas de consistence entre deux réponses consécutives (une bien rédigée, la suivant avec des mots qui manquent, la troisième en français "oral").

Vous êtes élèves ingénieur et on attend également de vous une certaine rigueur technique. Les concepts techniques mentionnés doivent être manipulés correctement. Il ne faut pas insérer un mot compliqué parce qu'il semble "faire bien" à cet endroit si vous ne maîtrisez pas son sens. Cela décrédibilise complètement votre réponse, au lieu de l'appuyer.

L'évaluateur va chercher à savoir si vous avez compris, mais aussi si vous avez cherché, quelle a été votre démarche. Il est souvent plus intéressé par cette démarche que par la réponse en tant que telle. En TP vous pratiquez une manipulation, il faut en expliquer le but, la mise en oeuvre, le résultat attendu puis le résultat obtenu. Et enfin conclure.

Conclusion¶

Le rapport de TP doit être un document de qualité que l'on peut transmettre à un tiers n'ayant pas participé à la séance, permettant de comprendre ce qui était demandé, dans quel but, ce qui a été effectivement fait, quels ont été les résultats obtenus, ce qu'ils permettent de conclure ou de ne pas conclure. Il peut/doit expliciter les difficultés rencontrées et les processus mis en oeuvre pour tenter de les surmonter (avec ou sans succès).