Conţinut

• A calca
• Partea 1 din 4: Planificarea manualului proprietarului
• Partea 2 din 4: Încorporați informații esențiale
• Partea 3 din 4: Descrierea întreținerii produsului
• Partea 4 din 4: Scrieți un manual lizibil
• sfaturi

Software-ul, computerele, jocurile și dispozitivele necesită manuale de utilizare; ghiduri care explică modul de utilizare a produsului (și cum nu). Un manual de utilizare este un document formal cu o structură specifică și trebuie scris de cineva care cunoaște produsul din afară, cum ar fi un scriitor tehnic sau proiectantul produsului. Scrierea unui manual de utilizare eficient necesită să știți cine va folosi produsul și să scrieți manualul având în vedere acești utilizatori. Păstrați-vă scrisul clar, precis și simplu pentru a vă asigura o experiență de utilizare fără probleme.

A calca

Partea 1 din 4: Planificarea manualului proprietarului

1. Faceți o analiză a utilizatorului. Manualul de utilizare trebuie scris pentru utilizatori - cei care vor cumpăra produsul sau serviciul dvs. și vor citi manualul de utilizare. O analiză a utilizatorului vă va spune cine va fi publicul dvs. principal sau țintă și vă va ghida prin scrierea textului.
   • Discutați cu persoanele care vă vor folosi dispozitivul. Oferiți utilizatorilor prototipuri de testare ale dispozitivului și proiectați manualul utilizatorului în condiții controlate. Cereți acestor utilizatori de test feedback pentru lucruri care sunt neclare sau confuze în ghidul utilizatorului și faceți modificări în ghidul dvs. de utilizare pe baza acestui feedback.
   • Nu vă puteți satisface niciodată întregul public; scrieți manualul adaptat publicului țintă sau celui mai mare public.
   • Luați în considerare vârsta, sănătatea (au vreo boală, dizabilități de învățare sau dizabilități?) Și nivelul de educație al audienței pentru a determina cea mai bună abordare a scrierii manualului de utilizare.
2. Coordonează proiectarea manualului de utilizare. Dacă ați făcut parte din echipa care a ajutat la proiectarea și dezvoltarea dispozitivului sau produsului, poate fi dificil să aruncați o privire obiectivă asupra produsului pentru a explica cum funcționează. Prin urmare, ar trebui să solicitați sfatul unui scriitor (de preferință al unei persoane cu experiență în scrierea instrucțiunilor) și a unui grafician pentru a vă ajuta să pregătiți manualul de utilizare. Puteți alege aceste persoane printr-o consultanță externă sau de la propria companie sau organizație.
3. Faceți o analiză a sarcinilor. Analiza locului de muncă este procesul de identificare și organizare a pașilor necesari utilizării dispozitivului. O analiză detaliată a lucrărilor identifică materialele și echipamentele (cum ar fi bateriile, medicamentele sau alte produse furnizate de utilizator) necesare pentru fiecare etapă, precum și acțiunile, erorile și sfaturile de depanare pe care fiecare pas ar putea să le necesite.
   • Dacă aveți un produs care poate efectua mai multe sarcini sau subtaskuri diferite, trebuie să efectuați o analiză a sarcinilor pentru fiecare sarcină. De exemplu: într-o mașină puteți claxona, vă puteți prinde și vă puteți aprinde sau opri farurile. Faceți o analiză a postului pentru fiecare dintre acestea, dacă este necesar.
4. Asigurați-vă că produsul dvs. îndeplinește cerințele pentru etichetare și autorizație de introducere pe piață. Aceste cerințe asigură faptul că produsele sunt fabricate având în vedere siguranța utilizatorului și că expunerea utilizatorului la condiții periculoase, cum ar fi radiațiile și electrocutarea, este limitată. Anunțurile trebuie să precizeze în mod clar scopul și liniile directoare de operare de bază ale unui produs și ar trebui să utilizați aceste resurse atunci când scrieți manualul proprietarului.
   • Pentru ca manualul de utilizare al unui produs să fie eficient, acesta trebuie scris în conformitate cu etichetele aplicate direct pe produs.
   • Asigurați-vă că dispozitivul dvs. este licențiat oficial pentru vânzare înainte de a scrie manualul de utilizare.
