|
| | Rapport technique
Cette description des rubriques du rapport technique est adapté de
celle pour INF2700. Vous pouvez vous en inspirer pour le rapport de
LOG2710. Toutefois, n'oubliez pas que le rapport doit être fait en Javadoc!
Description des éléments à traiter dans le rapport
Le rapport technique décrit la
mise en oeuvre des algorithmes utilisés pour satisfaire les requis. Il
comprend les rubriques suivantes:
Exposé du problème:
- Description du projet
- Démarche retenue
- Présentation du problème à résoudre, dans les mots de l'étudiant. Une
copie ou transcription du feuillet explicatif mérite 0 point.
- Mode d'utilisation du programme:
- Procédure de mise en oeuvre: texte descriptif destiné à un usager qui ne
connaît pas le programme.
- Les commandes qui permettent à l'usager d'interagir avec le programme.
- La liste et la forme des autres données, s'il y a lieu.
- Les résultats types auxquels on peut s'attendre.
- Structures de données:
- Description des structures de données: décrire de façon pertinente
chaque structure de données utilisée, la relation de chacune avec le système
de gestion des menus, et en particulier les variables les plus importantes
utilisées dans les fonction appelées lors de choix dans les menus.
- Structure du programme: pseudo-code ou diagramme de classe décrivant la
structure du programme en relation aux opérations qu'il effectue. Il faut
mettre en évidence ce qu'on veut faire plutôt que la façon de le faire.
On documentera aussi l'utilisation des listes d'affichage et des primitives
qu'elles contiennent.
- On a parlé de l'architecture MVC («model view controller») dans le cours. Vous devrez donc bien
identifier les composantes du modèle MVC en relation avec ce projet.
En particulier:
- le modèle de données: que modélise-t-on?
- les vues: les objets affichés, les représentations graphiques utilisées
l'interprétation des
résultats graphiques: que voit-on?
- les contrôles utilisées, comment se modifie le
modèle de données?
- ...
- Design, algorithmes et mise en oeuvre:
- On décrit l'algorithme, l'implantation et la mise en oeuvre de chacun
des requis
- Listage du programme et résultats:
- Le listage du programme sera fourni en annexe.
- Le programme doit être bien structuré, c'est-à-dire se composer de
modules ayant des fonctions bien précises, de longueur ne dépassant pas une
page ou deux.
- Le programme doit être bien commenté.
- Des décalages sont utilisés pour identifier la structure.
- La qualité des sorties graphiques et la facilité d'utilisation seront
notées.
- Discussion:
- Éléments de théorie pertinents
- Architecture MVC
- Efficacité des méthodes utilisées
- Difficultés particulières rencontrées
- Limites du programme
- Solutions adoptées
- Atteinte des objectifs
- Perspective:
- Améliorations possibles pouvant être apportées au programme
Au besoin, on peut donner en annexe, des figures, des diagrammes, des
exemples de code et le listage modulaire du programme. On soignera la
qualité du français dans les rapports et la correction en tiendra
compte.
|