Concevoir un programme

Pour concevoir un programme complet de A à Z, on ne se lance pas directement dans l'écriture du programme lui-même.

Cahier des charges

Il faut commencer par établir un cahier des charges, c'est-à-dire un cahier préparatoire à l'aide d'un papier et d'un crayon.

Ce cahier des charges permet de conserver les idées au fur et à mesure de la programmation sans les oublier parce qu'on a été distrait par autre chose.

Contenu

Un cahier des charges intermédiaire doit :

• rappeler le principe, les « règles », du programme à coder ;
• schématiser et illustrer le problème à l'aide de dessins et croquis ;
• indiquer les variables qui semblent nécessaires a priori (préciser leur nom, leur type, leur valeur initiale ou constante, ce qu'elles représentent, ...) ;
• préciser aussi les fonctions qui semblent indispensables a priori (leurs paramètres, leur docstring, les grandes lignes de leur fonctionnement, ...) en séparant bien les fonctions de calculs (qui renvoyent une valeur) des fonctions d'affichage (qui affichent une réponse dans la console) ;
• illustrer le comportement des objets (variables et fonctions) entre eux
• identifier les actions de l'utilisateur à prendre en compte ;
• élaborer les interactions avec l'utilisateur ;
• préparer la répartition du travail entre les membres du groupe et hiérachiser l'ordre du travail (quelle partie programmer en premier, en deuxième, etc...).

Exemple de cahier des charges

Un trésor est caché quelque part dans une des cases d'un plateau de jeu en deux dimensions. Le jeu doit se dérouler comme suit :

1. Le joueur indique dans quelle case il souhaite chercher.
2. S'il ne tombe pas sur la case contenant le trésor, le jeu lui indique dans quelle direction chercher (haut, bas, gauche, droite ou une combinaison de deux de ces directions, par exemple bas-droite).
3. Le joueur recommence jusqu'à tomber sur le trésor.
4. On termine en affichant le score qui correspond au nombre de propositions effectuées par le joueur.

En cliquant ici, vous pouvez télécharger un exemple de cahier des charges préparatoire (simplifié). Il manque des éléments, mais il peut servir de base de réflexion afin que vous produisiez votre propre cahier des charges.

Exemple d'évaluation de cahier des charges

Critères
Lisibilité / Soin / Orthographe
Analyse du problème à résoudre (c'est-à-dire à coder)
Représentation des données par des variables : - indication de ce que représentent ces variables - nom explicite - type cohérent - valeur initiale
Anticipation des fonctions : - description des paramètres, du type de ces paramètres - description de leur nature (calcul, affichage, effet de bord) - description de leur rôle, voire de leur fonctionnement
Prise en compte des actions de l'utilisateur / Interface
Répartition et hiérarchisation du travail au sein du binôme