Cum se face un manual de utilizare

Manualele de utilizare sunt ghiduri scrise în formă tipărită (pe hârtie) sau în documente electronice (PDF sau XPS) care oferă instrucțiuni despre cum să faceți sau să folosiți ceva. În timp ce, în general, considerat „ghidurile de utilizare“ ca manualele pentru programe de calculator, ghiduri de utilizare pot însoți calculatoare și alte dispozitive electronice, cum ar fi televizoare, aparate de radio stereo, sisteme de telefonie și MP3 playere, precum și aparate și echipamente de grădinărit. Manualele de utilizare bune educă utilizatorul despre funcțiile produsului, în timp ce îl învață să le folosească în mod eficient și sunt aranjate astfel încât să poată fi ușor citite și consultate. În continuare, acest articol va prezenta câteva lucruri pe care să le țineți cont atunci când creați un conținut eficient și proiectați aspectul pentru un manual de utilizare.

conținut

Pași
Partea 1creați documentația adecvată pentru utilizatori
Partea 2componente ale manualului de utilizare
Partea 3proiectați un manual de utilizare lizibil
Sfaturi
Lucruri de care ai nevoie

pași

Partea 1
Creați documentația adecvată pentru utilizatori

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

Definiți cine este utilizatorul Pentru a scrie un manual de utilizare reușit, trebuie să dezvolți un profil al utilizatorului, fie în mod formal, fie în crearea unui profil scris, fie informal, acordând timp pentru a face presupuneri rezonabile despre caracteristicile utilizatorului. Un astfel de profil este util atunci când sunteți parte dintr-o echipă care scrie documentația utilizatorului și poate, de asemenea, ajuta la preluarea produsului însuși de la un concept la forma sa finală. Lucrurile pe care trebuie să le ții cont atunci când formezi un profil de utilizator sunt:

Locul unde utilizatorii vor folosi ghidul de utilizare, cum ar fi acasă, în birou, într-un loc de muncă la distanță sau în mașină. Acest lucru poate determina nu numai conținutul, ci și stilul pe care îl are manualul de utilizare.
Modul în care utilizatorii vor folosi ghidul de utilizare. Dacă utilizatorii vor consulta manualul de câteva ori sau doar pentru a căuta informații, ar trebui să fie în forma unui document de interogare. Dacă la început utilizatorii vor consulta frecvent manualul, secțiunea de consultare trebuie să fie însoțită de o secțiune intitulată "Cum se pornește" și instrucțiuni pentru cele mai simple sarcini pentru care produsul va fi utilizat.
Experiența pe care o au utilizatorii cu produsul sau cu alte produse similare. Dacă produsul dvs. este nou sau semnificativ diferit de alte produse similare, ar trebui să includeți o explicație a modului în care acesta este diferit în comparație cu alte produse și, de asemenea, instrucțiuni despre cum să începeți să îl utilizați. Dacă produsul este legat de ceva care este adesea problematic pentru utilizatori, cum este cazul multor programe de calculator, trebuie să furnizați informații adecvate și detaliate într-un mod ușor de înțeles.

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

Scrie pentru a ajuta nevoile utilizatorului într-un mod pe care el îl poate înțelege. Cu excepția cazului în care utilizatorul are un background tehnic, ar fi mai bine să evitați limbajul foarte tehnic pentru a obține explicații mai clare și mai simple. Textul trebuie să fie organizat în mod similar cu cel al utilizatorului - de multe ori, este mai logic să enumerați caracteristicile produselor grupate după funcțiile lor decât să indicați numai cele care sunt utilizate cel mai des.

Uneori, este inevitabil să folosească termeni tehnici, ca un program de calculator conceput pentru a crea grafice, inclusiv diagrame plus Fibonacci pentru a bara grafice și proporțiilor, care sunt mai frecvente. În acest caz, este util să definiți termenul și să furnizați câteva informații de bază despre el, cum ar fi explicarea a ceea ce este o diagramă Fibonacci și a a ceea ce este folosit în analiza financiară.

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

