Come scrivere un documento di progettazione del software

September 23

Come scrivere un documento di progettazione del software


Un documento di progettazione del software è il "come" della documentazione del software del ciclo di vita. Si descrive come dovrebbero essere attuate i requisiti software e dà ai programmatori un modello da seguire.

Il documento di progettazione del software è un contratto scritto tra voi, il vostro team, il responsabile del progetto e il vostro cliente. Quando si documentare le ipotesi, le decisioni e rischi, dà i membri del team e ai soggetti interessati l'opportunità di essere d'accordo o per chiedere chiarimenti e modifiche. Una volta che il documento di progettazione software è approvato dalle parti appropriate, diventa un punto di riferimento per limitare variazioni del perimetro del progetto.

istruzione

1 Indagare il documento formattazione / modello utilizzato nel documento requisiti software. Questo include frontespizio, la pagina formato di numerazione, numeri di sezione e cronologia delle revisioni. Utilizzare lo stesso o simile formato di documento per il documento progettazione del software.

2 Incorporare alcuni, se non tutti, dei seguenti elementi:

sintesi di alto livello

Definizioni di eventuali simboli, forme, acronimi e termini unici non standard nel documento

Come sarà raggiunto ogni esigenza

ipotesi

vincoli

analisi dei rischi Software

procedure di sviluppo e le linee guida di codifica

linguaggi e strumenti standard

Le definizioni di variabili e una descrizione di dove vengono utilizzati

struttura logica e fasi di lavorazione logici

Errore, di allarme e messaggi di avviso

Misure di sicurezza

Prestazione

affidabilità

3 Considerare come strutturare il documento di progettazione. Ciò è particolarmente importante quando si sta progettando un grande sistema, complesso. Rompere il sistema in parti logiche e utilizzare queste parti, come le intestazioni di sezione nel documento progettazione del software. Se il sistema è molto grande, creare documenti di progettazione multipli, ciascuno conoscere di una particolare parte del sistema.

4 Dare ad ogni elemento di design un identificatore univoco. Ciò permetterà di risalire al requisito applicabile e, infine, alla sperimentazione applicabile.

5 Include sufficiente dettaglio per i programmatori, pur incorporando alcuni riepiloghi di alto livello per i gestori.

6 Sviluppare prototipi. Se è possibile includere alcune schermate o codice di esempio nel documento di progetto, ciò contribuirà a trasmettere l'intento progettuale. prototipi in via di sviluppo dovrebbero anche diminuire il tempo che verrà speso codifica.