Présentation des documents
Les documents ayant servi à la conception du projet Sokrate suivent, pour la plupart, les normes de génie logiciel de l'IEEE. Pour une idée globale du projet, nous suggérons d'abord la consultation du plan de gestion du projet logiciel, des spécifications orientées client ainsi que de l'architecture interne du logiciel.
Documents reliés au processus de gestion et de conception
Plan de gestion du projet logiciel (PGPL)
Ce document présente notre processus organisationnel : la structure de l'équipe, l'échéancier du projet, le mécanisme de gestion des risques, le budget, etc… Il donne un portrait global de notre mécanisme de gestion de projets.
Plan de gestion de la configuration (PGCL)
Ce document présente le mécanisme de gestion des sources, soit les procédures de partage et de sauvegarde de la base de code.
Plan d'assurance Qualité du projet logiciel (PAQL)
Ce document spécifie les normes de qualité et les standards que l'équipe Sokrate s'est fixés.
Plan de vérification et de validation du projet logiciel (PVVL)
Ce document, qui est en quelque sorte une annexe au plan d'assurance Qualité, énonce les procédures permettant de s'assurer que le projet est bien fait (vérification) et correspond bien aux spécifications (validation).
Documents de conception
Spécifications externes du logiciel, côté client (SELC)
Ce document trace le portrait global de notre application et de son fonctionnement. Il est destiné à un client éventuel qui pourrait ainsi valider que le produit correspond bien à ses attentes.
Spécifications externes du logiciel, côté développeur (SELD)
Comme son nom l'indique, ce document de spécifications est plutôt destiné à l'équipe de développement du produit qui peuvent ainsi avoir une image claire du but à atteindre. Chaque fonctionnalité du logiciel est décrite avec précision de façon à éviter toute confusion.
Spécification interne du logiciel, l'architecture (SILA)
Ce document présente l'architecture haut niveau de notre projet. On y retrouve une description des classes principales qui composent notre application ainsi que les relations qui les relient.
Spécification interne du logiciel, conception détaillée (SILD)
Ce document consiste en quelque sorte en un plan détaillé de notre logiciel. Il spécifie précisément les interfaces de chacune des classes, les algorithmes utilisés, les diagrammes de séquences illustrant les cas typiques d'utilisation du logiciel. C'est ce document qui nous a guidé tout au long de l'étape de codage de notre application.
Document de test logiciel
Ce document présente nos procédures de test et leurs résultats.
Manuel utilisateur
Ce document indique aux utilisateurs comment faire fonctionner le logiciel. Il s'adresse autant aux jeunes utilisateurs du jeu qu'aux personnes qui les encadrent.