ESSI1- Notice de rendu des projets
Auteur: Paul Franchi
Version: 1.0
Date: 2/11/2001
Introduction
Cette notice constitue une première étape vers un cadre
définissant pour la première année de l'ESSI, les
standards en matière de rendu des projets de programmation.
Contenu du rendu
Le projet est rendu sous la forme d'un fichier archive .tar ou .jar
dans votre répertoire sous /net4/essi1/projet/ comprenant
des fichiers source *.java, les codes *.class correspondants,
une hierarchie html javadoc et un ficher "melire" ("readme")
-
Pour chaque fichier source *.java
-
Infos générales (entêtes des codes):Titre, Date, Auteur(s),
Version, etc
-
Infos locales (sur le code): PréConditions et PostRelations, Commentaires
de lecture, etc.
-
Preuve
-
Terminaison
-
Complexité
-
Documentation générée par javadoc
-
entêtes des classes et méthodes
-
commentaires de spécifications
-
PréConditions et PostRelations
-
Complexité
-
fichier "melire" (éventuellement en plusieurs parties
via des liens html)
-
Aide à l'utilisation
-
installation, configuration, compilation
-
utilisation (dialogue, menus, exemples, etc.)
-
démonstrations
-
Bugs connus
-
etc.
-
Notes sur la conception
-
Principe algorithmique
-
Evaluation des fonctionnalités et des performances
-
Références biblio
-
etc.
-
Gestion du projet
-
équipe
-
planning prévu: qui, quoi, quand ?
-
journal de bord: tâches effectuées et durées (dates)
-
évaluation du déroulement