DifiTsi.com

Scrieți un manual

Manualele sunt documente scrise care sunt tipărite (pe hârtie) sau electronice (PDF sau XPS) și conțin instrucțiuni despre cum să faceți sau să utilizați ceva. Deși "manualele de utilizare" sunt de obicei asociate cu tutorialele software-ului de calculator, instrucțiunile de operare se găsesc și pe computere și alte dispozitive electronice, cum ar fi computerele. Televizoare, sisteme stereo, telefoane, playere MP3, unelte de uz casnic și de grădină. Ghidurile bune de utilizare conțin informații despre caracteristicile produselor, îi învață pe consumatori să le folosească în mod corespunzător și sunt scrise într-un mod ușor de înțeles. Mai jos sunt aspectele care trebuie luate în considerare atunci când creați conținutul și aspectul unui ghid de utilizare.

metodă

Partea 1
Creați o documentație adecvată pentru utilizatori

Imaginea intitulată Creați un manual al utilizatorului Pasul 1
1
Determinați cine vă sunt instrucțiunile. Pentru a crea cu succes un ghid de utilizare, trebuie mai întâi să creați un profil al utilizatorilor ghidului dvs. fie prin crearea unui profil scris, fie prin luarea de timp pentru a face presupuneri rezonabile despre caracteristicile publicului vizat. Un astfel de profil este util dacă sunteți parte dintr-o echipă care creează documentația de utilizare și poate fi, de asemenea, utilă în dezvoltarea produsului de la concept la forma finală. Când creați un astfel de profil, rețineți:
  • În cazul în care utilizatorii vor folosi ghidul, cum ar fi acasă, la birou, la un loc de muncă la distanță sau în mașină. Acest lucru nu ar determina numai conținutul, ci și stilul în care este scris manualul.
  • Cum folosesc utilizatorii manualul. Dacă utilizatorii doresc doar să o utilizeze sporadic sau doar să caute anumite informații, ar trebui să fie scrise în primul rând ca un document de referință. Cu toate acestea, dacă utilizatorii consultă în mod constant, secțiunea de referință trebuie să fie însoțită de o secțiune introductivă și de instrucțiuni privind cele mai uzuale utilizări ale produsului.
  • Cât de multă experiență au utilizatorii cu acest produs sau cu alte produse similare? Dacă produsul este nou sau complet diferit de produsele similare, va trebui să explicați în manual cum diferă de alte produse și trebuie să furnizeze informații despre cum să începeți. Produsul se referă la dificultățile pe care utilizatorii trebuie să le trateze, cum ar fi de ex. Cu multe aplicații pentru PC, va trebui să prezentați informațiile și detaliile relevante într-o formă inteligibilă.
  • Imaginea intitulată Creați un manual al utilizatorului Pasul 2
    2
    Faceți cunoștință cu nevoile cititorilor dvs. într-un mod pe care îl înțeleg. Cu condiția ca utilizatorul să nu aibă o înțelegere puternică a tehnologiei, este mai bine să evitați terminologia tehnică și, în schimb, să vă limitați la explicații clare și simple. Textul ar trebui, de asemenea, să fie aranjat într-un mod care să urmărească modul de gândire al utilizatorului - este mai logic să enumerăm caracteristicile produsului prin funcția lor decât cele mai utilizate.
  • Uneori este imposibil să se evite termenii tehnici, cum ar fi software-ul de cartografiere care include diagrame Fibonacci, precum și diagramele mai des întâlnite și coloanele. Într-un astfel de caz, poate fi util să explicați termenii și să oferiți cunoștințe de bază, cum ar fi: o explicație a diagramei Fibonacci și a locului în care sunt utilizate.
  • Imaginea intitulată Creați un manual de utilizare Pasul 3
    3
    Descrieți problema cu care se confruntă utilizatorul și oferiți o soluție. Oferirea unei caracteristici specifice a unui produs ca soluție la o problemă generală funcționează bine în marketingul produsului, dar odată ce clientul a achiziționat produsul, el sau ea va dori să știe cum să o utilizeze. Recunoașteți problemele cu care se confruntă clienții și descrie-le în manual, urmată de instrucțiuni de rezolvare.
  • Dacă este o problemă complexă, spargeți-o în bucăți mai mici. Descrieți fiecare parte împreună cu instrucțiunile de rezoluție și continuați cu fiecare parte ulterioară. Această dezasamblare a informațiilor este, de asemenea, numită "chunking".

    • Partea 2
    Componentele unui manual

    Imaginea intitulată Crearea unui manual de utilizare Pasul 4
    1
    O pagină de titlu corespunzătoare și paginile de titlu. Este nevoie de o copertă care este mai mult decât o carte de referință rapidă și o pagină de titlu care este alcătuită din mai mult decât o foaie de hârtie îndoită (cu 4 sau mai multe pagini).
    • Dacă manualul este protejat prin drepturi de autor, acest lucru trebuie să fie menționat atât pe copertă, cât și pe prima pagină.
    • Dacă există condiții sau condiții pentru utilizarea manualului și a produsului asociat, descrieți-l în interiorul foii de acoperire.
  • Imaginea intitulată Creați un manual al utilizatorului Pasul 5
    2
    Notele cu privire la documente similare apar în prefață. Dacă documentația utilizatorului are mai mult de un ghid, faceți note despre aceste alte documente. Cuvântul introductiv include, de asemenea, secțiunea "Cum se utilizează acest ghid", dacă este cazul.
  • Imaginea intitulată Creați un manual de utilizare Pasul 6
    3
    Dacă manualul este mai lung de 10 pagini, adăugați un cuprins.
  • Imaginea intitulată Creați un manual al utilizatorului Pasul 7


    4
    Instrucțiunile și materialele de referință apar în corpul principal al manualului. În majoritatea cazurilor, instrucțiunile și materialele de referință ar trebui să aibă fiecare secțiune proprie, deși utilizatorul poate fi referit dintr-o secțiune la informații dintr-o altă secțiune. În acest fel, cititorul găsește informațiile necesare mai repede.
  • Instrucțiunile trebuie să fie scrise într-o structură consistentă. Începeți cu o prezentare generală a pasului următor, apoi descrieți ce să faceți și ce ar trebui să fie rezultatul. Etapele individuale trebuie să fie numerotate și introduse cu verbe de activitate.
  • Materialele de referință pot include o listă de completări, sfaturi de depanare și întrebări frecvente. Glosarele și indicii pot fi plasați la sfârșitul manualului, deși poate apărea și o listă de termeni tehnici recurenți la început. Un index poate fi omis dacă manualul are o lungime mai mică de 20 de pagini.
  • Imaginea intitulată Creați un manual de utilizare Pasul 8
    5
    Utilizați reprezentări grafice pentru a clarifica textul. Astfel de reprezentări pot clarifica anumiți pași mai bine decât textul simplu, în special cu instrucțiuni mai complexe, ca confirmare a faptului că utilizatorul execută corect pașii. Reprezentările grafice pot fi realizate prin desen tehnic (CAD), programe de desen, programe de editare a imaginilor și camere digitale.
  • Dacă ați făcut un astfel de grafic, salvați-l ca fiind comprimat, așa cum vă permite procesorul de text sau software-ul de publicare desktop. Ar trebui să reduceți dimensiunea imaginii atât de mult încât să se potrivească mai bine pe pagina manualului și este încă suficient de detaliată. (Dacă este necesar, împărțiți imaginea originală în bucăți mai mici și arătați partea relevantă împreună cu textul corespunzător.)
  • Dacă doriți să utilizați mai multe imagini pentru anumiți pași, asigurați-vă că aceștia au aceeași dimensiune, fie în aceeași dimensiune, fie în aceeași dimensiune, fie în aceeași dimensiune proporțională cu dimensiunea originală. Acest lucru le face atractive pentru utilizatori. Acordați atenție reprezentării corecte a culorilor pentru capturile de ecran atunci când manualul este colorat.
  • Deși programe de editare foto, cum ar fi Photoshop și Paint Shop Pro oferă capturi de ecran adecvate, programe speciale, cum ar fi SnagIt oferta, de asemenea, posibilitatea de a schimba capturi de ecran într-un mod simplu de a cataloga și pentru a le oferi comentarii.

    • Partea 3
    Creați un manual lizibil

    Imaginea intitulată Crearea manualului de utilizare Pasul 9
    1
    Alegeți câteva fonturi lizibile. Deși computerele pot afișa o varietate de fonturi diferite, scopul ghidului de utilizare este întotdeauna ușor de citit. Pentru a atinge acest obiectiv, este mai bine să alegeți doar câteva fonturi care arată bine împreună. Există două tipuri de fonturi: fonturi serif și sans serif.
    • Fonturile Serif au etichete mici pe stroke-urile fiecărei litere. Exemplele includ Times New Roman, Baskerville și Book Antiqua. Aceste fonturi sunt potrivite în special pentru piese de 10 până la 12 puncte din corpul principal al unui manual tipărit.
    • Fonturile Sans Serif nu au ornamente. Exemplele sunt Arial, Calibri și Gothic Century. Acest lucru ar putea fi folosit pentru bucăți de text de 8 până la 10 puncte într-un manual PDF sau pe web, deși ornamentele lipsă fac seturi de 12 puncte sau mai puțin lizibile. Cu toate acestea, ele pot fi utilizate în dimensiuni mai mari pentru titluri și dimensiuni mai mici pentru notele de subsol și numerele din diagrame.
    • În general, ar trebui să utilizați fonturi simple, cum ar fi Utilizați Arial sau Times New Roman pentru manualul dvs. Scrieți un manual, de ex. Pentru un joc video fantezie, puteți utiliza și fonturi decorative pentru titluri.
    • După ce v-ați hotărât cu privire la fonturile pe care doriți să le utilizați, creați o pagină de test pentru a vă asigura că diferitele fonturi funcționează bine împreună. De asemenea, ar trebui să arătați acest lucru persoanei responsabile pentru imaginea generală a manualului înainte de a continua.
  • Imaginea intitulată Creați un manual de utilizare Pasul 10
    2
    Gândiți-vă la aspect. Odată ce ați decis cu privire la fonturi, trebuie să decideți pe ce pagini elementele ar trebui să fie.
  • În mod normal, titlul manualului sau al capitolului va apărea în antet sau subsol, adesea cu titlul manual din stânga și titlul capitolului din dreapta. De asemenea, numărul de pagini va ajunge, de obicei, în antet sau subsol, fie la marginea exterioară (atât în ​​antet, cât și în subsol) sau centrat (numai când este utilizat în subsol). Puteți face numărul primei pagini a unei secțiuni sau a unui capitol distinct de celelalte prin plasarea lor în mijlocul subsolului și numerele paginilor ulterioare din colțurile exterioare ale antetului.
  • Notele pot fi plasate în cutii colorate sau umbrite pentru a le distinge de restul textului. Dar folosiți culori sau nuanțe care nu fac textul necitit.
  • Utilizați distanțe laterale rezonabile cu mai multă marjă la marginea în care este legată cartea.
  • Imaginea intitulată Creați un manual al utilizatorului Pasul 11
    3
    Gândiți-vă la modul în care instrucțiunile dvs. sunt legate. Dacă manualul conține mai mult de patru pagini, acestea trebuie să fie într-un fel legate. Deși documentele interne sunt adesea capsate la un colț, este obișnuit ca manualele de însoțire ale unui produs să fie legate într-unul din cele trei moduri:
  • Capsarea paginilor este frecventă în manuale constând din foi pliate de dimensiuni 21x27,5 cm, 21x35 cm sau 27,5x42,5 cm. Cele mai ieftine manuale cu 48 sau mai puține pagini sunt legate în acest fel.
  • Legarea cusăturii în șa este mai puțin folosită în manualele de utilizare, deși câteva manuale de utilizare mai lungi sunt legate în acest fel (originalul Paint Shop Pro produs de JASC Software a fost livrat împreună cu o broșură legată de șa).
  • Legăturile spirale pot fi găsite în manuale care sunt mai susceptibile de a fi utilizate în medii mai aspre, de ex. în sălbăticie, pentru că celelalte tipuri de atașament nu ar suporta aceste poveri. Unele manuale legate de spirală au de asemenea laturi laminate pentru a le proteja de umiditate și murdărie.
  • Imaginea intitulată Creați un manual al utilizatorului Pasul 12
    4
    Utilizați șablonul când creați manualul. Multe procesoare de texte oferă posibilitatea de a crea un șablon pentru manualul dvs. În timpul creării textului, va apărea un șablon în fontul ales.
  • Multe procesoare de texte oferă, de asemenea, posibilitatea de a crea stiluri, stiluri de fonturi presetate și dimensiuni pentru anteturi, subsoluri, titluri și textul principal. Puteți alege unul dintre șabloane (de exemplu, "Rubrică 1" ...) sau creați și denumiți propriul șablon. Pe cât posibil, urmați convențiile de denumire a acestor "stiluri" dacă aveți mai multe dintre ele pentru același tip de text. Încercați să creați toate șabloanele de care aveți nevoie în avans pentru a vă economisi timp.

    • Sfaturi

    • Utilizați cheile de câmp sau variabilele de text ori de câte ori este posibil. Puteți atribui valori acestora, cum ar fi numele produsului, titlul manualului sau al capitolului și folosiți-l în text în loc să scrieți lucrurile. Dacă priviți șablonul sau imprimați textul, va apărea textul actual în locul numărului. Dacă se modifică numele produsului sau se modifică titlul manualului sau al capitolului, va fi mai ușor să modificați informațiile schimbând variabilele decât să căutați și să înlocuiți fiecare informație.

    Ce ai nevoie

    • Procesor de text sau program de publicare desktop
    • Program de editare a imaginilor sau un program pentru crearea de capturi de ecran
    Distribuiți pe rețelele sociale:

    înrudit