5. Decideți aspectul manualului dvs. Există mai multe moduri importante de a vă simplifica manualul. Trebuie să puneți un titlu îndrăzneț la începutul fiecărei secțiuni cu fiecare cuvânt cu majuscule. De exemplu, „Configurați dispozitivul”, „Operați dispozitivul” și „Depanare” pot fi toate titluri de secțiune îndrăznețe.
   • Un alt mod de a vă simplifica ghidul este să utilizați două coloane, una în dreapta cu text și cealaltă chiar în stânga textului, cu gloanțe, numere sau pictograme mici, cum ar fi semnele de avertizare sau semnele roșii de exclamare.
   • Manualul poate consta în principal din imagini cu un anumit text sub fiecare imagine pentru a explica dispozitivul sau poate fi în principal text cu doar câteva imagini însoțitoare. De asemenea, puteți utiliza o diagramă pentru a ghida utilizatorul. Gândiți-vă la produsul dvs. și la modul în care fiecare metodă vă poate ajuta să scrieți manualul. Cu toate acestea, evitați să amestecați diferite machete într-un singur manual. Alegeți una și rămâneți cu ea.

Partea 2 din 4: Încorporați informații esențiale

1. Organizați manual manualul. Manualul ar trebui să fie structurat astfel încât utilizatorul să obțină cele mai multe beneficii din acesta. Împărțiți manualul în capitole sau secțiuni care au sens pentru utilizarea produsului și includeți un cuprins în partea din față a manualului, astfel încât fiecare secțiune să poată fi găsită rapid.
   • Un cuprins este necesar în special pentru manuale mai lungi.
   • Este necesar un glosar sau un index dacă există mulți termeni care să explice că publicul dvs. poate să nu fie familiarizat. Cu toate acestea, nu este recomandat un glosar; cea mai bună alegere este de a explica termeni confuzi în textul manualului în sine. Dacă alegeți să includeți un glosar, plasați-l în partea din față a manualului, imediat după cuprins.
   • O listă de tabele sau figuri este necesară numai dacă există mai multe tabele sau figuri în manual.
   • Este necesară o anexă pentru lucrurile care trebuie explicate, dar care nu pot fi explicate în altă parte în manual, deoarece ar perturba fluxul și concentrarea.
2. Includeți avertismentele necesare. Avertismentele generale sau informațiile de precauție ar trebui să furnizeze informații despre pericolele potențiale cauzate de utilizarea necorespunzătoare a produsului, inclusiv decesul sau vătămarea gravă. Aceste avertismente trebuie plasate chiar în partea din față a manualului, după prima pagină, astfel încât utilizatorul să le vadă mai întâi. Avertismentele specifice ar trebui, de asemenea, să fie incluse în textul manualului imediat după sau chiar înainte de sugerarea unui pas potențial periculos.
   • De exemplu, un avertisment general pentru un aparat electric ar putea fi să nu îl folosiți când plouă.
   • O instrucțiune specifică ar putea fi să vă asigurați că atât mâinile cât și dispozitivul sunt uscate înainte de a conecta dispozitivul la priza de curent.
   • Furnizați imagini (cum ar fi un craniu și oase încrucișate) sau text de altă culoare (cum ar fi textul roșu) pentru a distinge avertismentul de restul direcțiilor din IFU și pentru a atrage atenția utilizatorilor asupra acestuia.
