Comment rediger un compte rendu

Disponible uniquement sur Etudier
  • Pages : 5 (1140 mots )
  • Téléchargement(s) : 0
  • Publié le : 5 novembre 2010
Lire le document complet
Aperçu du document
Comment rédiger 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 compréhension du code pour le correcteur
– à expliquer et justier la démarche suivie lors de l'implémentation
– à mettre en valeur votre travail
1 Le fond
Ce document sera lu avant de parcourir le code, il doit donc comporter uneanalyse du problème,
une conception détaillée de la solution, puis une explication de la réalisation, une description des tests
effectués et enn un retour sur expérience.
analyse du problème Le rapport comportera une introduction rapide au problème mais il est inutile
de rappeler longuement le sujet, une ou deux phrases sufsent en général. Dans l'analyse du problème,
vous précisez votreinterprétation de certains points qui vous ont semblé ous dans le sujet. Vous compl
étez le cahier des charges de manière à ce que la solution que vous recherchez soit complètement
spéciée.
conception de la solution Il faut amener progressivement le lecteur à comprendre la solution que vous
proposez. Pour cela vous êtes amenés à proposer un découpage du problème en sous-problèmes et à
proposer dessolutions pour résoudre ces sous-problèmes. Ces solutions peuvent être des algorithmes
mais aussi des structures de données ou des choix pour restreindre l'espace des conditions d'utilisation.
Pensez aussi à relier les sous-problèmes entre eux : comment les résultats d'un sous-problème sont
utilisés par un autre sous-problème. Un schéma est souvent utile à ce niveau (il existe des approchesplus formelles, UML par exemple, lorsque l'on aborde des problèmes plus gros).
Chaque algorithme, doit être décrit précisément et justié : quels auraient été les autres choix possibles
? quels sont les avantages et les inconvénients d'un tel choix ? Quel est la complexité (en temps,
en mémoire) ? Quels sont les impacts sur la fonctionnalité nale (par rapport, par exemple au cahier
des chargescomplété) ?
Cette partie ne doit pas contenir de code, elle doit pouvoir être utilisée pour une réalisation dans
un autre langage impératif. Vous aurez ici à mentionner les structures de données mais en restant au
niveau logique : les listes, les piles, les tableaux, tables de hachage etc... sans détailler la manière dont
seront implémentées ces structures de données.
Le plus important estque le texte se lise bien, l'enchaînement logique des idées amenant naturellement
à la compréhension de la solution. C'est une décomposition top-down, c'est à dire que l'on part du
problème global que l'on décompose et on décrit ensuite les solutions pour chacun des sous-problèmes.
Réalisation Le rapport doit comporter les listing complets du code, mais en annexe (ils ne comptent
pas dans lenombre de pages). Cette partie doit expliquer l'implémentation de la solution que vous
avez proposée, structures de données détaillées, implémentation des algorithmes, éventuellement rôle
de certaines variables clés, etc. La décomposition en fonctions doit se rapprocher de la décomposition
proposée dans la partie conception. Là encore les choix doivent être justiés, éventuellement en relatantdes problèmes apparus avec d'autre choix.
1
Test C'est une phase importante du développement, plus vous testerez votre implémentation plus le
lecteur sera convaincu de sa validité. Indiquez précisément quelles fonctionnalités sont testées, quelle
est l'infrastructure de test utilisée (mise en place de test automatique dans le makefile ou tests à la
main). Il est, en général, assez précieux depouvoir ré-exécuter tous les tests de manière à vérier la
compatibilité du code au cours de l'évolution du logiciel. Plus cette phase de test est prévue tôt dans le
processus, plus elle sera efcace.
Retour d'expérience Évitez les généralités du style “nous avons beaucoup appris lors de la réalisation
de ce TP”... Mentionnez éventuellement les problèmes rencontrés. Un bilan des efforts...
tracking img