Creați un manual

Manualele de utilizare sunt documente de hârtie sau electronice (pdf sau XPS) cu instrucțiuni pentru a face sau a folosi ceva. Cu toate manualele de utilizare de acolo fiind rapid manuale luate în considerare pentru software-ul, acestea sunt livrate foarte des în calculatoare și alte dispozitive electronice, cum ar fi televizoare, aparate stereo, telefon și MP3 playere, precum și aparate de uz casnic și unelte de grădină. Manualele de utilizare bune informează utilizatorii despre funcțiile unui produs și utilizarea efectivă a acestor funcții și sunt organizate astfel încât să fie ușor de citit și să poată fi consultate. Următoarele sunt câteva lucruri pe care trebuie să le luați în considerare atunci când creați un conținut eficient pentru proiectarea unui manual de utilizare.

conținut

Pași
Partea 1crearea unei documentații utile pentru utilizatori
Partea 2părți ale manualului de utilizare
Partea 3proiectați un manual de utilizare lizibil
Sfaturi
Accesorii

pași

Partea 1
Crearea unei documentații utile pentru utilizatori

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

Definiți utilizatorul. Pentru a scrie un manual de utilizare de succes, trebuie să dezvolți un profil al utilizatorului, fie în mod formal, prin crearea unui profil scris sau informal, luând timp pentru presupuneri rezonabile despre caracteristicile utilizatorului. Un astfel de profil este util atunci când sunteți parte dintr-o echipă de scriere a documentației utilizatorului și poate fi de asemenea utilă în dezvoltarea produsului de la concept la forma finală. Lucrurile pe care trebuie să le gândiți la dezvoltarea unui profil de utilizator includ:

În cazul în care utilizatorul va folosi manualul, cum ar fi acasă, la birou, la o clădire la distanță sau în mașină. Acest lucru nu poate determina doar conținutul, ci și stilul manualului de utilizare.
Modul în care utilizatorii vor folosi manualul. În cazul în care manualul este rar consultat sau este destinat doar căutării de informații, acesta trebuie să aibă în primul rând forma unui document de referință. Dacă este ceva pe care utilizatorii îl vor consulta de multe ori la început, secțiunea de referință trebuie să fie însoțită de o "Noțiuni de bază"secțiune și instrucțiuni privind cele mai frecvente sarcini pe care produsul va fi folosit pentru.
Câți utilizatori au experiență cu produsul sau ce îi place altora. În cazul în care produsul este nou sau semnificativ diferite de produse similare, ar trebui să înregistreze explică modul în care aceasta diferă de alte produse, precum și instrucțiuni cum să înceapă. În cazul în care produsul are caracteristici pe care alți utilizatori au de multe ori probleme cu, cum ar fi diverse aplicații informatice, aveți un mod ușor de înțeles furnizează informații și detalii corespunzătoare.

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

Când scrieți, concentrați-vă asupra nevoilor utilizatorului într-un mod pe care utilizatorul îl poate înțelege. Cu excepția cazului în care utilizatorul are un fundal tehnic, probabil că este bine să evitați limbajul foarte tehnic și să alegeți o explicație clară și simplă. De asemenea, textul trebuie să fie organizat într-un mod care să imite modul de gândire al utilizatorului - o listă a funcțiilor produsului grupate după funcție este adesea mai utilă decât funcțiile de grupare care sunt utilizate cel mai frecvent.

Uneori nu veți scăpa de utilizarea unor termeni tehnici, cum ar fi pentru o aplicație software generatoare de grafuri cu grafice Fibonacci și graficele mai plăcute și grafice. Într-un astfel de caz, este util să definiți termenul și să furnizați informații de fond, cum ar fi o explicație a graficelor Fibonacci și utilizarea lor în analiza financiară.

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

Explicați problema pe care utilizatorul încearcă să o soluționeze și apoi prezentați soluția. Oferind o funcție ca o soluție la o problemă comună funcționează bine cu un produs comercial, dar odată ce utilizatorul are produsul el vrea să afle cum să-l utilizați poate. Identificați problemele specifice pe care utilizatorul le-ar putea întâmpina, indicați-le în manualul de utilizare și urmați instrucțiunile pentru a le rezolva.

Dacă problema este complexă, împărțiți-o în bucăți mici. Efectuați o listă a fiecărei părți cu instrucțiuni pentru rezolvarea ei sau despre modul de abordare a acesteia și tratați-o secvențial. Împărțirea informațiilor în acest fel se numește "chunking".

Partea 2
Părți ale manualului de utilizare

Imaginea intitulată Crearea unui manual de utilizare Pasul 4

Adăugați paginile corespunzătoare din față și din titlu. Aveți nevoie de un capac frontal pentru fiecare manual care include mai mult decât un card de referință și o pagină de titlu pentru un manual cu mai multe informații decât o foaie de hârtie pliată (patru sau mai multe pagini).

