Documentația utilizatorului - studopediya

documentație de utilizare (documentația de utilizare): un set complet de documente furnizate în formă tipărită sau alta, care prevede utilizarea produsului, precum și fiind parte integrantă a acestuia.

documentația de utilizare trebuie să îndeplinească următoarele specificații.

Greutate (exhaustivitate). documentația de utilizare trebuie să conțină informațiile necesare pentru a utiliza produsul. Ar trebui să fie descris pe deplin toate funcțiile specificate în descrierea produsului, precum și toate funcțiile apelabile de utilizator din program. De asemenea, valorile limită definite în descrierea produsului, trebuie să se suprapună în documentația de utilizare. În cazul în care (instalare) produs de instalare poate fi efectuată de către utilizator, documentația de utilizator ar trebui să fie incluse îndrumări cu privire la instalarea produsului, care conține toate informațiile necesare. În cazul în care suportul de produs poate fi efectuată de către utilizator, documentația de utilizator ar trebui să fie incluse îndrumare în sprijinul programului, care conține toate informațiile necesare pentru a asigura acest tip de sprijin.

Corectitudinea (corectitudine). Toate informațiile din documentația de utilizare trebuie să fie corecte. În plus, prezentarea acestor informații nu trebuie să conțină mai mult de o interpretare și de eroare.

Consistența (consistență). Documente incluse în setul de documentație de utilizare, nu trebuie să se contrazică, reciproc și descrierea produsului. Fiecare termen ar trebui să aibă același înțeles în toate documentele.

Claritatea (inteligibilitatea). documentația de utilizare ar trebui să fie clar pentru comunitatea utilizatorilor, se execută un volum de muncă, cum ar fi prin folosirea ei anumiți termeni în mod corespunzător de inserții grafice, clarificarea și explicațiile prin linkuri către surse de informații utile.

Simplitatea Ferris (ușurința de prezentare generală). documentația de utilizare ar trebui să fie destul de simplu pentru utilizator pentru a studia, astfel încât să se poată identifica toate descrise în relația ei cu componentele produsului. În fiecare document poate fi inclus TOC și Index.

Rezumând, putem spune că există o nevoie urgentă pentru introducerea unor standarde interne pentru documentarea normelor PS, regulamentele, cerințele și recomandările, care sunt stabilite la nivel internațional și străine avansate. Dar, în timpul acestei lucrări nu poate fi limitată la transferul direct al anumitor standarde internaționale. Este necesar ca noile standarde sunt ancorate în mod corespunzător cu toate reglementările multiple actuale și viitoare.