Manualul utilizatorului
Versiunea actuală a paginii nu a fost încă examinată de colaboratori experimentați și poate diferi semnificativ de
versiunea revizuită pe 10 august 2019; verificarea necesită
1 editare .
Un manual de utilizare este un document al cărui scop este de a ajuta oamenii să folosească un sistem. Documentul face parte din documentația tehnică a sistemului și este, de obicei, pregătit de un redactor tehnic .
Majoritatea manualelor de utilizare conțin imagini în plus față de descrierile textuale. În cazul software-ului , capturile de ecran sunt de obicei incluse în manual , iar desenele simple și ușor de înțeles sunt incluse în descrierea hardware-ului. Se folosește stilul și limbajul accesibil publicului vizat, jargonul este redus la minimum sau explicat în detaliu.
Cuprins
Un manual de instrucțiuni tipic conține:
- Adnotare care oferă un rezumat al conținutului documentului și al scopului acestuia
- Introducere cu link-uri către documente conexe și informații despre cum să utilizați cel mai bine acest manual
- Pagina de conținut
- Capitole care descriu cum să utilizați cel puțin cele mai importante caracteristici ale sistemului
- Capitolul care descrie posibilele probleme și soluții
- Întrebări și răspunsuri frecvente
- Unde mai găsești informații despre subiect, informații de contact
- Glosar și, în documentele mai mari, index
Toate capitolele și paragrafele, precum și figurile și tabelele, sunt de obicei numerotate, astfel încât să se poată face referire la ele în document sau dintr-un alt document. Numerotarea facilitează, de asemenea, conectarea la părți ale manualului, de exemplu, atunci când utilizatorul comunică cu echipa de asistență.
Standarde
Structura și conținutul documentului Ghid de utilizare pentru sistemul automatizat sunt reglementate de subsecțiunea 3.4 din documentul RD 50-34.698-90 (anulat prin ordinul Rosstandart din 12 februarie 2019 N 216). Structura și conținutul documentelor Ghidul operatorului , Ghidul programatorului, Ghidul programatorului de sistem sunt reglementate de GOST 19.505-79, GOST 19.504-79 și, respectiv, GOST 19.503-79.
- Un set de standarde și linii directoare pentru sisteme automate (GOST 34)
- RD 50-34.698-90 SISTEME AUTOMATICE. CERINȚE PRIVIND CONȚINUTUL DOCUMENTELOR
- Sistemul unificat pentru documentația de proiectare (ESKD) definește documentul „Manual de operare” și alte documente:
- Sistemul unificat de documentare a programelor (ESPD) definește documentele „Manualul operatorului”, „Manualul de întreținere” și structura acestora:
- GOST 19.101-77 Tipuri de programe și documente de program
- GOST 19.105-78 Cerințe generale pentru documentele programului
- GOST 19.505-79 Manual de utilizare. Cerințe pentru conținut și design
- GOST 19.508-79 Manual de întreținere. Cerințe pentru conținut și design
Vezi și
Link -uri