Dacă manualul este protejat de dreptul de autor, plasați o notă privind drepturile de autor atât pe pagina de copertă, cât și pe pagina de titlu.
Dacă se utilizează manualul și produsul corespunzător, puneți-l în interiorul paginii principale.

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

Trimiteți referințe la documentele asociate în cuvântul introductiv. Dacă documentația utilizatorului conține mai mult de un manual, consultați celelalte documente de aici, cu numerele de versiune corecte. Prefața este, de asemenea, locul în care o secțiune posibilă "Cum să utilizați acest ghid" vine.

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

Adăugați un cuprins dacă manualul acoperă mai mult de 10 pagini.

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

Puneți instrucțiunile / procedurile și materialul de referință în miezul manualului. În majoritatea cazurilor, toate procedurile și materialele de referință au fiecare secțiuni proprii, dar puteți să le trimiteți utilizatorului anumitor conținuturi de la o secțiune la alta. În acest fel, utilizatorul poate găsi informațiile pe care le găsește mai rapid.

Procedurile trebuie să fie scrise într-o structură consecventă în instrucțiunile din manual. Începeți cu o prezentare generală a sarcinii, apoi descrieți ce trebuie să facă utilizatorul și ce ar trebui să observe în consecință. Etapele trebuie să fie numerotate și introduse cu verbe de acțiune, așa cum sunt scrise pașii din fiecare secțiune a acestui articol.

Materialele de referință pot conține liste de opțiuni, sfaturi, soluții și întrebări frecvente. Glosarele și indexurile pot fi incluse la sfârșitul manualului, deși o listă cu termeni frecvent utilizați poate fi afișată pe front. Indicele poate fi omis dacă manualul conține mai puțin de 20 de pagini.

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

Dacă este necesar, utilizați imagini pentru a susține textul. Imaginile grafice sau imaginile de pe ecran pot ilustra mai bine anumite puncte din manual decât text, în special în procedurile complexe în care utilizatorul are nevoie de o confirmare vizuală că pașii au fost executați corect. imagini grafice folosind un software de proiectare sau software grafica, camere digitale și software-ul de editare foto sunt produse, sau, în cazul de capturi de ecran capturate cu capacitatea de înregistrare a ecranului PC-ului sau a unui program de grafică.

Odată ce ați creat o imagine grafică, o puteți salva într-un format comprimat potrivit pentru programul dvs. de procesare de text sau pentru programul DTP. De asemenea, veți dori să reduceți dimensiunea fizică a imaginii astfel încât să se potrivească cu ușurință cu pagina, fără a sacrifica detaliile. (Dacă este necesar, puteți împărți imaginea originală în bucăți și afișați părțile relevante, împreună cu textul de susținere.)

Dacă utilizați mai multe imagini grafice în proceduri, dați-le un format consistent, cu aceleași dimensiuni pentru lungime și lățime sau reduse în același mod. Acest lucru va face ca imaginile să fie mai atractive pentru utilizator. Când realizați capturi de ecran, trebuie să vă asigurați că computerul utilizează o schemă standard de culoare atunci când captați imagini, dacă manualul utilizatorului afișează capturi de ecran color.

Deși programele grafice de editare, cum ar fi Photoshop și Paint Shop Pro au capacitatea de a lua o captură de ecran, aveți programe specifice, cum ar fi SnagIt, abilitatea de a schimba cu ușurință imagini, catalog și subtitrări.

Partea 3
Proiectați un manual de utilizare lizibil

Imaginea intitulată Crearea manualului de utilizare Pasul 9

Alegeți câteva fonturi lizibile. Deși computerele pot suporta un număr de fonturi diferite, scopul ghidului de utilizare trebuie să fie ușor de citit. Alegerea doar a unui număr mic de fonturi care se potrivesc bine împreună este cea mai bună modalitate de a atinge acest obiectiv. Fonturile pot fi împărțite în două tipuri: scrisori litere (serif) și litere sanserif (sans serif).

Fonturile scrise prezintă mici ornamente la marginile liniilor principale care formează litera. Fonturile Serif conțin fonturi precum Times New Roman, Baskerville și Book Antiqua. Fonturile Serif sunt cele mai potrivite pentru bucăți mari de text cu dimensiunea fontului de la 10 la 12 în corpul principal al unui manual tipărit.
Fonturile Sans serif reprezintă doar liniile care formează literele, fără decorare. Fonturile Sanserif includ fonturi precum Arial, Calibri și Century Gothic. Sans serif pot fi folosite pentru bucăți mari de text în dimensiuni de la 8 la 10 puncte într-un manual on-line PDF sau, deși lipsa de fraze scrise afișate în 12 puncte sau mai mari, mai greu de citit nu. Cu toate acestea, ele pot fi eficiente în format mai mare pentru afișarea titlurilor și anteturilor și sunt, de asemenea, minunate în dimensiuni mai mici pentru notele de subsol și numerele din coloane și tabele.
Utilizați în general fonturi comune, cum ar fi Arial sau Times New Roman pentru manualul de utilizare, deși puteți utiliza un font decorativ pentru citate importante sau titluri atunci când scrieți un manual pentru un joc fantastic sau sf. (În cazul citatelor de tip "eye-catcher", puteți utiliza adesea unul dintre fonturile clare și puteți redacta în italicizația citată.)
După ce ați ales anumite fonturi pe care doriți să le utilizați, puteți crea o pagină de probă pe hârtie pentru a verifica dacă fonturile se potrivesc bine împreună. De asemenea, veți dori să arătați acest exemplu persoanei care trebuie să aprobe manualul înainte de a continua să îl scrieți.

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

