Cum se creează un manual de utilizare

Manualele de utilizare sunt ghiduri scrise - care pot fi disponibile digitale sau tipărite - care oferă instrucțiuni despre cum să faceți ceva sau să utilizați un produs. Deși termenul "ghid de utilizare" este asociat cu manualele software, ghidurile de utilizare însoțesc de asemenea computerele și alte dispozitive electronice, cum ar fi televizoarele, radiourile, telefoanele și playerele mp3, precum și aparatele electrocasnice și echipamentele de grădinărit. Un manual bun educă utilizatorii cu privire la funcțiile produsului, în timp ce îi învață cum să le utilizeze eficient, explicând totul într-un mod simplu. Mai jos veți găsi lucruri de luat în considerare atunci când creați un manual de utilizare, de la conținut la aspect.

conținut

Pași
Partea 1crearea documentației de utilizator corespunzătoare
Partea 2componentele unui manual de utilizare
Partea 3proiectarea unui manual lizibil
Sfaturi
Materiale necesare
Surse și cotatii

pași

Partea 1
Crearea documentației de utilizator corespunzătoare

Imaginea intitulată Crearea unui manual al utilizatorului Pasul 1

Definiți cine va fi utilizatorul. Pentru a scrie un manual bun, trebuie să dezvolți profilul de utilizator țintă, fie în mod formal - prin crearea unui profil scris - fie informal - luând timp pentru a identifica caracteristicile utilizatorilor potențiali ai produsului. Acest profil este util atunci când faceți parte dintr-o echipă de scriere a documentației de utilizare și vă ajută să luați produsul conceptual în forma sa finală. La formarea unui profil de utilizator, gândiți-vă:

În cazul în care utilizatorii vor folosi ghidul, fie acasă, în birou, într-un mediu de lucru izolat sau în mașină. Acest lucru poate determina nu numai conținutul, ci stilul manualului.
Modul în care utilizatorii vor folosi ghidul. Dacă manualul trebuie consultat prea des sau doar ca formă de cercetare, el trebuie să ia forma unui document de referință. Dacă este ceva la care utilizatorii se vor referi adesea de la început, secțiunea de referințe ar trebui să fie însoțită de o secțiune "Începeți" și de instrucțiuni privind cele mai comune funcții ale produsului.
În experiența pe care utilizatorii o au deja cu produsul și altele similare. Dacă produsul dvs. este nou sau foarte diferit de competitorii asemănători, trebuie să explicați diferențele și să includeți instrucțiuni despre cum să începeți. Dacă produsul se ocupă de ceva cu care utilizatorii întâmpină de obicei probleme, cum ar fi un anumit software de calculator, trebuie să oferiți informații și detalii adecvate într-un mod ușor de înțeles.

Imaginea intitulată Creați un manual al utilizatorului Pasul 2

Scrieți nevoile utilizatorului astfel încât să îl poată înțelege. Cu excepția cazului în care utilizatorul are cunoștințe tehnice, cel mai bine este să evitați limbajul tehnic, alegeți întotdeauna explicații simple și clare. Textul ar trebui să fie organizat într-un mod care să imite gândirea utilizatorilor - listarea opțiunilor grupate după funcție are mai multă sens decât listarea acestora în funcție de frecvența utilizării, de exemplu.

Adesea, nu există nici o scăpare din termenii tehnici, cum ar fi atunci când se scrie un manual pentru software-ul grafic care include grafica Fibonacci împreună cu alte grafică mai obișnuită. În acest caz, este util să definiți termenii și să oferiți un fel de fundal, ca o explicație a ceea ce sunt graficele Fibonacci și care sunt utilizările lor în analizele financiare.

Imaginea intitulată Creați un manual al utilizatorului Pasul 3

Explicați problema pe care utilizatorul încearcă să o soluționeze și să o prezinte. Furnizarea unei opțiuni ca soluție la problema generală este ceva care funcționează în legătură cu dezvăluirea produsului, dar după cumpărare, utilizatorul va trebui să învețe cum să pună produsul în uz. Identificați problemele specifice cu care se va confrunta persoana, explicați-le în manual și încheiați cu instrucțiunile de rezolvare a acestora.

Dacă problema este complexă, împărțiți-o în părți mai mici. Listează instrucțiunile și soluțiile succesiv. Împărțirea informației în acest fel este o metodă cunoscută sub numele de "fragmentare".

Partea 2
Componentele unui manual de utilizare

Imaginea intitulată Creați un manual de utilizare Pasul 4

Includeți coperți și pagini de titlu. Veți avea nevoie de o acoperire pentru orice manual, altul decât o carte de referință simplă și o pagină de titlu pentru orice manual care conține mai mult de o foaie de hârtie pliată.

