Comment rdiger un compte rendu de TP

dpt Telecom, Tanguy Risset et les enseignants AGP/SDE

Un compte rendu de TP est un document destin : faciliter la comprhension du code pour le correcteur expliquer et justier la dmarche suivie lors de limplmentation mettre en valeur votre travail

1 Le fond
Ce document sera lu avant de parcourir le code, il doit donc comporter une analyse du problme, une conception dtaille de la solution, puis une explication de la ralisation, une description des tests effectus et enn un retour sur exprience. analyse du problme Le rapport comportera une introduction rapide au problme mais il est inutile de rappeler longuement le sujet, une ou deux phrases sufsent en gnral. Dans lanalyse du problme, vous prcisez votre interprtation de certains points qui vous ont sembl ous dans le sujet. Vous compltez le cahier des charges de manire ce que la solution que vous recherchez soit compltement spcie. conception de la solution Il faut amener progressivement le lecteur comprendre la solution que vous proposez. Pour cela vous tes amens proposer un dcoupage du problme en sous-problmes et proposer des solutions pour rsoudre ces sous-problmes. Ces solutions peuvent tre des algorithmes mais aussi des structures de donnes ou des choix pour restreindre lespace des conditions dutilisation. Pensez aussi relier les sous-problmes entre eux : comment les rsultats dun sous-problme sont utiliss par un autre sous-problme. Un schma est souvent utile ce niveau (il existe des approches plus formelles, UML par exemple, lorsque lon aborde des problmes plus gros). Chaque algorithme, doit tre dcrit prcisment et justi : quels auraient t les autres choix possibles ? quels sont les avantages et les inconvnients dun tel choix ? Quel est la complexit (en temps, en mmoire) ? Quels sont les impacts sur la fonctionnalit nale (par rapport, par exemple au cahier des charges complt) ? Cette partie ne doit pas contenir de code, elle doit pouvoir tre utilise pour une ralisation dans un autre langage impratif. Vous aurez ici mentionner les structures de donnes mais en restant au niveau logique : les listes, les piles, les tableaux, tables de hachage etc... sans dtailler la manire dont seront implmentes ces structures de donnes. Le plus important est que le texte se lise bien, lenchanement logique des ides amenant naturellement la comprhension de la solution. Cest une dcomposition top-down, cest dire que lon part du problme global que lon dcompose et on dcrit ensuite les solutions pour chacun des sous-problmes. Ralisation Le rapport doit comporter les listing complets du code, mais en annexe (ils ne comptent pas dans le nombre de pages). Cette partie doit expliquer limplmentation de la solution que vous avez propose, structures de donnes dtailles, implmentation des algorithmes, ventuellement rle de certaines variables cls, etc. La dcomposition en fonctions doit se rapprocher de la dcomposition propose dans la partie conception. L encore les choix doivent tre justis, ventuellement en relatant des problmes apparus avec dautre choix.

Test Cest une phase importante du dveloppement, plus vous testerez votre implmentation plus le lecteur sera convaincu de sa validit. Indiquez prcisment quelles fonctionnalits sont testes, quelle est linfrastructure de test utilise (mise en place de test automatique dans le makefile ou tests la main). Il est, en gnral, assez prcieux de pouvoir r-excuter tous les tests de manire vrier la compatibilit du code au cours de lvolution du logiciel. Plus cette phase de test est prvue tt dans le processus, plus elle sera efcace. Retour dexprience vitez les gnralits du style nous avons beaucoup appris lors de la ralisation de ce TP... Mentionnez ventuellement les problmes rencontrs. Un bilan des efforts fournis (en terme de temps pass la conception, la ralisation et la rdaction ou mme en terme de recherche dinformations) doit galement vous permettre de situer le rapport effort/retour et dvaluer le cot de ce projet. Cest une tude critique de votre travail, plus elle est perspicace, plus le lecteur est convaincu que vous avez compris les problmes.

2 La forme
La taille des diffrentes sections mentionnes ci-dessus dpendra videmment du nombre de pages du document. En gnral un nombre de pages maximum est indiqu, il ne faut pas le dpasser. Il ny a pas obligation de faire autant de page, mais en gnral lorsquon demande au plus 5 pages, il est assez mal vu de rendre un compte-rendu de 2 pages. Pour cela il est important de prvoir prcisment lavance le plan dtaill de votre document an que vous puissiez inclure toutes les informations importantes, les informations secondaires ntant rajoutes quaprs, selon la place disponible. Page de garde Noubliez rien : titre TP, nom des tudiants (bien visibles), groupe, matire, dpartement, date, puis le plan du document. Quelques remarques sur la forme Pensez faire des phrases compltes (plus facile lire que les listes ditem, donc pas comme ici justement...). Organisez votre texte en paragraphes de plusieurs lignes. videmment, une grammaire et une orthographe correctes sont fondamentales, sans elles le lecteur ne peux pas se concentrer sur le fond. Lutilisation de gures facilite souvent la comprhension et are le document. Une gure doit comporter une lgende qui permet au lecteur de la comprendre sans quil ait obligatoirement lu le texte associ (de manire gnrale, ayez lesprit que beaucoup de documents que vous rdigerez seront seulement parcourus rapidement). Une gure doit normalement tre rfrence depuis le texte. Utiliser une fonte diffrente (courrier par exemple) pour le code. viter lutilisation du gras, prfrez litalique pour mettre en avant un mot. En ce qui concerne le code, une bonne indentation est indispensable. Les commentaires sont bons si ils aident effectivement mieux comprendre le code (et ne se contente pas de paraphraser le code). Pour aller plus loin, il existe des rgles de typographie trs prcises en Franais, qui sont respectes par exemple dans les journaux quotidiens. Jacques Andr a crit un document assez court recensant les principales erreurs commises (petites leons de typographie disponible sur http://jacques-andre.fr/faqtypo/lessons.pdf), je vous conseille fortement ce document dont lutilit ira bien au del des compte-rendus de TP.

3 Conclusion
Les conseils ci-dessus nont aucun caractre obligatoire, mais ils sont en gnral respects dans les bon rapports. Ils ne sufsent pas non plus faire un bon rapport. La qualit essentielle dun bon rapport est quil se lise naturellement et quil explique de manire claire les difcults de comprhension du code.