Les documents à fournir

Dificulté:

Les documents de votre projet

Il est nécessaire de créer un certain nombre de documents pendant le développement de votre projet. Il n’y a pas de liste « officielle » des documents qui doivent accompagner votre projet. Je présente ci-dessous une liste non-exhaustive de documents. Elle peut quasiment être infinie.

Vous devez rassembler tous les documents dans un répertoire accessible depuis internet. Vous indiquerez le chemin dans la partie « Modalités d’accès à la documentation des productions ».

Ce répertoire peut contenir :

  • Un répertoire contenant la description du contexte de la Maison des Ligues. Il suffit de reprendre les documents sur le site du Certa La Maison des Ligues et d’ajouter le plan de votre schéma réseau.
  • Le cahier des charges (c’est un grand mot). Vous pouvez vous inspirer du projet de gestion d'association sur ce site.
  • Les spécifications fonctionnelles de votre application (voir ci-dessous)
  • Les spécifications techniques de votre application (voir ci-dessous)

Dans la partie « Modalités d’accès aux productions » :

Ajouter le code source de votre application, vous pouvez ajouter un lien vers GitHub.


Les documents sont quasiment les mêmes pour la partie Web et Desktop.

Les spécifications fonctionnelles

Créer un document traduisant le cahier des charges en spécification à l’aide de schéma d’écrans et de use-case (détailler les cas les plus fréquents).

Les spécifications techniques

Montrer tous les outils que vous avez utilisé (langage, éditeur, bdd…). Vous pouvez expliquer vos choix (pourquoi ne pas utiliser un framework, une architecture MVC, la programmation objet).

Partie BDD :

Schéma entité-association (JMerise…), schéma relationnel (MySQLWorkbench…).

Partie code :

Norme de développement. Faire un lien avec le document. Vous pouvez reprendre celui présent dans GSB sur le site du Certa (répertoire application frais) et le renommer avec votre contexte. Il est difficile de trouver des spécifications de développement très simple pour tous les langages. Elles sont souvent très complexes.

Les diagrammes UML : vous pouvez ajouter des diagrammes de classe, de séquences, d'états-transitions... On peut utiliser ArgoUML pour réaliser les schémas.

Tests unitaires : Décrire les outils utilisés. (Visual Studio, PHPUnit, JUnit…)

Revue de code : Ajouter les documents qui vous ont servi lors de vos revues de code.

Gestion des bugs : décrire le logiciel utilisé (Mantis Bug Tracker, GLPI…). On peut aussi décrire le workflow.

Gestion de version : décrire le logiciel utilisé (Git , GitHub, Team Foundation Server) et l'architecture de vos branches.

Les tests

Tests fonctionnels : joindre quelques tests. Vous pouvez créer un document à part.

Les tests peuvent être des tests manuels (plus simples) mais ils peuvent aussi être automatisés avec des outils comme Selenium ou Visual Studio par exemple.

Planning

Joindre un diagramme de Gantt. Vous pouvez le faire avec un logiciel de dessin.

Si vous voulez bien faire la quantité de travail est monstrueuse. Faites quand même attention à bien nommer les documents et à les regrouper pour éviter d'avoir 50 jpg dans votre répertoire. Que va-t-on trouver dans le répertoire d’un élève moyen : quelques copies d’écran de l’application, un schéma entité-association et peut-être un diagramme de classes. C’est tout et cela suffit la plupart du temps pour avoir le BTS !