Note sul progetto

• Analisi e Specifica dei Requisiti: descrive il dominio applicativo in cui il software deve collocarsi e le funzioni principali che quest’ultimo dovrà avere.
• Progetto del Sistema: descrive la struttura del software in termini dei suoi componenti principali (sottosistemi e classi). Fornisce inoltre una descrizione della dinamica di funzionamento del sistema.
• Definizione dei casi di test: descrive gli input con cui si andrà a verificare il funzionamento del sistema e gli output che ci si aspetta di ottenere. Può contenere la descrizione delle classi JUnit utilizzate per il testing.
• Manuale di istallazione ed uso: descrive i passi da compiere per istallare ed utilizzare il sistema software.
• Rapporto sull’esecuzione dei casi di test: descrive l’esecuzione dei casi di test evidenziando i casi in cui il test ha rilevato un fallimento del sistema.

Struttura della documentazione: parti comuni a tutti i documenti

• Una pagina di intestazione con le seguenti informazioni: titolo del progetto, nomi degli autori, riferimento al corso per il quale viene prodotto il progetto.
• Un indice delle sezioni seguenti.

Analisi e Specifica dei Requisiti

• Una descrizione generale del problema da affrontare (in linguaggio naturale).
• Un glossario dei termini utilizzati: per ogni termine si definirà il corrispondente significato (in linguaggio naturale).
• Una definizione degli attori del sistema.
• Le ipotesi di base
• Una descrizione dei casi d’uso del sistema (la struttura di questa parte verrà descritta in dettaglio più avanti).
• Un diagramma delle classi che definisce gli elementi principali del dominio del problema e le relazioni tra questi elementi.

Casi d’uso

• Nome del caso d’uso
• Pre-condizioni che devono essere verificare all’inizio del caso d’uso (in genere sono legate allo stato iniziale del sistema e/o del dominio applicativo)
• Flusso di azioni normale
• Flusso di azioni eccezionale (non obbligatorio)
• Post-condizioni: stato del dominio applicativo e del sistema al termine del caso d’uso.

Progetto del sistema

• Una descrizione dell’architettura del sistema in termini dei suoi componenti e delle relazioni tra questi. Questa descrizione potrà essere fornita in termini di component diagram o class diagram. Il livello di granularità di queste rappresentazioni dipende dalla complessità del progetto. È opportuno descrivere l’architettura del sistema a vari livelli di astrazione, fino ad arrivare al livello delle classi che verranno effettivamente sviluppate.
• Una descrizione della dinamica di funzionamento del sistema. Questa potrà essere ottenuta mediante sequenze diagram definiti in modo coerente con la definizione dei component/class diagram.

Definizione dei casi di test

• Obiettivi
• Criteri
• Ambienti utilizzati per il test
• Descrizione dei casi di test. Per ogni caso di test si indicherà:
  • Nome
  • Scopo
  • Input
  • Output atteso

Manuale di istallazione ed uso

• Istallazione che conterrà:
  • Prerequisiti hardware e software
  • Descrizione del contenuto del pacchetto da istallare
  • Istruzioni per l’istallazione
• Uso che conterrà:
  • Passi per l’esecuzione del sistema
  • Descrizione delle operazioni da compiere per l’esecuzione delle funzioni offerte dal sistema

Rapporto sull’esecuzione dei casi di test