Acordați atenție aspectului. După ce ați ales fonturile manualului, trebuie să decideți unde va fi totul pe pagini.

În general, plasați titlul sau titlul capitolului în antet sau subsol, eventual cu titlul din pagina stângă și titlul capitolului din dreapta. De asemenea, plasați numerele paginilor în antet sau subsol, fie în dreptul frontierei (antet sau subsol), fie în mijloc (numai în subsol). Puteți să deviți fiecare primă pagină a unei secțiuni sau capitole din celelalte pagini plasând numărul corespunzător al paginii în partea de jos a paginii și celelalte pagini din partea de sus a colțului paginii.

Poate doriți să indicați un text explicativ în cutii colorate sau umbrite, pentru a le distinge de restul textului. Alegeți o culoare sau un nivel de umbrire fără o lizibilitate degradantă.

Alegeți marginile în mod rezonabil spațioase de pe toate laturile, cu spațiu suplimentar la marginile care vor fi legate între ele.

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

Gândiți-vă la tipul de legare pentru manualul de utilizare. Dacă manualul dvs. de utilizare acoperă mai mult de 4 pagini, atunci paginile trebuie să fie legate împreună într-un anumit mod. Deși un capăt în colț poate fi suficient pentru documente interne, manualele de utilizare externe care vin împreună cu un produs sunt de obicei legate în trei moduri:

Capsarea este potrivită pentru manuale compuse din foi de hârtie îndoite: 21 x 27,5 cm, 21 x 35 cm sau 27,5 x 42,5 cm. Manualele ieftine de 48 de pagini sau mai puțin sunt grupate în acest fel.

Cusatura șa este mai frecvent utilizată pentru ghidurile de referință ale terților decât pentru manualele de utilizare furnizate cu alte produse decât mașinile, deși unele manuale de utilizare mai extinse sunt legate în acest fel. (Paint Shop Pro a fost livrat inițial cu un manual de utilizare legat de cusătură în șa, când a fost încă eliberat de JASC Software).

Spiral Binding este potrivit pentru manualele de utilizare care au fost proiectate pentru a fi utilizate în medii mai dure, cum ar fi în aer liber, unde cusute sau manuale capsate ar cădea în afară. Unele manuale legate de spirală au pagini laminate pentru a preveni eșecul în cazul în care manualul devine umed sau murdar.

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

Creați un document de șablon pentru manualul dvs. oferă multe de procesare de text și desktop publishing programe pe care le posibilitatea de a crea un document șablon pentru utilizator, astfel încât pe măsură ce tastați, textul va apărea automat în fontul pe care l-ați selectat pentru secțiunea din manualul de ce faci. (De fapt, acest articol a fost scrisă inițial utilizând un șablon Microsoft Word.) Cele mai multe dintre aceste programe conțin, de asemenea, un set de template-uri predefinite pe care le puteți personaliza la nevoile tale, mai degrabă decât șablonul de la sol în sus pentru a construi.

Procesoarele de text și programele de publicare desktop oferă, de asemenea, posibilitatea de a crea stiluri, fonturi și dimensiuni predefinite pentru anteturi, subsoluri, anteturi și text simplu. Puteți alege unul dintre numele stilurilor predefinite (de exemplu, "Kop1", "Normal", "Citat") sau creați propriul stil cu propriul nume. Încercați să respectați cât mai multe convenții ale denumirilor de stil existente dacă folosiți mai multe stiluri pentru aceeași clasă de text. (De exemplu, Microsoft Word etichete stiluri de text pentru titluri, cum ar fi „rubrica 1,“ „rubrica 2,“ etc, titlul principal la diferite niveluri de subheads.) Încercați să avanseze toate stilurile, astfel încât să nu trebuie să-și întrerupă scris pentru a le încă de făcut.

sfaturi

Utilizați coduri de câmp sau variabile de text ori de câte ori este posibil. Puteți atribui valorile codurilor de câmp, cum ar fi numele unui produs, manualul sau titlul unui capitol, și plasați-l în documentul dvs., în locul textului care trebuie menționat. Când previzualizați sau imprimați manualul, variabila este înlocuită cu textul. Dacă numele produsului este modificat sau dacă schimbați numele manualului sau al unui capitol, este mai ușor să modificați informațiile ajustând valoarea variabilei text, apoi căutând și înlocuind.