Cum se creează un manual de utilizare

Manualele de utilizare sunt ghiduri fizice (pe suport de hârtie) sau documente electronice (PDF sau XPS) care oferă instrucțiuni despre cum să faceți sau să utilizați ceva. Deși ghidurile de utilizare „“ sunt cel mai frecvent gândit ca legate de software de calculator, manuale de utilizare sunt, de asemenea, atașate la computere sau alte dispozitive electronice, cum ar fi televizoare, combine muzicale, telefoane și playere MP3, precum și aparate și echipamente din grădină. Un manual de utilizare bun îi informează pe utilizatori cu privire la funcționalitatea produsului, preocupând de asemenea activitățile sale într-un mod eficient și ușor de consultat. Următoarele sunt elementele pe care trebuie să le luați în considerare în crearea unui conținut eficient și a unui manual de utilizare.

conținut

Paşi
Partea 1
Partea 2
Partea 3
Sfaturi
Lucruri de care ai nevoie

paşi

Partea 1

Creați o documentație potrivită pentru utilizator

Definiți utilizatorul de referință. Pentru a scrie un manual de succes, trebuie să trasați un profil al utilizatorului, fie formal, fie să creați un profil scris sau 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 pentru utilizator și poate fi de asemenea utilă în procesul care duce produsul de la idee la forma finală. Când scrieți un profil de utilizator, elementele care trebuie luate în considerare includ:

În cazul în care utilizatorii vor folosi manualul, acasă, în birou, într-un loc de muncă la distanță sau în mașină. Acest lucru ar putea afecta nu numai conținutul, ci și stilul manualului.
Modul în care utilizatorii vor folosi ghidul. Dacă trebuie să consultați manualul numai rareori sau să căutați informații, acesta trebuie să aibă în primul rând forma unui document de consultare. Dacă este ceva care va fi consultat inițial de către utilizatori, secțiunea de consultare ar trebui să fie însoțită de o secțiune "Începeți" și instrucțiuni cu privire la cele mai uzuale utilizări ale produsului.
Câtă experiență au utilizatorii deja cu produsul sau alte persoane din aceeași categorie. Dacă produsul dvs. este nou sau prezintă diferențe substanțiale în comparație cu produsele similare, va trebui să includeți o explicație a acestor diferențe, precum și instrucțiuni despre cum să începeți să îl utilizați. Dacă produsul abordează ceva cu care utilizatorii au adesea probleme, cum ar fi multe aplicații pe calculator, va trebui să oferiți informații și detalii adecvate într-un stil ușor de înțeles.

Adresați-vă nevoilor utilizatorilor dvs. pentru a le înțelege. Cu excepția cazului în care utilizatorul are experiență tehnică, va fi mai bine să evitați terminologiile specifice, preferând explicații clare și simple. Textul ar trebui să fie, de asemenea, organizate pentru a mângâia motivarea utilizatorilor, lista caracteristicilor produsului gruparea acestora în funcție de funcțiile lor, de multe ori face mai mult sens în listele din comenzile cele mai utilizate în mod obișnuit.

Uneori nu există nici o modalitate de a obține termeni tehnici, cum ar fi pentru un software de diagramă care include mesele Fibonacci, împreună cu mai multe plăci comune și baruri. În cazuri similare, este util să definim termenul și să oferim o explicație, de exemplu examinând definiția și utilitatea analizei financiare a tabelelor Fibonacci.

Explicați problema pe care utilizatorul încearcă să o rezolve, apoi prezentați soluția. Furnizarea singurei soluții la o problemă generică funcționează în faza de vânzare a produsului, dar odată ce acesta a cumpărat-o, trebuie să înțeleagă cum să o folosească cel mai bine. Identificați problemele specifice în care veți întâlni utilizatorul, indicați-le în ghidul de utilizare și apoi mergeți la instrucțiunile pentru a le rezolva.

Dacă problema este una dintre cele complexe, spargeți-o în părți mai mici. Listează fiecare parte cu instrucțiuni despre cum să o rezolvi sau să o rezolvi și apoi să le aranjezi succesiv. Această procedură este cunoscută sub numele de "chunking" (Tocare).

Partea 2

Elemente ale Manualului utilizatorului

Includeți pagina de copertă corespunzătoare și paginile de titlu. Veți avea nevoie de o copertă pentru fiecare ghid de utilizare, care constă din mai mult decât o carte de referință, și să acoperiți paginile pentru manuale mai lungi decât o foaie de hârtie pliată (4 sau mai multe pagini).

Dacă manualul este protejat prin dreptul de autor, acesta trebuie specificat atât pe copertă, cât și pe pagina de titlu.
Dacă trebuie să raportați termenii și condițiile pentru utilizarea manualului și a produsului acestuia, trebuie să îl introduceți pe interiorul capacului.