3. Descrieți dispozitivul. Descrierea dvs. ar trebui să includă atât o explicație scrisă a scopului dispozitivului, cât și o mică reprezentare grafică a aspectului dispozitivului. Figura trebuie să eticheteze și să denumească toate comutatoarele, butoanele și piesele atașabile conținute în dispozitiv.
4. Furnizați instrucțiuni de instalare. Secțiunea de instalare trebuie să conțină informații de bază despre modul de pregătire pentru utilizarea produsului sau dispozitivului. Dacă aparatul nu poate fi construit sau configurat de un utilizator casnic, menționați-l clar într-un titlu aldin în partea de sus a secțiunii de instalare. De asemenea, ar trebui să includeți următoarele:
   • O listă de piese
   • Instrucțiuni de despachetare
   • Avertismente de instalare
   • Consecințele instalării incorecte
   • Cui să apelați în caz de dificultăți în timpul instalării
5. Furnizați informații despre operațiune. Această secțiune este cea mai importantă parte a manualului de utilizare și ar trebui să furnizeze informații concrete și detaliate despre modul de utilizare a dispozitivului. Începeți cu pregătirea de bază pentru utilizarea unității, cum ar fi conectarea cablului de alimentare sau spălarea mâinilor. Continuați cu pași logici, numerotați, care descriu modul de utilizare a dispozitivului, precum și orice feedback (de exemplu, „Veți auzi un clic ...”) la care utilizatorul se poate aștepta atunci când folosește dispozitivul corect.
   • La sfârșitul acestui capitol, utilizatorii ar trebui să fie direcționați la capitolul de depanare pentru a rezolva problemele care nu pot fi explicate rapid.
   • Plasați imaginile acolo unde este necesar. Unii pași sunt cel mai bine explicați atât cu imagini, cât și cu cuvinte. Luați în considerare utilizarea fotografiilor sau ilustrațiilor din manualul dvs.
   • În această secțiune, ca în orice secțiune, trebuie să includeți avertismente de siguranță relevante cu privire la utilizarea sau funcționarea necorespunzătoare. De exemplu, puteți avertiza utilizatorii ferăstrăului cu lanț să nu bea alcool sau să folosiți ferăstrăul cu lanț în timp ce luați anumite medicamente.
   • Dacă credeți că utilizatorii vor beneficia, luați în considerare includerea de linkuri către videoclipuri online care demonstrează utilizarea și funcționarea corectă a dispozitivului. Puteți înregistra aceste videoclipuri fie la începutul acestei secțiuni, fie (în cazul videoclipurilor care ilustrează un singur pas) la sfârșitul fiecărui pas.
6. Includeți un rezumat al produsului la final. Rezumatul trebuie să apară la sfârșitul manualului, chiar înainte de index, pentru a oferi pași de operare de bază. Aceasta ar trebui să fie o versiune simplificată, dezactivată a informațiilor operaționale și să nu aibă mai mult de o pagină. Rezumați modul de utilizare a dispozitivului sau produsului. Includeți alerte de bază, pași numerotați care explică modul de utilizare a produsului și numere de telefon sau adrese de e-mail care îi orientează pe utilizatori să vă ajute.
   • Dacă vă așteptați ca utilizatorul să elimine sau să consulte deseori foaia de rezumat, o puteți imprima pe un card laminat detașabil sau un carton gros pentru a facilita transportul și consultarea acestuia.
   • Alternativ, puteți aplica un rezumat direct produsului pentru o referință rapidă și ușoară de către utilizator.

Partea 3 din 4: Descrierea întreținerii produsului

1. Explicați cum să curățați dispozitivul. Dacă dispozitivul sau produsul dvs. trebuie curățat, explicați cum să faceți acest lucru. Enumerați agenții de curățare necesari. Spuneți cititorului cât de des să curățați. Apoi, ca în orice altă parte a manualului, includeți instrucțiuni numerotate pas cu pas despre cum să îl curățați.
   • Dacă curățarea necesită demontarea produsului sau îndepărtarea unei anumite părți, indicați modul în care produsul trebuie demontat.
   • Oferiți un avertisment cu privire la rezultatele eșecului la curățarea dispozitivului. De exemplu, ați putea spune „Dacă dispozitivul nu este curățat, performanța va fi mai puțin decât optimă”.
