Tipi di documentazione del software

Sommario:

Anonim

Se hai mai visto una directory di computer su un'unità di rete della tua azienda denominata "documenti software" o "guide software" e hai guardato i documenti che avevi il permesso di visualizzare, probabilmente hai realizzato che il numero di documenti e tipi di documenti per il software sono numerose. Sembrerebbe inoltre che alcuni documenti inseriti in una categoria si applichino anche ad altre categorie. I documenti software vengono utilizzati in ogni fase di un tipico ciclo di vita del software, quindi è un buon posto per indagare sul tipo di documenti creati.

Proposta

Una proposta software specifica i requisiti di sistema del software e delinea lo scopo del software e i problemi risolti. Specifica anche il tempo stimato del progetto software e altri fattori che influenzano la proposta.

Studio di fattibilità

Lo studio di fattibilità di solito ha luogo all'inizio del progetto. Questa fase determina se l'impianto software soddisfa le esigenze aziendali del cliente. Il risultato di uno studio di fattibilità decide se un progetto andrà avanti o meno.

Analisi dei requisiti

Un'analisi dei requisiti fornisce i mezzi per tradurre i requisiti aziendali in soluzioni software automatizzate. Solitamente un consulente esterno o una direzione aziendale svolge questo compito. I requisiti traducono i requisiti aziendali in specifiche effettive per hardware, software e componenti.

Documenti di design

I documenti di progettazione forniscono la base per lo sviluppo del software a livello tecnico. Come suggerisce il nome, prima di iniziare la codifica, verranno progettati numerosi progetti grafici e testuali per database, interfacce, comunicazioni, sviluppi web e altri aspetti del software.

Codifica dei documenti

I documenti di codifica si riferiscono al codice sorgente effettivo utilizzato per la programmazione del software. Il codice può essere scritto in qualsiasi numero di lingue disponibili per computer, inclusi Java, C ++, PHP e centinaia di altri linguaggi di programmazione, a seconda del sistema utilizzato.

Test dei documenti

I team di test e gli sviluppatori creano documenti di test in varie fasi del ciclo di vita del software. Gli sviluppatori creano documenti di test unitari per il proprio codice. Il team di test o altre persone non direttamente associate al codice intraprendono test di integrazione e test dei requisiti aziendali.

Guide per l'utente e marketing

Le guide per l'utente forniscono istruzioni su come funziona il nuovo software. Se il sistema è ampio e complesso, le guide per l'utente sono solitamente supportate da corsi di formazione per il personale. I documenti di marketing illustrano i vantaggi del nuovo sistema software ai potenziali clienti.

Licenze software

L'emissione di licenze software rende il software legale per quanto riguarda l'utente finale. Gli utenti utilizzano il software secondo i termini di una licenza software rilasciata dalla società di produzione. Non tutto il software ha termini di licenza rigidi, e questo è particolarmente vero nel caso dell'open source. In generale, i sistemi software dispongono di una qualche forma di documento di licenza che specifica come e dove può essere utilizzato il software.