Pasul 1 a Obține Cunoștințe Generale privind Manualul de Utilizare Șablon
Înainte de fapt, folosind Manualul de Utilizare Șablon și alte instrumente pe care l-am dezvoltat pentru Philip, am vrut să ne asigurăm că avem același punct de plecare. I-am furnizat câteva informații generale despre instrucțiunile utilizatorului și câteva exemple bune de manuale de utilizare existente.
am enumerat aceste informații mai jos.,
care este definiția unui manual de utilizare?
un manual de utilizare este un document tehnic de comunicare destinat să ofere asistență oamenilor cu privire la modul de utilizare a unui produs. Un manual de Utilizare bun ajută utilizatorii să utilizeze un produs în siguranță, sănătos și eficient.,alte denumiri sau alte forme ale unui manual de utilizare ar putea fi:
- Ghid de Utilizare
- documentație tehnică
- Manual de instrucțiuni
- manual operațional
- Manual de instruire
- Ghid de pornire rapidă
- Manual de instalare
- Manual de întreținere
- Manual De pentru a ajuta un utilizator), obiectivele secundare ar putea fi crearea unei experiențe mai bune a utilizatorului și îndeplinirea cerințelor legale.
un manual de utilizare este format din informații vizuale textuale (ilustrații, capturi de ecran, tabele etc.).,) pentru a ajuta utilizatorul în îndeplinirea sarcinilor specifice.
utilizatorul joacă rolul central atunci când întocmește un manual de utilizare. Un manual de Utilizare bine elaborat oferă numai informațiile relevante pentru utilizatorul intenționat al produsului.manualul de utilizare trebuie să conțină atât informații procedurale (instrucțiuni pas cu pas), cât și informații conceptuale (informații de care utilizatorul are nevoie pentru a înțelege informațiile procedurale).un manual de Utilizare bun este concis și folosește un limbaj fără jargon. Un manual de Utilizare bun ar trebui să răspundă cum și ce întrebări., Acestea ar trebui să conțină informații despre ce se întâmplă dacă o sarcină nu este făcută corect.în unele cazuri, un produs este destinat utilizării de către diferite tipuri de utilizatori. Tipurile tipice de utilizatori sunt utilizatorul final, instalatorul, inginerul de întreținere și operatorul. Fiecare tip de utilizator are nevoie de o abordare diferită în ceea ce privește limbajul care trebuie utilizat, tonul vocii și informațiile conceptuale furnizate.
ce informații ar trebui să fie într-un manual de utilizare?
diferite tipuri de produse au nevoie de un manual de utilizare. Un produs poate fi un sistem, un instrument, un dispozitiv, un instrument, un software sau o aplicație.,arnings
- instructiuni de Instalare
- Descrierea cum să utilizeze/opereze produsului
- secțiunea de Depanare și instrucțiuni privind modul de a rezolva problemele
- informații de Întreținere
- informații de Reparare
- Informații privind eliminarea produsului și a ambalajului
- specificatii Tehnice
- cuprins
- Index
- Glosar
- informații de Garanție
- Contact
Folosind un manual de utilizare șablon
principalul instrument pe care l-am dezvoltat în scopul de a ajuta Philip își redacteze manual de utilizare este un Manual de Utilizare Șablon., Șablonul conține toate informațiile și mai mult din lista de mai sus. Acesta respectă cerințele pentru produsul său.șablonul Manual de utilizare poate fi utilizat pentru crearea manualului pentru sistem, instrument, dispozitiv, instrument sau pentru crearea unui manual de instalare, manual software, manual operațional, manual de întreținere sau manual de instruire.pe baza primului șablon pentru Philip, am dezvoltat șabloane pentru următoarele grupe de produse:
- dispozitive medicale
- jucării
- mașini
- electronice
ce formate are un manual de utilizare?,
manualele de utilizare pot fi furnizate fie în format de hârtie, fie ca document electronic (PDF sau plasate online sau pe dispozitiv în HTML). Șablonul manual de utilizare este un document MS Word care poate fi tipărit sau plasat online.manualele de utilizare pot fi create folosind o varietate de instrumente. Fiecare instrument are propriile avantaje și dezavantaje., conținutul posibil
Toate într-o singură soluție
Omni-platforma de publicații
Conține implicit manual de utilizare șabloane
manual de Utilizare exemple
în Timp ce elaborarea unui manual de utilizare cu ajutorul Manualului de Utilizare Șablon, acesta poate fi la îndemână pentru a avea unele exemple bune., Prin următoarele link – uri puteți descărca un eșantion manual de utilizare pentru documentare:
- instrucțiuni de instalare IKEA
- Jura manual de utilizare
Pasul 2 Identificați utilizatorii șablonului Manual de Utilizare
Ok, deci acum Philip are câteva cunoștințe de bază despre manualele de utilizare. Să ne scufundăm în detalii și acțiuni.când doriți să scrieți un manual care vă ajută utilizatorul să rezolve problemele, trebuie mai întâi să definiți cine este utilizatorul dvs. Acest lucru se poate face prin crearea unui profil de utilizator, numit și persona.,cu o persoană, faceți câteva presupuneri rezonabile cu privire la caracteristicile utilizatorului dvs. Acest lucru nu este util doar pentru crearea instrucțiunilor dvs. de utilizator, dar este un element esențial la începutul dezvoltării oricărui produs! Ca inginer de proiectare industrială educat, așa am început toate sarcinile noastre de proiectare.la verificarea site-ului ISOVOX, nu am găsit nici măcar o descriere clară a utilizatorilor vizați. De aceea l-am rugat pe Philip să-și definească utilizatorii și să răspundă la întrebări precum:
- cine este utilizatorul produsului dvs.?,
- este produsul utilizat profesional sau în principal privat?
- ce alte experiențe tehnice au? Ce descrie utilizatorul?
am creat un șablon care conține întrebările. L-am rugat pe Philip să completeze șablonul.
puteți utiliza singur șablonul pentru a determina cine este utilizatorul dvs. Vă rugăm să rețineți că a doua filă conține și răspunsurile lui Philip, deci aveți un exemplu despre cum ar putea fi folosită foaia.
acțiune: Utilizați șablonul pentru a descrie utilizatorii.sunt un mare fan al vizualizării lucrurilor., Deci, dacă doriți să luați definirea utilizatorului cu un pas mai departe, aș sugera să vizualizați utilizatorul sub forma unei persona. Atunci când creați o persoană, dați utilizatorului dvs. un nume, vârstă și altele, astfel încât acesta devine o persoană reală care reprezintă utilizatorul dvs.am făcut asta pentru Philip., Acesta este rezultatul:
Acțiune: a Crea o vizualizare de utilizator
Dacă vrei să știi mai multe despre definirea publicului și crearea de personas:
Pasul 3 Crearea de Subiecte pentru Dvs. de Utilizator Probleme
Începe cu identificarea problemelor cu care dvs. de utilizator(s) s-ar putea întâlni în timpul ciclului de viață al produsului și că el/ea vrea să rezolve. Problemele tipice pot include: instalarea produsului, utilizarea produsului, utilizarea produsului în siguranță, întreținerea produsului și eliminarea produsului.,dacă problema este prea complexă, o puteți descompune în bucăți.l-am rugat pe Philip să identifice problemele și soluțiile pe care le-ar putea întâmpina utilizatorul său în timpul ciclului de viață al produsului. Pentru a face acest lucru, am creat un alt șablon pentru Philip. În coloana din stânga a filei ciclu de viață, sunt menționate etapele ciclului de viață al unui produs. Acestea sunt derivate din standardul internațional pentru instrucțiuni de utilizare, IEC/IEEE 82079. Șabloanele noastre manuale de Utilizare sunt conforme cu acest standard.în fila ciclu de viață vedeți modul în care Philip a ajustat ciclul de viață la propriul său produs.,
acțiune: Utilizați acest șablon și instrucțiunile din prima filă pentru a identifica problemele pe care utilizatorul le-ar putea avea pe parcursul ciclului de viață al produsului dvs. și pentru a prezenta soluțiile acestora.,
Dacă vrei să știi mai multe despre definirea utilizatorului probleme și crearea de subiecte:
- Subiect pe baza de autor
- Minimalism
- Informații de cartografiere
- Chunking
Pasul 4 Definesc Structura de Manual de Utilizare Șablon
Filip a identificat problemele pe care un utilizator ar putea avea cu produsul său în timpul ciclului său de viață și el a crezut de soluție pentru a rezolva problema. Cu alte cuvinte: Philip a definit subiectele pentru manualul său de utilizare., Fiecare subiect poate fi doar despre un anumit subiect, are un scop identificabil, și trebuie să fie capabil să stea singur.
un subiect ar trebui să dea răspunsul la întrebarea unui singur utilizator. Un utilizator vrea să rezolve o problemă la un moment dat. Când un utilizator a rezolvat problema, el / ea va merge și va rezolva următoarea problemă.
un subiect va deveni o secțiune în manualul de utilizare. Poate fi un capitol sau un (sub)paragraf. De îndată ce un utilizator caută un răspuns la problema sa, va folosi cuprinsul pentru a afla cum să navigați la acel răspuns.,l-am rugat pe Philip să structureze subiectele și să le definească locul în manualul de utilizare, atribuind un anumit subiect unui anumit capitol sau (sub)paragraf. Rezultatul poate fi văzut în fila ToC.
acțiune: pentru a defini structura manualului de utilizare:
- Copiați conținutul din fila ciclu de viață în fila ToC.
- în fila ToC, înlocuiți Numele produsului cu propriul nume de produs.
- adăugați o coloană la stânga. Denumiți-l „secțiune”.
- dacă este cazul, organizați secțiunile în mod logic.
- determinați ce subiecte vor deveni capitole adăugând numere de capitole., Începeți numerotarea preparării produsului pentru utilizare cu numărul 4. Vom adăuga câteva capitole în pasul următor.
- determinați ce subiecte vor deveni paragrafe adăugând numerele secțiunii.
- determinați ce subiecte vor deveni sub-paragrafe adăugând numerele subsecțiunii.
ați creat acum cuprinsul (ToC). ToC este conturul manualului dvs. de utilizare. Mai târziu vom adăuga câteva subiecte/secțiuni, cum ar fi introducerea, informații despre siguranță etc., deci nu vă faceți griji despre adăugarea că acum.,
Pasul 5 creați titluri semnificative
fiecare subiect din manualul de utilizare are propriul titlu. Titlurile sunt titlurile (sub-)care preced textul propriu-zis. Ele apar în ToC, astfel încât utilizatorul să poată naviga la informațiile necesare.deci, Philip tocmai a creat (sub-)titlurile pentru subiectele sale.
deoarece intrările ToC joacă un rol atât de important în a ajuta utilizatorul să-și găsească drumul și pentru a-l ajuta să sară ceea ce nu este important, au nevoie de un pic mai multă atenție.practic, ar trebui să încercați să lucrați cu trei niveluri de rubrici: rubrici de nivel întâi, al doilea și al treilea.,
titlul primului nivel descrie despre ce este vorba în întregul capitol sau secțiune (de exemplu, instalarea produsului). Rubricile de nivelul al doilea ar trebui să utilizeze „Cum ce” stil de frazare (de exemplu, modul de asamblare a produsului și modul de a face instalația electrică). O rubrică de nivelul al treilea folosește expresii substantivale (de exemplu, conținutul ambalajului și instrumentele care trebuie utilizate).l-am rugat pe Philip să-și redirecționeze titlurile și să ia notă de următoarele linii directoare generale:
- utilizați structura așa cum se arată mai sus pentru prima, a doua și a treia rubrică de nivel.,
- asigurați-vă că titlurile sunt auto-explicative. Titlul care face clătite este mult mai orientat către utilizator decât utilizarea MagicCook5000.
- asigurați-vă că titlul acoperă subiectul complet. Dacă secțiunea Se referă la întreținerea și repararea unui produs, rubrica întreținere ar fi incompletă.
- dacă este posibil, încercați să omiteți articolele la începutul rubricilor
acțiune: scrieți rubrici noi pentru intrările ToC.
Toc Philips cu titluri semnificative pot fi găsite în fila ToC w. titluri semnificative.,
Pasul 6 determinați conținutul Legal
în funcție de piața pe care este plasat sau pus în funcțiune produsul dvs. și în funcție de grupul de produse din care face parte produsul dvs., legislația specifică se aplică produsului dvs.în general, legislația impune ca produsul dvs. să fie „sigur” și, prin urmare, oferă cerințe generale de siguranță pe care produsul dvs. ar trebui să le îndeplinească.aceste cerințe includ, de asemenea, cerințe privind conținutul manualului de utilizare și instrucțiunile de siguranță.,pentru a vinde produsul dvs. pe o anumită piață, trebuie să vă asigurați că manualul dvs. de utilizare respectă aceste cerințe.aceste două articole de mai jos vă vor spune cum puteți afla exact ce legislație se aplică produsului dvs. pentru piața europeană și americană și care sunt cerințele pentru manualul dvs. de utilizare. Sfat din partea profesioniștilor: atunci când există deja o declarație de conformitate disponibilă, puteți găsi directivele aplicabile acolo.,
- cum se creează manuale conforme pentru UE
- cum se creează manuale conforme pentru SUA
Philip nu a trebuit să efectueze acești pași, deoarece șablonul pe care l-a folosit conținea deja conținutul legal conform cerințelor directivelor relevante.
pentru produsul său, înseamnă că sunt necesare următoarele informații pentru manualul de utilizare pentru produsul său:
EU (directivele relevante pentru marcajul CE: LVD, EMC, RoHS, DEEE, REACH):
- manualul de utilizare trebuie tradus în limba(limbile) țării în care produsul este vândut.,
- manualul de utilizare trebuie să descrie utilizarea prevăzută a produsului.
- manualul de utilizare trebuie să descrie utilizarea neintenționată prevăzută în mod rezonabil a produsului.
- dacă este cazul, trebuie menționată nerespectarea în zonele rezidențiale.
- tipul, lotul sau numărul de serie sau alt element care permite identificarea produsului trebuie menționat pe produs. Dacă produsul este prea mic, acesta poate fi introdus în manualul de utilizare.
- numele, denumirea comercială înregistrată sau marca înregistrată și adresa poștală trebuie menționate pe produs., Dacă produsul este prea mic, acesta poate fi introdus în manualul de utilizare.
- trebuie efectuată o analiză de risc pentru a determina riscurile reziduale legate de utilizarea produsului. Se furnizează informații privind siguranța pentru a informa utilizatorul cu privire la măsurile care trebuie luate.
- se includ informațiile DEEE
- se includ informațiile privind deșeurile de ambalaje.pe lângă această legislație, există și un standard internațional pentru manualele de utilizare, IEC/IEEE 82079-1:2019. Acest standard a fost armonizat în UE., Respectarea standardelor armonizate oferă o prezumție de conformitate cu legislația corespunzătoare!șablonul manualului de utilizare respectă acest standard.
am creat, de asemenea, o listă de verificare IEC 82079 care poate fi utilizată pentru a verifica dacă manualul dvs. de utilizare respectă acest standard.pentru a crea un manual de utilizare conform la nivel internațional, trebuie să vă asigurați întotdeauna că manualul dvs. îndeplinește cerințele UE, SUA și 80279.,
acțiune: pentru a determina cerințele legale din manualul dvs. de utilizare:
- urmați pașii 1-2 din articolele de conformitate UE și/sau pașii 1-6 din articolele de Conformitate din SUA pentru a determina cadrul legal pentru instrucțiunile dvs.
- studiați lista de verificare IEC 82079 pentru a vă asigura că manualul dvs. respectă standardul 82079.în acest videoclip vă explic cum puteți crea un manual care să respecte standardul 82079:
la magazin
Pasul 7 descărcați și pregătiți șablonul manualului de Utilizare
acum Philip poate începe crearea efectivă a manualului său de utilizare., l-am rugat să ajusteze cuprinsul șablonului în funcție de propriul cuprins. Fără a elimina și elemente obligatorii, desigur…vă amintiți de la pasul 4 că am cerut să încep numerotarea secțiunilor cu capitolul 4? După ce descărcați singur documentul șablon manual de utilizare, veți vedea că au fost adăugate câteva capitole standard, precum și unele anexe.,
acțiune: pentru a ajusta șablonul manual de utilizare:
Dacă doriți să lucrați cu șablonul gratuit:
- Descărcați șablonul Manual de utilizare gratuit Word 2013 sau 2007
- schimbați titlurile secțiunilor în funcție de propriul ToC. Observați! Nu ajustați cuprinsul. Cuprinsul poate fi actualizat automat după ce ați ajustat titlurile secțiunilor.
- adăugați conținutul obligatoriu așa cum este determinat la pasul 6 din manualul dvs.
- dacă este cazul, modificați secțiunile 1-3 și anexele în funcție de nevoile dvs.,
sau utilizați unul dintre șabloanele noastre plătite care conțin tot conținutul obligatoriu, așa cum a făcut Philip:
- dispozitive medicale EU
- dispozitive medicale noi
- mașini eu
- mașini noi
- electronice EU
- jucării EU
Pasul 8 creați conținutul pentru șablonul dvs. manual de Utilizare
scrieți scopul produsului dvs. sau mai bine zis: utilizarea prevăzută este inima unui manual de utilizare și constituie baza asigurării utilizării sigure și sănătoase a produsului.,modul în care este descrisă utilizarea prevăzută determină, de asemenea, răspunderea dvs. și afectează conținutul suplimentar al Manualului de utilizare.cea mai mare parte a legislației vă impune să includeți o descriere a utilizării preconizate în instrucțiunile utilizatorului.
standardul internațional pentru utilizator instrucțiuni IEC 82079-1, oferă următoarea definiție pentru utilizare:
O gamă completă de funcții sau prevăzute de aplicații definite și proiectate de către furnizorul de produs
Prin a descrie utilizarea preconizată a determina în condiții de siguranță plic de produs., Și după ce ați determinat utilizarea prevăzută, vă puteți concentra pe furnizarea numai a acelor instrucțiuni de siguranță și de utilizare pentru modul de utilizare a produsului în plicul dat.în plus, pentru utilizarea prevăzută, multe alte standarde, directive și regulamente necesită, de asemenea, să includeți o descriere a utilizării necorespunzătoare previzibile în mod rezonabil.de exemplu, utilizarea necorespunzătoare previzibilă a unui detergent agresiv ar putea fi utilizarea acestuia într-un mediu de procesare a alimentelor.
acordând prea puțină atenție descrierii utilizării abuzive previzibile în mod rezonabil va afecta răspunderea unei companii.,
răspunderea pentru produse legile / reglementările dețin un producător răspunzător pentru un produs defect. Dacă trebuie determinată defecțiunea unui produs, toate circumstanțele vor fi luate în considerare. Aceasta include utilizarea previzibilă în mod rezonabil a produsului.descrierea utilizării preconizate determină ce instrucțiuni sunt date în restul manualului. De exemplu, dacă un sistem de răcire este utilizat numai pentru răcirea anumitor medicamente, atunci trebuie descrise numai aceste proceduri.,
când se poate prevedea în mod rezonabil că sistemul de răcire poate fi utilizat ca sistem de răcire a organelor, acest lucru trebuie descris în instrucțiuni. Procedând astfel, dumneavoastră, în calitate de producător, vă veți limita răspunderea și vă puteți concentra doar pe descrierea modului de utilizare a sistemului pentru răcirea medicamentelor.acțiune: scrieți utilizarea prevăzută și utilizarea necorespunzătoare previzibilă a produsului dvs.
Figura 1. Abuz previzibil în mod rezonabil?,scrieți avertismentele de siguranță pe baza analizei de risc
chiar dacă utilizarea prevăzută a fost clar definită, acest lucru nu înseamnă că utilizarea unui produs este complet lipsită de riscuri.pentru a identifica pericolele care apar odată cu utilizarea unui produs, puteți efectua o analiză a riscurilor. O analiză de risc poate fi, de asemenea, obligatorie pentru anumite grupe de produse, cum ar fi echipamente de joasă tensiune, jucării, mașini și echipamente pentru utilizarea în atmosfere explozive.
standarde, cum ar fi ISO 12100, au fost dezvoltate cu privire la modul de a efectua o analiză de risc., ISO 12100 oferă, de asemenea, o metodă pentru luarea măsurilor de atenuare: metoda în trei etape. Conform acestei metode, există următoarea ierarhie a măsurilor de reducere a riscurilor:
- măsuri de proiectare inerent sigure
- măsuri de protecție complementare și măsuri de protecție complementare
- informații pentru utilizare
aceasta înseamnă că Ghidul utilizatorului trebuie să avertizeze cu privire la orice riscuri reziduale legate de utilizarea produsului. Acest lucru se face cu avertismente de siguranță.,un avertisment de siguranță bun descrie natura unei situații periculoase, consecințele de a nu evita o situație periculoasă și metoda(metodele) de evitare a acesteia.pentru a indica gradul de pericol care poate fi întâmpinat de utilizator, trebuie utilizate cuvintele de avertizare” Pericol”, „avertizare” și „precauție”.
aruncați o privire la următoarele mesaje de siguranță:
atenție! Piese rotative. Risc de răniri grave. Țineți mâinile la vedere. Lockout / Tagout înainte de service.
apoi, doriți să avertizeze utilizatorul în cazul în care s-ar putea întâlni o situație periculoasă. ANSI Z535.,6 standardul descrie următoarele locații în manualul de utilizare în cazul în care acest lucru ar putea fi:
- grupate într-un capitol separat.
- În prima parte a secțiune specifică:
- Încorporate într-o procedură:
1. Fă asta.
2. Fă asta. Atenție! Acest lucru este încorporat mesaje de siguranță. Text General text general text general.
3. Fă asta.,- în prefață pot fi plasate orice directive suplimentare, cum ar fi citirea tuturor instrucțiunilor înainte de utilizare sau păstrarea acestor instrucțiuni pentru referințe viitoare pot fi plasate în introducerea unui manual de utilizare.în UE, în funcție de tipul de produs, ar putea fi permisă furnizarea numai a informațiilor privind siguranța în formă tipărită, iar restul informațiilor online.pentru a-l ajuta pe Philip să creeze și să plaseze un mesaj de siguranță, am creat un alt șablon.
acțiune: efectuați o analiză de risc și creați mesajele de siguranță utilizând acest șablon.,acum I-am cerut lui Philip să creeze orice alt conținut, cum ar fi procedurile, specificațiile tehnice și informațiile legale.
am dat următoarele sfaturi:
- excludeți materialele inutile pentru a evita supraîncărcarea informațiilor (de exemplu, promovarea vânzărilor, repetarea extinsă etc.).
- asigurați-vă că termenii sunt familiari utilizatorului, caracteristicile tehnice și termenii sunt bine explicate și utilizați termenii în mod consecvent.
- descrieți orice condiții prealabile care trebuie îndeplinite înainte de începerea instrucțiunilor reale., Acest lucru poate fi, de asemenea, descrie instrumente speciale sau spațiu pentru întreținere și reparații.
- furnizați informații conceptuale atunci când informațiile sunt necesare pentru înțelegerea și executarea adecvată a sarcinilor.
- întotdeauna scrie subiect bazat.
- utilizați o caractere aldine pentru toate elementele produsului.
- utilizați un ghid de stil pentru a vă ajuta să scrieți și să formatați documentația într-un mod mai clar.
- indicați când doriți să adăugați o imagine pentru o mai bună înțelegere mai târziu.
- asigurați-vă că cuvintele și expresiile nu sunt prea complicate sau prea sofisticate.,
- utilizați fraze simple / standardizate și scurte: o propoziție-o comandă.
- nu puneți prea multe informații într-o singură propoziție.
- Utilizați comenzile vocale active directe și asertive.
- folosiți cuvinte precum substantive și verbe în mod constant pentru a evita ambiguitatea.
- pentru a scrie instrucțiuni mai bune, utilizați principiile minimalismului în comunicarea tehnică și engleza tehnică simplificată.
acțiune: creați orice alt conținut pentru manualul dvs. de utilizare.din nou ,pentru majoritatea grupurilor de produse există șabloane plătite care ar putea ușura munca., Aceste șabloane conțin toate textele legale, informațiile obligatorii de eliminare, declarațiile privind drepturile de autor și respectă standardul IEC 82079 privind instrucțiunile utilizatorului.
plasați avertismentele de siguranță în poziția corectă
când utilizați șablonul pentru realizarea mesajelor de siguranță, l-am rugat pe Philip să indice dacă un mesaj de siguranță este o directivă suplimentară sau ar trebui plasat ca un mesaj de siguranță grupat, secțiune sau încorporat.acum, tot textul a fost creat, mesajele de siguranță pot fi plasate în locul potrivit.,
acțiune: plasați toate mesajele de siguranță în locația corectă din manualul de utilizare.
Pasul 9 Adăugați navigare la șablonul Manual de Utilizare
un manual de utilizare ar trebui să ofere asistență oamenilor prin furnizarea de informații despre modul de utilizare a unui produs. Găsirea informațiilor corecte care rezolvă problema utilizatorului ar trebui să dureze cât mai puțin timp posibil.crearea de titluri semnificative este unul dintre instrumentele care ajută utilizatorii să găsească informații., Cu toate acestea, există mai multe alte instrumente pentru a ajuta utilizatorul să găsească informațiile pe care le dorește, cum ar fi:
- cuprins
- numerotarea paginilor
- Index
I-am cerut lui Philip să actualizeze cuprinsul și să adauge numerotarea paginilor și un index.
acțiune: Adăugați sau actualizați cuprinsul, numerotarea paginilor și indexul.
Pasul 10 revizuiți manualul de Utilizare
Philip a creat acum versiunea draft a manualului său de utilizare, folosind șablonul manualului de utilizare. Noi numim această versiune design de conținut textual.,
deoarece Philip are un partener de afaceri și un dezvoltator cu cunoștințe tehnice aprofundate despre produse, l-am rugat pe Philip să-i lase să revizuiască lucrarea de până acum. atât partenerul său de afaceri, cât și dezvoltatorul au oferit feedback. Philip a folosit acest feedback pentru a optimiza manualul de utilizare.
acțiune: trimiteți versiunea draft a Manualului de utilizare oricărei persoane din echipa dvs. care ar putea oferi feedback. Cereți-le să combine toate feedback-ul într-un singur document înainte de a trimite-l înapoi la tine. Acest lucru stimulează discuțiile membrilor echipei dvs. și previne dezacordul într-o etapă ulterioară.,pasul 11 creați imaginile
odată ce manualul de utilizare a fost revizuit și optimizat, textele sunt mai mult sau mai puțin definite. Aceasta înseamnă că orice imagini pot fi acum create și adăugate la conținut.motivul pentru a aștepta până când textele sunt gata este că crearea sau editarea imaginilor poate necesita mult timp. Deoarece imaginile ar trebui să susțină, să înlocuiască sau să mărească textul, doriți să așteptați să le creați până când textele sunt finale.imaginile din manualele de utilizare pot include ilustrații, fotografii, capturi de ecran, tabele, diagrame și scheme.,
Există multe instrumente care vă pot ajuta să creați imagini, cum ar fi:
- Snagit sau Adobe Photoshop pentru editarea de imagini sau fotografii
- Solidworks Composer sau Google Sketchup pentru crearea de desene
- Lucidchart sau Microsoft Visio pentru diagrame și scheme
– am sfătuit pe Filip să nu folosească fotografii ca o alternativă ieftină pentru ilustrații. Adesea, fotografiile nu sunt la fel de informative, deoarece conțin prea multe informații. În plus, fotografiile pot face ca un manual de Utilizare să pară dezordonat.,din acest motiv, Philip a folosit Google Sketchup pentru a-și crea ilustrațiile.
acțiune: creați imaginile pentru manualul dvs. de utilizare.
Dacă vrei să știi mai multe despre crearea de imagini:
- Folosind text, imagini sau video
- Crearea IKEA-ish manuale
Pasul 12 verificarea Finală a Manualului de Utilizare Șablon
Înainte de a începe a face să arate frumos și traduce conținutul, vrem să fim siguri că conținutul este complet.pentru a face acest lucru, l-am rugat pe Philip să folosească o listă de verificare.,
Acțiune: l asigurați-vă că manualul de utilizare respectă toate cerințele relevante din IEC 82079-1:2012 utilizând această listă de verificare.
Pasul 13 proiectați șablonul manualului de Utilizare
un manual bine conceput contribuie la o experiență mai bună a mărcii și a utilizatorului.
puteți ajusta șablonul Manual de utilizare în MS Word prin adăugarea unui logo al companiei și ajusta fontul, culorile și altele, dar care ar putea avea limitări.când știți cum să lucrați cu Adobe Indesign sau sunteți dispus să învățați să lucrați cu acesta, acest lucru vă va oferi posibilități de proiectare mult mai mari.,
am creat acest șablon în Indesign și l-am rugat pe Philip să-l ajusteze pentru a se potrivi cu identitatea sa de brand.
acțiune: ajustați șablonul manualului de utilizare pentru a se potrivi cu identitatea mărcii dvs. sau descărcați șablonul manualului de Utilizare InDesign și ajustați-l.
Step 14 DTP Works
DTP standuri pentru Desktop Publishing și Wikipedia descrie ca fiind „crearea de documente folosind abilități de aspect pagină pe un computer personal în principal pentru imprimare”.Philip are acum atât conținutul manualului său de Utilizare (fișier Word), cât și șablonul manualului de Utilizare (fișier InDesign)., Conținutul trebuie pus în șablonul InDesign. Aceasta se numește Desktop Publishing.acțiune: plasați conținutul din fișierul Word în șablonul Indesign. Dacă ați decis să nu utilizați șablonul InDesign, dar ați rămas la fișierul Word, atunci puteți sări peste acest pas.
Pasul 15 traduceți și publicați manualele de Utilizare
în funcție de piața pe care intenționați să vindeți produsul, poate fi necesar să traduceți manualul de utilizare.
câteva sfaturi generale:
- căutați un traducător cu experiență similară., Acesta ar putea fi un traducător cu experiență în traducerea conținutului tehnic, cu produse similare sau cu traducerea manualelor de utilizare.
- dacă aveți nevoie să traduceți în mai multe limbi, lucrul cu o agenție de traduceri vă poate economisi mult timp.
- întrebați traducătorul sau agenția despre procedurile lor de calitate și cine va revizui textul după traducere.
- după cum știți cel mai bine produsul dvs. și cine este publicul dvs., ar putea fi o idee bună să oferiți traducătorului sau agenției un glosar sau o listă cu terminologia pe care doriți să o utilizați.,
- căutați un traducător care poate lucra direct în fișierul Word sau InDesign sau găsiți o agenție care poate face și lucrările DTP. Alternativ, puteți face acest lucru singur, desigur.deoarece Philip își va vinde produsul atât în SUA, cât și în UE, a decis să lucreze cu o agenție.
acțiune: găsiți un traducător sau o agenție care se potrivește nevoilor dvs. și traduceți manualul de utilizare.în general, un manual de utilizare ar trebui să fie disponibil într-un format ușor accesibil utilizatorului. Care pot fi tipărite sau utilizate online sau pe dispozitiv.,deoarece un utilizator dorește informații în momentul în care are nevoie de ele și, prin urmare, nu gândește în canale, cea mai bună abordare ar fi să furnizeze instrucțiunile omni-platformă.în Uniunea Europeană, pentru anumite grupe de produse, este totuși limitată furnizarea manualului de utilizare tipărit împreună cu produsul.
cu toate acestea, începând cu aprilie 2016, instrucțiunile multor grupuri de produse pot fi livrate într-un format diferit, mai degrabă decât în format tipărit. Cu toate acestea, există o excepție.informațiile privind siguranța trebuie furnizate în continuare pe suport de hârtie, împreună cu produsul., În plus, la cererea unui consumator, ar trebui pus la dispoziția consumatorului un manual de utilizare pe hârtie.Philip a decis următoarele:
- el oferă un manual complet tipărit cu produsul, inclusiv instrucțiunile de siguranță.
- el a creat un ghid separat de pornire rapidă pentru a fi furnizate cu produsul, de asemenea.
- a plasat online o versiune pdf a manualului complet.
- el va crea o secțiune de ajutor online pe site-ul său web cu versiunea HTML a Manualului de utilizare. Aici poate adăuga și videoclipuri., Și prin optimizarea versiunii HTML pentru motoarele de căutare, el face mai ușor pentru utilizatorul său să găsească informații pentru utilizatorul său
concluzie
asta e tot ce există. Așa a creat Philip un manual de utilizare compatibil cu ajutorul șablonului manualelor de Utilizare și al celorlalte instrumente disponibile pe care le-am furnizat.cea mai bună parte din toate acestea este că puteți obține aceleași rezultate ca Philip a făcut urmând acest proces pas cu pas cu privire la modul de a crea un manual de utilizare.