Explică problema pe care utilizatorul încearcă să o rezolve și apoi prezintă o soluție pentru această problemă. Oferind o caracteristică a produsului ca soluție la o problemă obișnuită, funcționează bine atunci când produsul este promovat, dar odată ce îl are, trebuie să știe cum să folosească acea facilitate. Identificați problemele specifice cu care se va confrunta utilizatorul, menționați-le în ghidul de utilizare și apoi adăugați instrucțiunile pentru a le rezolva.

Dacă problema este complexă, separați-o în părți mai mici. Listează fiecare piesă cu instrucțiunile de rezolvare sau tratare a acesteia și apoi adăugați succesiv fiecare parte ulterioară. Împărțiți informațiile în acest fel se numește "fragment".

Partea 2
Componente ale manualului de utilizare

Imaginea intitulată Crearea unui manual de utilizare Pasul 4

Include capacul și capacele corespunzătoare. Ar trebui să includă un capac pentru orice utilizator mai mare ghid o foaie de referință și un capac pentru orice manual care să acopere mai mult decât suprafața unei coli de hârtie împăturită (4 sau mai multe pagini).

Dacă manualul este protejat prin dreptul de autor, trebuie să fie inclusă o notă de copyright pe copertă și pe copertă.
Dacă există termeni și condiții pentru a utiliza manualul și produsul asociat cu acesta, plasați-le pe capacul interior.

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

Faceți referințe la documentația aferentă în prefață. Dacă documentația utilizatorului este mai mult decât un singur manual, plasați aici referințele la celelalte documente, cu numerele lor de versiune corespunzătoare. Prefața este, de asemenea, locul unde ar trebui să plasați (dacă este cazul) o secțiune numită "Cum să utilizați acest ghid".

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

Dacă manualul depășește 10 pagini, acesta include un index de conținut.

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

Puneți instrucțiunile sau procedurile și materialele de referință în carcasa manualului. În cele mai multe cazuri, procedurile și materialele de referință au secțiuni proprii, deși într-o secțiune puteți instrui utilizatorul să consulte conținutul specific al celuilalt. În acest fel, utilizatorul poate găsi mai repede informațiile pe care le caută.

Procedurile trebuie să fie scrise cu o structură consecventă în secțiunea instrucțiuni a manualului. Începeți cu un rezumat al sarcinii, apoi descrieți ce ar trebui să facă utilizatorul și ce rezultate ar trebui respectate. Pașii trebuie să fie numerotați și să înceapă cu acțiuni verbale în același mod în care pașii sunt scrise în fiecare secțiune a acestui articol.

Materialele de referință pot include o listă de opțiuni, sfaturi pentru rezolvarea problemelor și întrebări frecvente. În apropierea sfârșitului manualului pot fi adăugate glosare și indicatoare, deși o listă cu termeni frecvent utilizați poate fi plasată la început. Indicele poate fi omis dacă manualul are mai puțin de 20 de pagini.

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

Utilizați imagini grafice pentru a face copii de siguranță atunci când este necesar. imagini grafice sau capturi de ecran ilustrează unele puncte mai bine decât un text, mai ales dacă este proceduri complexe, în care utilizatorul are nevoie de o confirmare vizuală pe care le efectuați pașii corect manualul. Imaginile grafice pot fi create folosind programe de proiectare asistată de calculator (CAD) sau programe de design grafic, camere digitale și programe de editare foto sau, în cazul capturilor de ecran, puteți utiliza funcția de captură care este instalată în computer sau un program de manipulare a grafurilor cu funcția de captare a ecranelor.

