Documentazione del programma

Viene chiamato qualsiasi testo scritto, illustrazione o video che descriva un software o un programma ai suoi utenti program or software document. L'utente può essere chiunque, da un programmatore, analista di sistema e amministratore all'utente finale. In varie fasi dello sviluppo è possibile creare più documenti per diversi utenti. Infatti,software documentation è un processo critico nel processo di sviluppo software complessivo.

Nella programmazione modulare la documentazione diventa ancora più importante perché diversi moduli del software sono sviluppati da diversi team. Se qualcun altro oltre al team di sviluppo vuole o ha bisogno di capire un modulo, una buona e dettagliata documentazione renderà il compito più facile.

Queste sono alcune linee guida per la creazione dei documenti:

  • La documentazione dovrebbe essere dal punto di vista del lettore

  • Il documento dovrebbe essere univoco

  • Non dovrebbero esserci ripetizioni

  • Dovrebbero essere utilizzati gli standard del settore

  • I documenti dovrebbero essere sempre aggiornati

  • Qualsiasi documento obsoleto dovrebbe essere eliminato gradualmente dopo la debita registrazione dell'eliminazione graduale

Vantaggi della documentazione

Questi sono alcuni dei vantaggi di fornire la documentazione del programma:

  • Tiene traccia di tutte le parti di un software o programma

  • La manutenzione è più facile

  • I programmatori diversi dallo sviluppatore possono comprendere tutti gli aspetti del software

  • Migliora la qualità complessiva del software

  • Aiuta nella formazione degli utenti

  • Assicura la decentralizzazione della conoscenza, riducendo i costi e gli sforzi se le persone lasciano il sistema all'improvviso

Documenti di esempio

Un software può avere molti tipi di documenti associati. Alcuni di quelli importanti includono:

  • User manual - Descrive le istruzioni e le procedure per gli utenti finali per utilizzare le diverse funzionalità del software.

  • Operational manual - Elenca e descrive tutte le operazioni in corso e le loro interdipendenze.

  • Design Document- Fornisce una panoramica del software e descrive in dettaglio gli elementi di progettazione. Documenta dettagli comedata flow diagrams, entity relationship diagrams, eccetera.

  • Requirements Document- Ha un elenco di tutti i requisiti del sistema, nonché un'analisi della fattibilità dei requisiti. Può contenere casi utente, scenari di vita reale, ecc.

  • Technical Documentation - È una documentazione dei componenti di programmazione effettivi come algoritmi, diagrammi di flusso, codici di programma, moduli funzionali, ecc.

  • Testing Document - Registra il piano di test, i casi di test, il piano di convalida, il piano di verifica, i risultati dei test, ecc. Il test è una fase dello sviluppo del software che richiede un'intensa documentazione.

  • List of Known Bugs- Ogni software presenta bug o errori che non possono essere rimossi perché sono stati scoperti molto tardi o sono innocui o richiederanno più tempo e impegno del necessario per la rettifica. Questi bug sono elencati con la documentazione del programma in modo che possano essere rimossi in un secondo momento. Inoltre aiutano gli utenti, gli implementatori e gli addetti alla manutenzione se il bug è attivato.