Come distinguere tra la documentazione del programma e documentazione del sistema

December 27

Come distinguere tra la documentazione del programma e documentazione del sistema


I sistemi informatici e programmi sono dotati di un sacco di documentazione. La complessità di come i dati vengono elaborati e passato intorno sono molto difficile dedurre dalla lettura del codice stesso. La documentazione dovrebbe essere scritto al livello appropriato, per descrivere un processo discreto che ha confini intorno ad esso. Questo può essere un programma, o può essere un sistema, che rinvia ai documenti individuali per ciascun programma. Un documento deve essere completo per il compito che ha lo scopo di realizzare, e non vagare troppo lontano in altre aree che possono essere collegati, ma sono meglio descritto altrove.

istruzione

1 Comprendere la differenza tra un sistema e un programma. Un programma è un eseguibile indipendente in un computer, che può essere parte di un sistema più grande. E 'significa fare un compito particolare. Un sistema è un insieme di programmi progettati per automatizzare un processo. Un sistema di inventario copre tutti gli aspetti di tenere traccia degli elementi di un business produce o possiede. Si può avere un programma di inventario in cui gli articoli sono elencati o aggiunti, che comunica con un programma di ordinamento, programma di vendita, o di un programma di gestione del cliente.

2 Esaminare la descrizione delle interfacce. Se i colloqui di documentazione circa un programma di invio dei dati verso i vari altri sistemi o tirando i dati in, allora è documentazione del programma. Se i colloqui documentazione su come i dati scorre attraverso numerosi programmi e come l'integrità dei dati viene gestito attraverso questi programmi, è la documentazione del sistema.

3 La documentazione casi d'uso. Un caso d'uso descrive un particolare compito che viene eseguita con o da un programma o sistema. Se il caso d'uso coinvolge più programmi differenti o si muove attraverso più persone diverse, è generalmente per un sistema. Se si descrive un processo più piccolo in un singolo programma, o viene eseguita da una sola persona, è per un programma.

4 La documentazione dei dati. Questo può essere diagrammi entità-relazione o flussi di dati. Se gli schemi di dati comprendono più database, o sembrano coprire più oggetti di business, come l'inventario, le vendite e la gestione dei clienti, allora è probabilmente per un sistema. Se è per un singolo tale entità, allora è probabilmente un programma.

Consigli e avvertenze

  • Non vi è alcun taglio e il metodo essiccato di distinguere tra un sistema e un programma. Si è tanto una questione di opinione e l'uso di parole come regola duro.