Odată ce ați creat o imagine grafică, salvați-o într-un format comprimat ca procesorul de text sau programul dvs. de publicare desktop vă permite să îl utilizați. Ar trebui să reducă, de asemenea, dimensiunea fizică a imaginii, până când ajunge la una care se poate potrivi cu ușurință pe pagina oferind în același timp detaliile necesare pentru utilizator (dacă este necesar, poate Debas separa imaginea în părți pentru a arăta părțile relevante de lângă textul care acceptă ).

Dacă utilizați multe imagini grafice în proceduri, faceți-le o dimensiune uniformă, fie în aceeași măsură de lățime și înălțime, fie în același raport de reducere față de dimensiunea originală. Acest lucru va face ca imaginile să arate mai atractive pentru utilizator. În mod similar, atunci când faceți fotografii pe un computer, asigurați-vă că computerul afișează aceeași schemă de culoare atunci când captați imagini în cazul în care manualul utilizatorului le va afișa în culori.

Deși programele de design grafic, cum ar fi Photoshop sau Paint Shop Pro oferă funcții de captare a ecranului decent, programe specializate de captare, cum ar fi Snagit, vă permit, de asemenea, să modificați, catalogați și comentați cu ușurință capturile de ecran.

Partea 3
Proiectați un manual de utilizare lizibil

Imaginea intitulată Crearea manualului de utilizare Pasul 9

Alegeți câteva surse lizibile. Deși computerele permit utilizarea a numeroase surse diferite, scopul unui manual de utilizare este să fie ușor de citit. Pentru a realiza acest lucru, este mai bine să alegeți un număr mic de surse care să arate bine împreună. Sursele pot fi împărțite în două grupuri: fonturi serif și fonturi sans serif

Fonturile serif au linii mici de decor la sfârșitul liniilor principale care formează litera. Unele fonturi serif sunt Times New Roman, Baskerville și Book Antiqua. Fonturile Serif funcționează cel mai bine pe bucăți mari de text tipărite în corpul principal al manualului de utilizare într-o dimensiune de 10 sau 12 puncte.
Fonturile sans serif au doar lovituri care formează literele, fără ornamente. Unele fonturi serif sentimente sunt Arial, Calibri și Century Gothic. Sans serif pot fi folosite în bucăți mari de text în dimensiuni de la 8 la 10 de puncte într-un PDF sau un manual pe internet, deși lipsa de serif face scris în dimensiuni de 12 puncte sau mai multe propoziții sunt dificil de citit . Cu toate acestea, ele pot fi utilizate eficient în dimensiuni mai mari pentru titluri și titluri, și sunt, de asemenea, foarte bune la dimensiuni mai mici pentru notele de subsol și numerele din coloane și tabele.
În general, ar trebui să alegeți fonturi simple precum Arial sau Times New Roman pentru manualul de utilizare, deși puteți alege un font decorativ pentru cotații sau titluri îndepărtate dacă scrieți un manual de utilizare pentru un joc video fantastic sau sci-fi (În cazul citatelor din margine, puteți utiliza adesea unele dintre sursele simple și afișați citatul în italice).
Odată ce ați ales sursele pe care le veți folosi, creați o pagină de eșantion pentru a verifica dacă sursele arată bine împreună pe hârtie. De asemenea, ar trebui să arătați acest eșantion persoanei care trebuie să aprobe aspectul manualului înainte de a continua să îl scrieți.

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

Gândiți-vă bine la distribuție. După ce ați ales sursele manualului de utilizare, trebuie să decideți unde plasați totul pe pagini.

În general, este convenabil să puneți titlul manualului sau capitolului în antet sau în subsol, plasând titlul manualului pe pagina stângă și titlul capitolului pe pagina dreaptă. Este, de asemenea, convenabil să plasați numărul paginii în antet sau în subsol, fie pe partea exterioară (a antetului sau subsolului), fie în centru (numai în subsol). Este convenabil să se diferențieze prima pagină a fiecărei secțiuni sau capitole din celelalte pagini prin plasarea numărului paginii în centrul subsolului și în paginile următoare, plasându-l în colțul exterior al antetului.