Introduceți referințe la documentele asociate din introducere. Dacă documentația utilizatorului acoperă mai mult de un volum, trimiteți trimiteri la alte documente aici, cu versiunile corecte. Introducerea este, de asemenea, partea în care să inserați secțiunea "Cum se utilizează acest ghid", dacă este necesar.

Includeți un index, în cazul în care manualul depășește 10 pagini.

Puneți instrucțiunile / metodele și materialele de referință în corpul central al manualului. În multe cazuri, metodele și materialele de referință ar trebui să aibă câte o secțiune proprie, deși puteți spune mereu utilizatorului să se refere la conținut specific de la o secțiune la alta. În acest fel, utilizatorul poate găsi informațiile pe care le caută mai repede.

Metodele trebuie să fie scrise în mod consecvent de-a lungul secțiunii de instrucțiuni a manualului. Începeți dintr-o prezentare generală a sarcinii, apoi descrieți ce trebuie să facă utilizatorul și ce rezultate ar trebui să obțină. Etapele trebuie să fie numerotate și să înceapă cu verbele de acțiune, precum și pașii din fiecare secțiune a acestui articol.

Materialele de referință pot include o listă de opțiuni, sugestii și întrebări frecvente. Glosare și anexe pot fi adăugate spre sfârșitul manualului, deși o listă cu termenii cei mai folosiți poate apărea la început. Indicele poate fi omis dacă manualul are mai puțin de 20 de pagini.

Utilizați grafică dacă aveți nevoie să susțineți textul. Grafica, sau ecrane, anumite puncte de pe cele mai bune din manualul poate fi prezentat, în special în procedurile complexe, în cazul în care utilizatorii au nevoie de o confirmare vizuală a fiecărui exercițiu. Grafica poate fi produsă cu ajutorul CAD sau software de grafică, editare digitală și camere digitale, sau, în cazul de ecrane, utilizând funcția de built-in pe computer ( „ștampila“ / Cmd + shift + 3) sau un program de grafică, care oferă opțiunea de înregistrare a ecranului.

Odată ce grafica a fost creată, salvați-o în format comprimat, astfel încât să poată fi utilizată în scris sau în publicarea programelor. De asemenea, veți dori să reducă dimensiunea fișierului pentru a facilita includerea pe pagina fără a micșora detaliile de utilizator (dacă este necesar, poate fi necesar pentru a rupe în jos imaginea originală și arată părțile relevante pe măsură ce avansezi cu textul).

Dacă utilizați numeroase elemente grafice în metode, păstrați o consistență în dimensiunile care au aceeași lungime și lățime sau sunt mereu reduse cu aceeași proporție în raport cu formatul lor original. Acest lucru va face ca imaginile să fie mai atractive pentru utilizator. De asemenea, atunci când salvați capturi de ecran pe un computer, asigurați-vă că calculatorul este setat la culoarea standard în timpul acestui pas, în cazul în care manualul trebuie să păstreze aceste culori.

Deși programele grafice precum Photoshop și Paint Shop Pro oferă posibilități bune de economisire a ecranului, chiar și programe specifice cum ar fi SnagIt vă permit să editați, să catalogați și să identificați cu ușurință ecrane.

Partea 3

Proiectați un manual lizibil

Alegeți o pereche de fonturi lizibile. Deși computerele pot suporta mai multe fonturi diferite, scopul unui manual de utilizare este ușor de citit. Alegerea câtorva fonturi bine potrivite este cea mai bună modalitate de a atinge acest obiectiv. Există două categorii de caractere: "serif" și "sans serif" (cu sau fără mulțumiri).

Fonturile Serif au terminări mici la sfârșitul liniilor principale ale literelor. Fonturile Serif includ Times New Roman, Baskerville și Book Antiqua. Serifii funcționează cel mai bine în blocuri mari de 10-12 texte din corpul central al unui manual de utilizare tipărit.
Fonturile Sans serif afișează numai trăsăturile care formează literele fără terminație. Sans serif include Arial, Calibri și Gothic Century. Aceste fonturi pot fi folosite pentru blocuri mari de text de la mărimea 8-10 într-un manual online sau în format PDF, în ciuda lipsei de terminări, fac ca frazele de 12 + mari să fie mai greu de citit. Ele pot fi însă utilizate în mod eficient pentru dimensiuni mai mari pentru a afișa titluri și titluri și sunt la fel de potrivite în formate mai mici pentru subsol și numere în coloane sau tabele.
Ar trebui să alegeți în general, font neutru cum ar fi Arial sau Times New Roman în manualul de utilizare, așa cum este mai bine să se aplece spre un font decorativ, în caz de citate sau titluri, dacă sunteți scris, de exemplu, pentru un joc video cu un science fiction sau setările de fantezie (în caz de extrase din același text, puteți folosi adesea același font, în format "italic").
După ce ați ales fonturile pe care le veți folosi, creați o pagină de test pentru a verifica dacă fonturile se potrivesc împreună pe hârtie. Va fi, de asemenea, indicat să arătați aceste dovezi oricărei persoane care trebuie să aprobe apariția manualului înainte de a continua.

