Come fare un documento di progettazione per il software

October 30

Come fare un documento di progettazione per il software


documenti di progettazione del software sono di diversi tipi, ma quasi tutti condividono l'obiettivo comune di descrivere software funzioni, dati o interfacce. documenti di progettazione vanno da documenti architettonici di alto livello per i documenti di progettazione dettagliata, documenti di controllo di interfaccia e documenti diagramma di flusso. Alcuni documenti di progettazione sono in forma libera, mentre altri seguono un approccio più formale, come la Unified Modeling Language (UML).

istruzione

1 Determinare quale livello il documento di progettazione coprirà. Ad esempio, se si sta facendo un documento di controllo dell'interfaccia tra il software e un altro componente di sistema o software, quindi avrete bisogno di un documento di progettazione a basso livello che includerà dettagli dell'interfaccia. D'altra parte, se si sta lavorando su un nuovo design, quindi potrebbe essere necessario un documento di progettazione come ad esempio un documento di progettazione architettonica che mostra il software ad un alto livello di astrazione.

2 Determinare quali informazioni da includere. Le informazioni da includere dipenderà dal tipo di documento di progetto che si sta redazione e stuzzicare livello di dettaglio necessario. Ad esempio, in un documento di controllo dell'interfaccia, è necessario includere informazioni quali la descrizione dei dati che saranno trasferiti attraverso l'interfaccia, come le richieste sono fatte e come tali richieste vengono esaudite. Si può anche includere altre informazioni, ad esempio come verranno trattati futura espansione o modifiche e come vengono gestiti gli errori.

3 Progetto di una struttura del documento. Una volta che sai quali informazioni ti verrà compreso, è possibile redigere una descrizione dei documenti di progettazione. Il contorno servirà come quadro di riferimento per la scrittura del documento di progettazione. Una volta ottenuto il profilo, controllare il contorno contro il livello di dettaglio e le informazioni che ha deciso di includere per accertarsi che il documento coprirà quello che si prevede di coprire.

4 Aggiungere le informazioni di progettazione per il tuo profilo. Utilizzando il profilo creato nel passaggio precedente, iniziare compilando i dettagli del documento di progettazione. Nell'esempio documento di controllo dell'interfaccia, è possibile identificare le cose come gli elementi di dati specifici che vengono scambiati in una particolare struttura di dati o la tempistica degli scambi di dati. Si dovrebbe scrivere il documento di progettazione ad un livello di dettaglio che trasmette completamente le informazioni necessarie per comprendere il progetto a livello appropriato.

5 Aggiorna il tuo documento di progettazione come le cose cambiano. progetti software in genere si evolvono come un progetto avanza. Assicurati di rivedere il documento di progettazione e tenerlo up-to-date con il vostro disegno corrente in modo che quando il progetto è completo, il documento di design riflette con precisione il disegno completato e può essere utilizzato da altri in futuro per attività di manutenzione o modifica.

Consigli e avvertenze

  • Nel redigere un documento di progettazione software tenere a mente lo scopo del documento e su come verrà utilizzato.
  • Una volta che hai finito il tuo documento di progettazione, fare un "controllo di integrità" di oggettivamente valutando se una persona ha familiarità con il software sarebbe in grado di comprendere le informazioni necessarie semplicemente dalla lettura del documento di progettazione.

Articoli Correlati