2. Numărați utilizatorul cum să efectueze întreținerea de bază. Dacă produsul sau dispozitivul este reparabil de către utilizator pentru a corecta problemele de performanță, furnizați instrucțiuni numerotate despre cum să faceți acest lucru pentru utilizator. De exemplu, dacă bateriile trebuie înlocuite după fiecare 300 de ore de utilizare, furnizați instrucțiuni despre cum să verificați dacă bateriile trebuie înlocuite, cum să scoateți bateriile moarte și cum să instalați cele noi.
   • Dacă există anumite sarcini de întreținere care pot fi efectuate numai de un tehnician certificat, împărțiți partea de întreținere a manualului în două părți.
3. Discutați despre opțiunile de stocare. Dacă este necesar, manualul ar trebui să explice cum se păstrează corect produsul sau dispozitivul. ar trebui să includeți, de asemenea, informații despre motivul pentru care este necesară stocarea și consecințele stocării necorespunzătoare. De exemplu: ai putea scrie:
   • Păstrați produsul într-un loc răcoros și uscat. Depozitarea necorespunzătoare poate scurta durata de viață a produsului dvs. din cauza acumulării de umiditate. "
   • „Nu expuneți produsul la căldură și nu îl depozitați la temperaturi de peste 50 de grade Celsius.Dacă o faceți, aceasta poate duce la arderea ".
4. Furnizați informații de depanare. Puteți organiza această secțiune ca o listă a problemelor obișnuite și a soluțiilor acestora. Grupați probleme similare sub o rubrică logică. În acest fel, utilizatorii pot găsi rapid probleme specifice.
   • De exemplu, dacă există mai multe probleme cu computerul care afișează un ecran albastru, grupați-le sub o subpoziție, cum ar fi „Probleme obișnuite de ecran”.
   • De asemenea, trebuie să includeți un număr de telefon și / sau un e-mail pentru serviciul de asistență pentru clienți în această secțiune.

Partea 4 din 4: Scrieți un manual lizibil

1. Citiți alte ghiduri de utilizare. Înainte de a scrie un manual pentru propriul produs, consultați alte ghiduri de utilizare eficiente. Acordați atenție structurii, alegerii cuvintelor și structurii propoziției. Marci majore precum Apple, Google și Microsoft produc ghiduri de utilizare puternice și eficiente, care vă pot ajuta să produceți un ghid de utilizare mai atent gândit.
   • Nu citi doar toate manuale de utilizare. Citiți manualele pentru produsele similare pe care le vindeți. De exemplu, dacă vindeți produse pentru copii, citiți manualele pentru copii, nu tehnice.
2. Selectați-vă standardele. Standardizarea ortografiei, alegerea cuvintelor și formularea vor face ca manualul de utilizare să fie mai ușor de utilizat. Manualul de stil Chicago și Manualul stilului Microsoft pot fi, de asemenea, ghiduri de stil utile atunci când scrieți manualul proprietarului; verificați ambele pentru a vedea dacă unul este potrivit pentru manualul dvs.
   • De exemplu, în loc să utilizați atât „comutatorul de alimentare”, cât și „butonul de alimentare” în manual, alegeți unul dintre cei doi termeni și rămâneți la el.
3. Folosiți vocea activă. Vocea activă este un mod de a scrie care explică lucrurile din perspectiva utilizatorului. Este mai ușor de înțeles decât alternativa, vocea pasivă, în care subiectul este nedefinit.
   • Încercați aplicația Hemingway (www.hemmingwayapp.com) pentru a identifica pasaje pasive în scrierea dvs.
   • Studiați aceste două exemple de propoziții - prima este activă și a doua este pasivă:
     • Trebuie să deschideți pachetul încet și cu atenție.
     • Pachetul trebuie deschis lent și cu atenție.