Este convenabil să plasați textul referințelor imaginilor în culori sau în cutii umbrite pentru al separa de restul textului. Asigurați-vă că alegeți un nivel de culoare sau de umbrire care vă permite să citiți cu ușurință textul.

Lăsați marginile în mod rezonabil larg pe laturi, cu spațiu suplimentar pe marginile pe care urmează să vă alăturați tuturor paginilor.

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

Alegeți tipul de legare pentru manualul de utilizare. Dacă manualul de utilizare are mai mult de 4 pagini, va fi necesar să le legați într-un fel. Deși documentele de uz intern pot fi capsate în colțuri, manualele de utilizare pentru uz extern care sunt livrate împreună cu un produs pot fi legate într-unul din aceste 3 moduri:

Capsarea pe laturi este potrivită pentru manualele formate din foi de hârtie îndoite de 21 x 27,5 cm, 21 x 35 cm (sau 8,5 x 14 inchi) sau 27,5 x 42, 5 cm (11 x 17 țoli). Majoritatea manualelor ieftine de 48 de pagini sau mai puțin sunt legate astfel.

Este mai frecvent să folosiți cusăturile pe călare pentru ghidurile de referință pentru terțe părți decât pentru manualele de utilizare care sunt livrate cu alte produse decât automobile, deși unele ghiduri de utilizare mai lungi sunt legate astfel (inițial când software-ul JASC a produs Paint Shop Pro, a livrat manuale de utilizare legat prin cusatura pe cai).

Legarea spirală este cea mai potrivită pentru ghidurile de utilizare care sunt concepute pentru medii mai ostile, cum ar fi în aer liber, unde manualele legate cu capse sau cusute pe călăreți ar fi dezarmate. Unele manuale legate în spirală pot avea pagini laminate pentru a evita ruinarea manualului dacă se uda sau murdare.

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

Proiectați un șablon de document pentru manualul de utilizare. Multe procesoare de text și programe de publicare desktop oferă posibilitatea de a crea șabloane de documente pentru manualele de utilizare, astfel încât, pe măsură ce tastați, textul va fi afișat automat în fontul pe care l-ați ales pentru partea din manualul pe care lucrați. (De fapt, acest articol a fost inițial scris utilizând un șablon Microsoft Word). Majoritatea acestor programe includ, de asemenea, un set de șabloane predefinite pe care le puteți modifica după cum este necesar, în loc să creați șablonul de la început.

Procesoarele de text și programele de publicare desktop oferă, de asemenea, posibilitatea de a crea "stiluri", care sunt tipuri predefinite de fonturi și dimensiuni pentru titluri, subsoluri, anteturi și corpul textului. Aveți posibilitatea să alegeți unul dintre numele de stil predefinite (de exemplu, "Header1", "Normal", "Appointment") sau să creați un stil propriu cu propriul nume. Dacă aveți mai multe stiluri pentru același tip de text, urmați cât mai mult posibil convențiile pentru numele de stil (de exemplu, stilurile de text ale Microsoft Word pentru titluri precum "Titlu1", "Titlu2" etc.) pentru toate titlurile de la principalele la mai multe niveluri de subtitrare). Încercați să creați în prealabil toate stilurile de care aveți nevoie, deci nu va trebui să le opriți pentru a le crea în timp ce scrieți manualul.

sfaturi

Utilizați coduri de câmp sau variabile de text atunci când este posibil. Puteți atribui valori, cum ar fi numele produsului, manualul sau titlul capitolului, și le puteți folosi în document în loc să scrieți textul real. Când previzualizați sau tipăriți manualul, textul va apărea în locul variabilei. Dacă se schimbă numele produsului sau dacă schimbați numele manualului sau al capitolului, va fi mai ușor să modificați informațiile schimbând valoarea variabilei de text pe care o căutați și înlocuind cuvintele din document.