Contenuto Richiesto dei Documenti di Progetto

Informazioni preliminari, soggette a variazioni

Ultimo aggiornamento: 30 ottobre 2005 (16:20)

Lista dei Documenti

• Elementi generali

• Analisi dei Requisiti (AR)

• Piano di Qualifica (PQ)

• Specifica Tecnica (ST)

• Definizione del Prodotto (DP)

• Manuale Utente (MU)

Elementi Generali

Ciascun documento dovrà includere:

• Sommario
  Succinta descrizione del contenuto del documento

• Indice

• Stato del documento

  • Preliminare (solo a scopo informativo)

  • Formale (soggetto a revisione)

  • Ad uso Interno

  • Ad uso Esterno

• Lista di Distribuzione

• Registro delle modifiche (in ordine di inverso versione, dalla più recente alla più antica)

  • Data della modifica

  • Ragione delle modifica

  • Natura della modifica

Analisi dei Requisiti (AR)

1. Introduzione

   1. Scopo del documento

   2. Scopo del prodotto

   3. Glossario

      • Definizioni

      • Acronimi

      • Abbreviazioni

   4. Riferimenti

      • Normativi

      • Informativi

2. Descrizione generale

   1. Contesto d'uso del prodotto

      • Processi produttivi e protocolli d'ambiente coinvolti

      • Piattaforma d'esecuzione ed interfacciamento con strumenti esterni

   2. Funzioni del prodotto

   3. Caratteristiche degli utenti

   4. Vincoli generali

   5. Assunzioni e dipendenze

3. Glossario

4. Lista dei requisiti

   1. Requisiti funzionali

   2. Requisiti di qualità

   3. Requisiti di interfacciamento

      • Con la piattaforma di esecuzione

      • Con i processi produttivi ed i protocolli dell'ambiente d'uso

      • Con l'operatore

5. Appendici

Piano di Qualifica (PQ)

1. Introduzione

   1. Scopo del documento

   2. Scopo del prodotto

   3. Glossario

      • Definizioni

      • Acronimi

      • Abbreviazioni

   4. Riferimenti

      • Normativi

      • Informativi

2. Visione generale della strategia di verifica

   1. Organizzazione, pianificazione strategica e temporale, responsabilità

   2. Risorse necessarie, risorse disponibili

   3. Strumenti, tecniche, metodi

3. Gestione amministrativa della revisione

   1. Comunicazione e risoluzione di anomalie

   2. Trattamento delle discrepanze

   3. Procedure di controllo di qualità di processo

4. Resoconto delle attività di verifica

   1. Tracciamento componenti - requisiti

   2. Dettaglio delle verifiche tramite analisi

   3. Dettaglio delle verifiche tramite prove (test)

   4. Dettaglio dell'esito delle revisioni

5. Pianificazione ed esecuzione del collaudo

   1. Specifica della campagna di validazione (collaudo incluso)

   2. Dettaglio dell'esito della campagna di validazione

Specifica Tecnica (ST)

1. Introduzione

   1. Scopo del documento

   2. Scopo del prodotto

   3. Glossario

      • Definizioni

      • Acronimi

      • Abbreviazioni

   4. Riferimenti

      • Normativi

      • Informativi

2. Definizione del prodotto

   1. Metodo e formalismo di specifica

   2. Primo livello di decomposizione architetturale

3. Descrizione dei singoli componenti

   1. Tipo, obiettivo e funzione del componente

   2. Relazioni d'uso di altre componenti

   3. Interfacce e relazioni di uso da altre componenti

   4. Attività svolte e dati trattati

4. Stime di fattibilità e di bisogno di risorse

5. Tracciamento della relazione componenti - requisiti

Definizione del Prodotto (DP)

Parte 1 - Descrizione generale

1. Introduzione

   1. Scopo del documento

   2. Scopo del prodotto

   3. Glossario

      • Definizioni

      • Acronimi

      • Abbreviazioni

   4. Riferimenti

      • Normativi

      • Informativi

2. Standard di progetto

   1. Standard di progettazione architetturale

   2. Standard di documentazione del codice

   3. Standard di denominazione di entità e relazioni

   4. Standard di programmazione

   5. Strumenti di lavoro

Parte 2 - Specifica delle componenti

1. Raffinamento di §3 di ST al livello di progettazione di dettaglio

Appendice

1. Codice sorgente

2. Tracciamento della relazione componenti - requisiti

Manuale Utente (MU)

1. Introduzione

   1. Definizione dell'utente del prodotto

   2. Come leggere il manuale

   3. Documenti utili

   4. Come riportare problemi e malfunzionamenti

2. Descrizione generale (a struttura libera)

3. Istruzioni per l'uso

   1. Descrizione funzionale

   2. Azioni richieste/permesse

   3. Errori probabili e cause possibili

4. Appendice

   1. Messaggi di errore e loro significato

   2. Glossario