DEVANÇANT LES NOMBREUSES PRESSIONS POPULAIRES, VOICI LES ...
Sections utiles dans un rapport
- Description et utilisation de vos fonctions Il s'agit de donner une
description générale de votre programme du point de vue
comportement externe (i.e. ce que l'usager de votre programme doit
savoir pour l'utiliser). Par exemple, format de l'entrée, de la sortie,
liste des commandes possibles avec une description succincte, tâche
effectuée par le programme, etc... Pour les fonctions, c'est la
même chose sauf que l'usager correspond maintenant au programmeur qui
doit utiliser vos fonctions. On devrait donc y retrouver une description de la
tâche effectuée par chaque fonction qu'on y retrouve. Ne pas
oublier qu'ici on doit rester général (i.e. on ne décrit
pas comment les outils fournis fonctionnent mais plutôt comment les
utiliser).
- Structure(s) de données employée(s) et
justification. Vous décrivez la ou les structure(s) de
données que vous avez utilisée(s). Si d'autres choix auraient pu
être envisagés, il faut justifier les vôtres! Si une
structure simple aurait suffit, expliquer les avantages de votre approche.
- Algorithme(s) + justifications. Il s'agit de décrire
l'algorithme que vous avez utilisé ou du moins ses parties les plus
significatives. Lorsque plus d'une solution aurait pu être
envisagée, il faut justifier vos choix personnels. Ne pas
expliquer chaque ligne de votre code. Laissez tomber les détails
d'implantation à moins qu'ils ne soient vraiment importants.
- Discussion : Commentaires d'ordre général (vos bons
coups, etc...).
- Améliorations possibles de votre programme, vos fonctions,
représentations de structures, algorithme (i.e. qu'est-ce qu'on aurait
pu faire et, si possible, comment en termes généraux). Limites de
votre programme ! (Ne marche pas dans tel cas, etc).
Attention à la qualité de votre langue ! (Au moins
relisez-vous). Faites attention à la structure de vos phrases, pas
seulement aux erreurs lexicales !
Clarté des explications. Propreté et profitez des
possibilités de l'ordinateur pour faire une belle
présentation.
L'humour est bienvenu (tant qu'il reste décent) mais c'est
réellement facultatif (l'humour, pas la décence !).
Pas du tout facultatif : justesse des explications.
Un rapport ne doit jamais être mis comme commentaire
d'entête de programme (c'est une entité
séparée). Vous n'êtes pas obligé de faire un rapport
d'un million de pages ! Utilisez votre jugement sur ce qui est important et le
lecteur en fera autant ! N'oubliez pas aussi qu'une image peut valoir mille
mots...