Oricât de ingenios ar fi un inventator, programator sau raționalizator, uneori creațiile sale pur și simplu nu pot fi folosite în scopul propus. Motivul pentru aceasta este manualul de instrucțiuni întocmit incorect sau absența sa completă. Dar chiar și inventatorii ingenioși scriu uneori astfel de instrucțiuni încât, în afară de specialiștii îngrijiți, nimeni nu poate citi aceste lucrări. Deci, cum întocmiți corect un astfel de document necesar?
Este necesar
- - cunoștințe sută la sută despre dispozitivul sau produsul software pentru care este scris manualul;
- - cunoștințe în domeniul lingvisticii;
- - abilități de scriere.
Instrucțiuni
Pasul 1
Un manual de utilizare sau, cu alte cuvinte, un manual de utilizare este un document conceput pentru a oferi asistență în utilizarea unui anumit sistem utilizatorilor săi. Pentru a compila un manual de utilizare, trebuie să cunoașteți sistemul descris sută la sută, dar să îl priviți prin ochii unui student ignorant. Să presupunem că un manual de utilizare este scris pentru un utilitar software care nu are încă analogi. Imaginați-vă că este prima dată când utilizați acest program. De unde începi? Care este primul lucru de știut? Organizați aceste cunoștințe în categorii de importanță.
Pasul 2
Împărțind toate informațiile referitoare la crearea dvs. în grupuri, ați elaborat un plan pentru redactarea unui manual de utilizare. Începeți să descrieți lucrarea din programul dvs. de la zero, lăsând pentru ultimele detalii cele mai dificile, cum ar fi reprogramarea caracteristicilor sau gestionarea erorilor critice. În această etapă, ar trebui să aveți gata conținutul manualului de utilizare - una dintre părțile necesare ale acestui document.
Pasul 3
Dacă manualul pe care îl creați este destinat utilizării într-o companie mare, atunci ar trebui să acordați atenție standardelor corporative adoptate acolo. De exemplu, în multe companii rusești, manualele de utilizare nu sunt acceptate fără suport ilustrativ, cu alte cuvinte, imagini care explică ceea ce este scris. Pe lângă conținut, manualul de utilizare ar trebui să conțină alte părți obligatorii: - Adnotare, adică o explicație a obiectivelor generale ale manualului și ale produsului descris; - o introducere, care descrie documentele legate de manualul de utilizare și modul în care să utilizați manualul; - secțiuni care explică utilizarea produsului în diferite etape ale utilizării acestuia, de exemplu, primii pași, reparații sau întreținere; - secțiunea de întrebări frecvente și răspunsuri la acestea; - glosar sau index de subiecte.
Pasul 4
De obicei, un scriitor tehnic este implicat în crearea unui manual de utilizare - o persoană care are toate cunoștințele necesare atât în limba, cât și în produsul descris. Ca scriitor tehnic fără pregătire, există câteva reguli de care să ții cont. În primul rând, nu trebuie să abuzați de termeni speciali care nu sunt de înțeles pentru un utilizator obișnuit. În al doilea rând, fiecare termen utilizat trebuie să fie detaliat și explicat. În al treilea rând, trebuie să scrieți cât mai clar și concis cu putință. În cele din urmă, un scriitor tehnic trebuie să poată privi propriul text prin ochii unui utilizator obișnuit, pentru a vedea deficiențele propriului text.
Pasul 5
Este bine să testați în practică textul finalizat al manualului de utilizare oferindu-l unei persoane care nu a avut nimic de-a face cu produsul descris. Prin eforturi comune, este posibil să se elimine toate neajunsurile și capcanele documentului.