Dacă manualul este protejat prin dreptul de autor, anunțul trebuie inserat pe copertă și paginile de titlu.
Dacă există termeni și condiții pentru a utiliza manualul și produsul asociat cu acesta, plasați-le în interiorul capacului.

Imaginea intitulată Creați un manual al utilizatorului Pasul 5

Trimiteți referințele la documentele asociate în prefață. Dacă documentația nu este doar manualul, consultați documentele care au versiunile curente aici. De asemenea, veți intra în secțiunea "Cum se utilizează acest ghid", dacă există una, în prefață.

Imaginea intitulată Creați un manual de utilizare Pasul 6

Includeți un index dacă manualul are mai mult de 10 pagini.

Imaginea intitulată Creați un manual de utilizare Pasul 7

Puneți instrucțiuni / proceduri și materiale de referință pe carcasa manualului. În cele mai multe cazuri, aceste articole trebuie să aibă secțiuni proprii, dar puteți instrui cititorul să se refere la conținut specific dintr-o secțiune la alta în celălalt. În acest fel, utilizatorul poate găsi informațiile solicitate mai rapid.

Procedurile trebuie să fie scrise cu o structură consecventă în secțiunea de instrucțiuni a manualului. Începeți cu o prezentare generală a sarcinii și apoi descrieți ce ar trebui să facă utilizatorul și ce rezultat ar trebui obținut. Pașii trebuie numerotați și încep cu verbele de acțiune, precum și pașii din secțiunile acestui articol.
Materialele de referință pot include liste de opțiuni, sfaturi de depanare și întrebări frecvente. Glosare și indexuri pot fi adăugate și la sfârșitul manualului, deși lista de termeni frecvent solicitați va apărea de obicei la început. Indicele poate fi omis dacă manualul are mai puțin de 20 coli.

Imaginea intitulată Creați un manual de utilizare Pasul 8

Folosiți imagini pentru suport, dacă este necesar. Imaginile pot ilustra câteva idei mai bune decât textele, în special atunci când descriu proceduri complexe în care utilizatorul are nevoie de informații vizuale pentru a se asigura că aceștia realizează corect pașii. Imaginile pot fi produse cu software-ul de desen, camerele digitale și software-ul de editare a imaginilor (care pot fi de asemenea folosite în cazul capturii ecranului).

După crearea imaginii, salvați-o într-un format comprimat și acceptată de software-ul în care scrieți manualul. De asemenea, reduceți dimensiunea fizică pentru a se potrivi dimensiunii paginii, dar fără a elimina detaliile necesare pentru utilizator. Dacă este necesar, puteți împărți imaginea în bucăți pentru a afișa porțiunile relevante de lângă text.
Dacă utilizați mai multe imagini, standardizați dimensiunea lor, fie folosind aceeași lungime și lățime, fie reduceți-le proporțional cu dimensiunea originală. Acest lucru le va face mai atractive pentru cititor. Același lucru este valabil pentru crearea de capturi de ecran ale unui computer, unde este necesar să se standardizeze schema de culori a sistemului, astfel încât toate să pară similare.
În timp ce software-ul de editare, cum ar fi Photoshop și Paint Shop Pro, oferă capabilități decente de captare a ecranului, software-ul dedicat, cum ar fi Snaglt, are de asemenea opțiuni pentru editarea, catalogarea și adnotarea cu ușurință.

Partea 3
Proiectarea unui manual lizibil

Imaginea intitulată Creați un manual al utilizatorului Pasul 9

Alegeți fonturi lizibile. Deși computerele acceptă sute de fonturi diferite, obiectivul manualului de utilizare este citirea. Alegerea unui număr mic de fonturi potrivite este cea mai bună opțiune pentru aceasta. Fonturile pot fi ușor împărțite în două tipuri: serif și non-serif.

