Uno dei componenti più importanti di qualsiasi implementazione di sistema nuovo è la documentazione. Documentazione deve essere fornita per utenti e personale tecnico. Parecchie somiglianze esistono in due set di documentazione, ma i due hanno anche alcune differenze a causa del target di riferimento.

Scopo

La documentazione è essenziale per la comprensione di un nuovo sistema. Documentazione del sistema descrive come operatori e altro personale di sistema devono interagire con i file e le piattaforme che gestiscono un sistema informatico. Documentazione per l'utente descrive il modo che l'utente deve interagire con il sistema. Esempi di punti di documentazione utente come immettere dati, come per la ricerca di informazioni e come interpretare i rapporti.

Livello tecnico

Il livello tecnico della documentazione del sistema è superiore a quello della documentazione utente, poiché l'utente non ha bisogno di conoscere le specifiche di sistema. Ad esempio, documentazione relativa al sistema dovrebbe contenere diagrammi di flusso che descrivono il funzionamento dei programmi e file, mentre la documentazione per l'utente deve contenere immagini di schermate ed esempi di report. Personale di sistema necessario conoscere più circa il funzionamento interno del sistema per fornire il giusto livello di supporto nelle operazioni quotidiane e di risoluzione dei problemi.

Leggibilità

La leggibilità è dipenda la necessità del lettore. Sistemi personale dovrebbero essere in grado di leggere la documentazione per l'utente e capire rapidamente, mentre gli utenti dovrebbero essere data dati veloci su come navigare nell'interfaccia. In entrambi i casi, è importante che la documentazione sia leggibile dal target di riferimento.

Manutenzione

Manutenzione documentazione dovrebbe verificarsi ogni volta che un sistema è cambiato. La manutenzione poteva influenzare la documentazione del sistema, documentazione per l'utente o entrambi, a seconda della natura delle modifiche. Documentazione di manutenzione ad ogni livello è può essere trascurato. Diligenza adeguata è necessaria per garantire la documentazione corrente per gli utenti sia personale di sistemi.