Documentazione Sistema vs. Documentazione per l'utente

March 14

Documentazione Sistema vs. Documentazione per l'utente


Uno dei componenti più importanti di qualsiasi nuova implementazione del sistema è la documentazione. La documentazione deve essere fornita sia per il personale tecnico e gli utenti. Diversi somiglianze esistere in due aree di documentazione, ma i due hanno anche alcune differenze dovute al target.

Scopo

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

Livello tecnico

Il livello tecnico di documentazione del sistema è superiore a quella della documentazione dell'utente, poiché l'utente non ha bisogno di conoscere le caratteristiche del sistema. Come esempio, la documentazione sistema dovrebbe contenere diagrammi di flusso che descrive il funzionamento dei programmi e file, mentre documentazione utente deve contenere immagini di schermi ed esempi di rapporti. il personale di sistema hanno bisogno di sapere di più sul funzionamento interno del sistema per fornire il giusto livello di supporto in entrambe le operazioni quotidiane e la risoluzione dei problemi.

leggibilità

La leggibilità dipende dalle necessità del lettore. Sistemi di personale deve essere in grado di leggere la documentazione utente e capire in fretta, mentre gli utenti dovrebbero essere dati i dati rapidi su come navigare nell'interfaccia. In entrambi i casi, è importante che la documentazione sia leggibile dal target.

Manutenzione

manutenzione La documentazione dovrebbe avvenire ogni volta che un sistema è cambiato. La manutenzione potrebbe influenzare o documentazione di sistema, documentazione dell'utente o entrambi, a seconda della natura delle modifiche. manutenzione documentazione ad ogni livello si può essere trascurato. è necessaria diligenza per garantire la documentazione corrente sia per gli utenti e il personale dei sistemi.