Fonturile Sprite au linii decorative mici la marginile curgerilor care alcătuiesc literele. Acest tip de fonturi funcționează cel mai bine pentru blocuri mari de text în dimensiuni cuprinse între 10 și 12 în corpul unui manual tipărit. Exemplele includ surse precum Times New Roman, Baskerville și Book Antiqua.
Fonturile Sans serif au doar loviturile care alcătuiesc literele, fără decorațiuni. Aceste fonturi pot fi folosite în blocuri mari de text în dimensiuni cuprinse între 8 și 10 în cărțile digitale, deoarece lipsa serifurilor face dificilă citirea în dimensiuni de peste 12. Aceste fonturi pot fi totuși utilizate în dimensiuni mari în titluri și anteturi, precum și de a fi minunat pentru note de subsol și numere în coloane și tabele. Exemplele includ fonturi precum Arial, Calibri și Century Gothic.
Alegeți dintre fonturile comune cum ar fi Arial sau Time New Roman pentru manuale, dar alegeți mai multe opțiuni decorative pentru citate și titluri dacă scrieți un manual pentru un joc fantastic sau science fiction. În cazul citărilor, aveți posibilitatea să păstrați fontul implicit al textului, dar să-l redimensionați.
După ce ați definit fonturile pe care le veți utiliza, creați o pagină de test pentru a vedea dacă se potrivesc împreună pe hârtie. Arătați testul persoanei care are puterea de a seta aspectul manualului înainte de a continua.

Imaginea intitulată Creați un manual de utilizare Pasul 10

Gândiți-vă la aspectul paginii. După alegerea fonturilor, trebuie să alegeți aspectul a tot ceea ce se întâmplă pe pagină.

În general, ar trebui să introduceți numele titlului sau al capitolului în antet sau subsol și puteți pune titlul manualului pe pagina stângă și titlul capitolului pe pagina dreaptă. Introduceți și numerele paginilor din aceste regiuni, fie în partea dreaptă (în antet sau subsol), fie în centru (numai subsolul). Puteți diferenția prima pagină a fiecărei secțiuni sau capitole prin plasarea numărului paginii în centrul subsolului, în timp ce paginile următoare sunt numerotate în colțul exterior al antetului.
Puteți introduce note de notificare în cutii colorate sau umbrite pentru a le separa de restul textului. Alegeți o culoare sau un nivel de umbrire care nu se suprapune peste text.
Creați margini rezonabile pe toate laturile, oferind spațiu suplimentar la marginea care va fi legată.

Imaginea intitulată Creați un manual al utilizatorului Pasul 11

Luați în considerare tipul de legare. Dacă manualul are mai mult de patru pagini, va trebui să fie securizat într-un fel. Documentele interne pot fi capsate în colțul din stânga sus al paginilor, dar manualele livrate împreună cu produsele sunt legate prin una din cele trei metode de mai jos:

Capsarea laterală este potrivită pentru manuale compuse din folii de 21 x 27,5 cm, 21 x 35 cm sau 27,5 x 42,5 cm. Cele mai ieftine materiale de 48 de pagini sau mai puțin sunt atât de capsate.
Cusătura șa este mai comună pentru ghiduri de referință terțe părți decât în manualele oferite cu alte produse decât mașinile, în ciuda manuale mai fi legat prin aceasta. (Paint Shop Pro a fost vândut cu un ghidaj cu capse de coloană atunci când a fost produs de JASC Software.)
Spirala este potrivită pentru ghidajele care ar trebui folosite în exterior, unde celelalte legături ar putea fi prea fragile. Unele din aceste manuale au pagini laminate pentru a preveni deteriorarea apei sau a pământului.

Imaginea intitulată Creați un manual al utilizatorului Pasul 12

Creați un șablon pentru manual. Mai multe software-ul de editare de text și de prelucrare are o funcție pentru a crea un șablon, astfel încât să introduceți textul și este automat afișat în fontul selectat pentru porțiunea din manualul cu care lucrați. (Acest articol a fost scris inițial utilizând un șablon Microsoft Word.) Cele mai multe dintre aceste programe au șabloane predefinite, care pot fi adaptate la nevoile tale, de aceea este necesar să se creeze un model de la zero.

Acest software vă permite să creați „stiluri“, pre-definirea fonturi și dimensiuni pentru antete, titlurile și corpul de text. Puteți selecta una dintre stilurile definite (cum ar fi „rubrica 1“, „Normal“, „Citat“) sau de a vă crea propriul stil. Urmați convențiile de denumire a stilului dacă aveți mai multe clase pe text. (De exemplu, Word identifică stiluri pentru titluri, cum ar fi „rubrica 1“, „rubrica 2“, etc pentru diferite niveluri de subtitrări.) Încercați să creați toate stilurile vor folosi în avans, astfel încât să nu se oprească și să le creați în timpul procesului de scriere.

sfaturi

Folosiți variabile de text ori de câte ori este posibil. Puteți să le atribuiți valori, cum ar fi un nume de produs sau un titlu de capitol, și să le inserați în document în loc să tastați textul în sine. Când previzualizați sau tipăriți manualul, textul va lua locul variabilei. Dacă numele produsului se modifică, va fi mai ușor să îl modificați în manual prin modificarea variabilei decât prin căutarea și înlocuirea manuală a acestuia în document.