Gândiți-vă la aspect. După ce ați ales fonturile din manualul de utilizare, trebuie să decideți poziționarea diferitelor elemente ale paginilor.

În general, veți dori să puneți titlul manual sau capitolul în antet sau în partea de jos a paginii, eventual utilizând titlul manual din pagina stângă și titlul capitolului din pagina dreaptă. Numerele paginilor trebuie să fie deasupra sau dedesubt, spre exterior (antet sau subsol) sau în mijloc (numai subsolul). Poate doriți să distingeți prima pagină a fiecărei secțiuni sau capitole de celelalte, plasându-i numărul paginii în mijloc și cel din urmă în colțul exterior al antetului.

Este posibil să doriți să rețineți părți din text în cutii colorate sau umbrite pentru a le separa de restul textului. Asigurați-vă că alegeți o culoare sau un grad de umbrire care nu se suprapune cu textul.

Frunzează marginile destul de largi pe toate laturile, cu spațiu suficient pe marginile care se vor lega unul de celălalt.

Luați în considerare tipul de legare din manualul de utilizare. Dacă manualul dvs. are mai mult de 4 pagini, acestea trebuie să fie legate într-un fel. Deși documentele interne pot fi îmbinate cu un colier de hârtie într-un colț, manualele externe livrate împreună cu produsul sunt de obicei legate într-unul din aceste 3 moduri:

Capsele laterale sunt potrivite pentru manuale fabricate din foi de hârtie pliate de 21x27.5cm, 21x35cm sau 27.5x42.5cm. Majoritatea manualelor economice cu mai puțin de 48 de pagini sunt legate în acest fel.

Cusătura laterală este folosită cel mai frecvent pentru ghidurile de referință externe, mai degrabă decât manualele de utilizare atașate altor produse decât mașinile, deși unele ghiduri mai lungi sunt legate în acest fel (Paint Shop Pro a fost inițial livrat cu un ghidaj de îmbinare legat, cand a fost produs de JASC Software).

Legarea spirală este potrivită pentru ghidajele de utilizare proiectate pentru a fi mai rezistente, cum ar fi pentru medii în aer liber, unde manualele cu capse sau cusaturi nu ar rezista. Anumite manuale legate de spirală pot conține, de asemenea, pagini laminate pentru a preveni ruinarea lor în contact cu apa sau noroi.

Construiți un model pentru manualul dvs. Multe programe de scriere și publicare oferă posibilitatea de a crea un document de șablon pentru manualul dvs. de utilizare, astfel încât atunci când scrieți, textul apare automat în fontul dorit în cadrul manualului pe care lucrați (acest articol de fapt, a fost inițial scris folosind un model de MS Word). Multe dintre aceste programe includ, de asemenea, un set de șabloane presetate pe care le puteți modifica în funcție de nevoile dvs., în loc să creați un model de la zero.

Programele de scriere și publicare vă permit de asemenea să creați stiluri, fonturi și dimensiuni prestabilite pentru anteturi, subsoluri, titluri și corpuri textuale. Puteți alege unul dintre stilurile predefinite (cum ar fi "Heading1". "normal". "citat") sau creați propriul stil cu numele său. Pe cât posibil, urmați convențiile pentru numele stilurilor instituționale dacă aveți mai multe stiluri pentru aceeași parte a textului (de exemplu stiluri de etichete MS Word pentru anteturi ca "Heading1". "Heading2", etc. prin titluri, de la cea principală la diferitele niveluri de subtitrări). Încercați să creați toate stilurile de care aveți nevoie în avans, astfel încât să nu trebuiască să le opriți în timpul procesului de scriere reală.

Sfaturi

Folosiți bine codurile și variabilele de text acolo unde este posibil. Puteți atribui valori cum ar fi numele unui produs, titlul unui manual sau al unui capitol și le puteți plasa în document în loc să scrieți textul real. Când previzualizați sau imprimați un document, textul va înlocui variabila. Dacă se modifică denumirea produsului sau dacă schimbați numele manualului sau al unui capitol, va fi mai ușor să schimbați informațiile înlocuind valoarea variabilei text, decât să o căutați și să o înlocuiți în document.

Lucruri de care ai nevoie

Program de scriere sau de publicare
Program grafic sau înregistrări vizuale

Afișați mai multe ... (3)

Distribuiți pe rețelele sociale:

înrudit