1
Cunoașteți produsul dvs. Înainte de a vă explica altora cum să o utilizați, trebuie să o cunoașteți și să o înțelegeți complet.
2
Aflați scopul unui manual al utilizatorului. Ele sunt în esență scrise pentru 1 până la 4 motive: să instruiască utilizatorul să utilizeze produsul - să scadă costurile suportului - să facă publicitate - sau să îmbunătățească imaginea companiei. Scopul lor va afecta modul în care acestea vor fi scrise.
3
Faceți o analiză a publicului. Manualul de utilizare trebuie să fie scris publicului care îl va citi. Analiza va spune cine va fi principalul public țintă și va îndruma scrierea lor. Niciodată nu puteți să-i mulțumim pe toată lumea - ideea este să servească țintă sau cât mai mulți oameni posibil.
4
Organizează manualul logic. Ar trebui să urmați pașii de utilizare a produsului. Împărțiți-le în capitole sau secțiuni pentru a avea sens.
5
Includeți toate părțile necesare. Manualele de utilizare pot fi făcute cu numeroase piese, inclusiv o copertă frontală, un index, o listă de imagini sau tabele, o introducere, capitole, anexe, un glosar, un index și o copertă din spate. Introducere, capitole și capace sunt necesare în toate manualele.
- Un indice este necesar în manualele mai lungi.
- Este necesar un glosar sau un index atunci când există mai mulți termeni care să-i explice publicului, care poate să nu fie familiarizat cu aceștia.
- O listă de tabele sau imagini este necesară numai dacă există mai mult de câteva în întregul manual.
- Este necesară o anexă pentru lucruri care ar trebui explicate, dar nu pot fi în altă parte în manual deoarece ar întrerupe fluxul și focalizarea.
6
Discutați cu publicul dvs. cu termenii pe care îi vor înțelege. Termenii tehnici pot fi intimidanți și neînțelegeri. Efectuați un glosar al celor din manual.
7
Consultați manualul. Poate pierde credibilitatea datorită greșelilor gramaticale și ortografice. Cereți unui coleg sau unui prieten să o citească și ei. Acest pas poate fi repetat de mai multe ori.
8
Dă-l aprobat. Procesul de aprobare va depinde de structura organizației dvs. Cine poate face acest lucru poate fi șeful dvs., șeful departamentului tehnic de scriere sau comunicare sau designerii de produse.