4. Scrieți instrucțiuni numerotate. Instrucțiunile comandate numeric ajută cititorul să se concentreze mai bine asupra procesului de utilizare, conectare sau construire a produsului în cauză. În loc să scrieți un paragraf lung, detaliat sau o serie de paragrafe nenumerotate, scrieți ghidul dvs. de utilizare cu pași simpli, expliciți, fiecare numerotat clar.
5. Începeți fiecare pas cu un imperativ. Un imperativ este un verb orientat spre acțiune. Începând fiecare pas cu un verb, îi dați cititorului un indiciu despre acțiunea necesară pentru a finaliza pasul. De exemplu, în funcție de produsul despre care scrieți, puteți începe pașii cu o comandă precum „Conectare”, „Confirmare” sau „Slide”. Cu toate acestea, nu începeți pașii cu un răspuns din partea sistemului.
   • De exemplu, dacă ecranul devine albastru și începe să clipească, nu porniți pasul cu: „Ecranul va clipi și va deveni albastru.” Încercați: „Țineți apăsată tasta Acasă. Ecranul va clipi și va deveni albastru. "
6. Stabiliți vocabularul pe care îl veți folosi. Dacă scrieți un manual de yo-yo, publicul dvs. va fi în mare parte copii mici. Folosiți cuvinte simple și vocabular pentru a explica modul în care funcționează yo-yo. Când scrieți un manual de microscop electronic cu scanare, audiența dvs. este formată din oameni de știință foarte calificați, care pot înțelege informații foarte detaliate, așa că nu vă feriți să folosiți vocabular specializat sau explicații nuanțate.
   • În general, încercați să evitați jargonul și limbajul tehnic.
   • Pentru a fi eficient pentru cea mai largă bază de utilizatori, încercați să scrieți la un nivel de clasa a șasea până la a șaptea a școlii primare.
7. Când expediați un produs în străinătate, asigurați-vă că traducerile dvs. sunt corecte. Angajați un traducător pentru a traduce manualul de utilizare în limba maternă a țării în care livrați produsul. De asemenea, puteți utiliza un program de traducere online, dar rugați un vorbitor nativ să citească traducerea și să verifice dacă există erori.
   • Dacă în publicul dvs. sunt reprezentate mai multe grupuri de limbi, vă rugăm să includeți traduceri ale manualului de utilizare în fiecare limbă relevantă.
   • Traducătorul trebuie să fie familiarizat cu produsul, deoarece pot exista cuvinte diferite în limba țintă pentru termeni specifici care nu sunt traduceri cuvânt cu cuvânt.
8. Scrieți în propoziții scurte. În loc de câteva paragrafe lungi, folosești o mulțime de paragrafe scurte. Căutați pauze logice în fiecare secțiune și digerați informații utile în bucăți cu una sau două fraze. Același lucru este valabil și la nivelul propoziției. Păstrați-vă propozițiile scurte și simple, mai degrabă decât lungi și detaliate.
   • Dacă un pas devine prea lung, împărțiți-l în pași mai mici. Acest lucru nu va reduce numărul de cuvinte, dar întreruperile de linie vor ușura citirea.
9. Verificați manualul pentru erori. Un manual își poate pierde credibilitatea din cauza erorilor de gramatică și de ortografie. Solicitați unui coleg sau scriitor tehnic să editeze și să corecteze manualul. În plus față de ortografie și gramatică, un corector ar trebui să acorde atenție la următoarele:
   • Voce pasivă
   • Limbaj neclar sau confuz
   • Structura propoziției încheiate
   • Paragrafe prea lungi

sfaturi

• Oamenii învață în moduri diferite; Dacă este posibil și adecvat, includeți ajutoare vizuale sau linkuri către videoclipuri online în manual pentru a găzdui cititori orientați vizual.