Content

• Per trepitjar
• Part 1 de 4: Planificació del manual del propietari
• Part 2 de 4: incrustar informació essencial
• Part 3 de 4: Descripció del manteniment del producte
• Part 4 de 4: Escriviu un manual llegible
• Consells

El programari, els ordinadors, els jocs i els dispositius requereixen manuals d’usuari; guies que expliquen com utilitzar el producte (i com no). Un manual d'usuari és un document formal amb una estructura específica i ha de ser redactat per algú que conegui el producte per dins, com ara un redactor tècnic o el dissenyador del producte. Per escriure un manual d’usuari eficaç cal saber qui farà servir el producte i escriure el manual tenint en compte aquests usuaris. Mantingueu l’escriptura clara, precisa i senzilla per garantir una experiència d’usuari sense problemes.

Per trepitjar

Part 1 de 4: Planificació del manual del propietari

1. Feu una anàlisi d'usuari. El manual de l'usuari s'ha d'escriure per als usuaris: aquells que compraran el vostre producte o servei i llegiran el manual de l'usuari. Una anàlisi de l'usuari us indicarà qui serà el vostre públic principal o objectiu i us guiarà en la redacció del text.
   • Parleu amb persones que faran servir el vostre dispositiu. Oferiu als usuaris prototips del dispositiu i esborrany del manual de l'usuari en condicions controlades. Demaneu a aquests usuaris de proves suggeriments sobre coses que no són clares o confuses a la guia de l'usuari i feu canvis a la vostra guia d'usuari en funció d'aquests comentaris.
   • Mai es pot satisfer tot el públic; escriviu el manual adaptat al públic objectiu o al públic més nombrós.
   • Tingueu en compte l'edat, la salut (tenen alguna malaltia, dificultats d'aprenentatge o discapacitats?) I el nivell d'educació del públic per determinar el millor enfocament per escriure el manual de l'usuari.
2. Coordinar el disseny del manual de l'usuari. Si formàveu part de l’equip que va ajudar a dissenyar i desenvolupar el dispositiu o el producte, pot ser difícil fer una mirada objectiva al producte per explicar com funciona. Per tant, haureu de buscar l'assessorament d'un escriptor (preferiblement algú amb experiència en escriure instruccions) i d'un dissenyador gràfic per ajudar-vos a preparar el manual d'usuari. Podeu triar aquestes persones mitjançant una consultoria externa o des de la vostra pròpia empresa o organització.
3. Feu una anàlisi de tasques. L’anàlisi de feines és el procés d’identificació i organització dels passos necessaris per utilitzar el dispositiu. Una anàlisi exhaustiva del treball identifica els materials i equips (com ara bateries, medicaments o altres productes subministrats per l'usuari) necessaris per a cada pas, així com les accions, errors i consells de resolució de problemes que cada pas pot requerir.
   • Si teniu un producte que pot realitzar moltes tasques o subtasques diferents, heu de realitzar una anàlisi de tasques per a cada tasca. Per exemple: en un cotxe podeu claxonar, fixar-vos i encendre o apagar els fars. Feu una anàlisi de feina per a cadascun d’aquests, si cal.
4. Assegureu-vos que el producte compleixi els requisits d’etiquetatge i autorització de comercialització. Aquests requisits garanteixen que els productes es fabriquin tenint en compte la seguretat de l'usuari i que l'exposició de l'usuari a condicions perilloses, com ara radiació i electrocució, sigui limitada. Els anuncis han d’indicar clarament el propòsit i les directrius bàsiques d’operació d’un producte, i heu d’utilitzar aquests recursos a l’hora d’escriure el manual del propietari.
   • Perquè el manual d’usuari d’un producte sigui eficaç, s’ha d’escriure d’acord amb les etiquetes que s’adjunten directament al producte.
   • Assegureu-vos que el dispositiu tingui llicència oficial per a la venda abans d’escriure el manual de l’usuari.
5. Decidiu el disseny del manual. Hi ha diverses maneres importants de racionalitzar el manual. Heu de posar un encapçalament en negreta al principi de cada secció amb cada paraula en majúscules. Per exemple, "Configura el dispositiu", "Funciona el dispositiu" i "Resolució de problemes" poden ser encapçalaments de secció en negreta.
   • Una altra manera d’agilitzar la vostra guia és fer servir dues columnes, una a la dreta amb text i l’altra a l’esquerra del text, amb vinyetes, números o icones petites, com ara signes d’avís o punts d’exclamació vermells.
   • El manual pot consistir principalment en imatges amb text a sota de cada imatge per explicar el dispositiu, o pot ser principalment text amb només algunes imatges adjuntes. També podeu utilitzar un diagrama de flux per guiar l'usuari. Penseu en el vostre producte i en com cada mètode us pot ajudar a escriure el vostre manual. No obstant això, eviteu barrejar dissenys diferents en un manual. Trieu-ne un i enganxeu-vos-hi.

Part 2 de 4: incrustar informació essencial

1. Organitzeu el manual lògicament. El manual s’ha d’estructurar de manera que l’usuari en tregui el màxim profit. Dividiu el manual en capítols o seccions que tinguin sentit per utilitzar el producte i incloeu una taula de continguts a la part frontal del manual perquè cada secció es pugui trobar ràpidament.
   • Una taula de continguts és especialment necessària per a manuals més llargs.
   • Es necessita un glossari o un índex si hi ha molts termes que expliquen que és possible que el vostre públic no estigui familiaritzat. Tanmateix, no es recomana un glossari; la millor opció és explicar termes confusos al text del manual. Si decidiu incloure un glossari, col·loqueu-lo a la part frontal del manual, just després de la taula de continguts.
   • Una llista de taules o figures només és necessària si hi ha més d'unes quantes taules o figures al manual.
   • Es necessita un apèndix per a les coses que s’han d’explicar però que no es poden explicar en cap altre lloc del manual, ja que pertorbaria el flux i el focus.
2. Incloeu les advertències necessàries. Les advertències generals o la informació de precaució haurien de proporcionar informació sobre possibles perills causats per un ús incorrecte del producte, inclosa la mort o lesions greus. Aquests advertiments s'han de col·locar a la part frontal del manual, després de la primera pàgina, perquè l'usuari els vegi primer. També s’han d’incloure advertències específiques al text del manual just després o just abans de suggerir un pas potencialment perillós.
   • Per exemple, un advertiment general per a un aparell elèctric pot ser no utilitzar-lo quan plou.
   • Una instrucció específica pot ser assegurar-se que les mans i el dispositiu estan secs abans de connectar el dispositiu a la presa de corrent.
   • Proporcioneu imatges (com ara una calavera i ossos creuats) o text d’un color diferent (com ara el text vermell) per distingir l’advertència de la resta d’indicacions de la IFU i cridar l’atenció dels usuaris sobre ella.
3. Descriviu el dispositiu. La vostra descripció ha d'incloure una explicació per escrit del propòsit del dispositiu i una petita representació gràfica de l'aspecte del dispositiu. La figura ha d’etiquetar i anomenar tots els commutadors, botons i parts adjuntes del dispositiu.
4. Proporcioneu instruccions d'instal·lació. La secció d'instal·lació ha de contenir informació bàsica sobre com preparar-se per utilitzar el producte o dispositiu. Si l’aparell no pot ser construït ni configurat per un usuari domèstic, especifiqueu-ho clarament en un encapçalament en negreta a la part superior de la secció d’instal·lació. També heu d’incloure el següent:
   • Una llista de peces
   • Instruccions per desembalar
   • Advertiments d'instal·lació
   • Conseqüències d’una instal·lació incorrecta
   • A qui trucar en cas de dificultats durant la instal·lació
5. Proporcioneu informació sobre l’operació. Aquesta secció és la part més important del manual de l'usuari i ha de proporcionar informació concreta i detallada sobre com utilitzar el dispositiu. Comenceu amb la preparació bàsica per utilitzar la unitat, com endollar el cable d'alimentació o rentar-vos les mans. Continueu amb els passos lògics i numerats que descriuen com utilitzar el dispositiu, així com qualsevol comentari (per exemple, "Sentireu un clic ...") que l'usuari pot esperar quan utilitza el dispositiu correctament.
   • Al final d’aquest capítol, els usuaris haurien de derivar-se al capítol de resolució de problemes per resoldre problemes que no s’expliquen ràpidament.
   • Col·loqueu imatges on sigui necessari. Alguns passos s’expliquen millor amb imatges i paraules. Penseu en l’ús de fotos o il·lustracions al vostre manual.
   • En aquesta secció, com en qualsevol secció, heu d’incloure advertències de seguretat pertinents sobre un ús o un funcionament incorrecte. Per exemple, podeu advertir als usuaris de la motoserra de no beure alcohol o d’utilitzar la motoserra mentre prenen determinats medicaments.
   • Si creieu que els usuaris se’n beneficiaran, penseu incloure enllaços a vídeos en línia que demostrin l’ús i el funcionament adequats del dispositiu. Podeu gravar aquests vídeos al començament d'aquesta secció o (en el cas de vídeos que il·lustrin només un pas) al final de cada pas.
6. Incloeu un resum del producte al final. El resum hauria d'aparèixer al final del manual, just abans de l'índex, per proporcionar els passos bàsics de funcionament. Aquesta hauria de ser una versió simplificada i despullada de la informació operativa i no hauria de tenir més d’una pàgina. Feu un resum de com s’ha d’utilitzar el dispositiu o el producte. Incloeu alertes bàsiques, passos numerats que expliquen com utilitzar el producte i números de telèfon o adreces de correu electrònic que orientin els usuaris a ajudar-los.
   • Si espereu que l’usuari elimini o faci referència al full de resum sovint, podeu imprimir-lo en una targeta laminada extraïble o en cartró gruixut per facilitar-ne el transport i la consulta.
   • Com a alternativa, podeu aplicar un resum directament al producte per a una consulta ràpida i senzilla per part de l’usuari.

Part 3 de 4: Descripció del manteniment del producte

1. Expliqueu com netejar el dispositiu. Si el vostre dispositiu o producte necessita neteja, expliqueu com fer-ho. Enumereu els agents de neteja necessaris. Digueu-li al lector la freqüència de neteja. A continuació, com en qualsevol altra part del manual, incloeu instruccions pas a pas numerades sobre com netejar-lo.
   • Si la neteja requereix el desmuntatge del producte o la retirada d’una o de les peces en concret, indiqueu com s’ha de desmuntar el producte.
   • Proporcioneu un avís sobre els resultats de la neteja del dispositiu. Per exemple, podeu dir: "Si el dispositiu no es neteja, el rendiment serà inferior a l'òptim".
2. Compteu l’usuari com realitza un manteniment bàsic. Si el producte o dispositiu es pot fer servir a l’usuari per corregir problemes de rendiment, proporcioneu instruccions numerades sobre com fer-ho per a l’usuari. Per exemple, si cal canviar les bateries després de cada 300 hores d’ús, proporcioneu instruccions sobre com comprovar si cal canviar les bateries, com eliminar les bateries esgotades i com instal·lar-ne de noves.
   • Si hi ha certes tasques de manteniment que només pot realitzar un tècnic certificat, dividiu la part de manteniment del manual en dues parts.
3. Parleu sobre les opcions d'emmagatzematge. Si cal, el manual hauria d’explicar com emmagatzemar correctament el producte o el dispositiu. també heu d’incloure informació sobre per què és necessari l’emmagatzematge i les conseqüències d’un emmagatzematge inadequat. Per exemple: podeu escriure:
   • Emmagatzemeu el producte en un lloc fresc i sec. L’emmagatzematge inadequat pot escurçar la vida útil del producte a causa de l’acumulació d’humitat ".
   • "No exposeu el producte a escalfar-lo ni emmagatzemeu-lo a temperatures superiors a 50 graus centígrads.Si ho feu, pot provocar combustió ".
4. Proporcioneu informació de resolució de problemes. Podeu organitzar aquesta secció com una llista de problemes habituals i les seves solucions. Agrupeu problemes similars sota un encapçalament lògic. D’aquesta manera, els usuaris poden trobar ràpidament problemes específics.
   • Per exemple, si hi ha diversos problemes amb l'ordinador que mostra una pantalla blava, agrupeu-los en un subtítol, com ara "Problemes de pantalla comuns".
   • També heu d’incloure un número de telèfon i / o correu electrònic per atendre el client en aquesta secció.

Part 4 de 4: Escriviu un manual llegible

1. Llegiu altres guies d'usuari. Abans d’escriure un manual per al vostre propi producte, consulteu altres guies d’usuari efectives. Presteu atenció a l’estructura, l’elecció de les paraules i l’estructura de les frases. Les principals marques com Apple, Google i Microsoft produeixen guies d’usuari fortes i eficaces que us poden ajudar a elaborar una guia de l’usuari escrita amb més cura.
   • No només llegeixis tot manuals d’usuari. Llegiu els manuals de productes similars que veneu. Per exemple, si veneu productes per a nadons, llegiu els manuals per a nadons i no els tècnics.
2. Seleccioneu els vostres estàndards. Estandarditzar l’ortografia, l’elecció de paraules i la redacció faran que el manual de l’usuari sigui més fàcil d’utilitzar. El Manual d'estil de Chicago i el Manual d'estil de Microsoft també poden ser guies d'estil útils per escriure el manual del propietari; comproveu-ne tots dos per veure si un és adequat per al vostre manual.
   • Per exemple, en lloc d'utilitzar "interruptor d'engegada" i "botó d'engegada" al manual, trieu un dels dos termes i seguiu-hi.
3. Utilitzeu la veu activa. La veu activa és una forma d’escriure que explica les coses des de la perspectiva de l’usuari. És més fàcil d’entendre que l’alternativa, la veu passiva, en què el subjecte no està definit.
   • Proveu l'aplicació Hemingway (www.hemmingwayapp.com) per identificar passatges passius en els vostres escrits.
   • Estudieu aquestes dues frases de mostra: la primera és activa i la segona és passiva:
     • Cal obrir el paquet lentament i amb cura.
     • El paquet s’ha d’obrir lentament i amb cura.
4. Escriviu instruccions numerades. Les instruccions ordenades numèricament ajuden el lector a centrar-se millor en el procés d’utilitzar, connectar o construir el producte en qüestió. En lloc d’escriure un paràgraf llarg o detallat o una sèrie de paràgrafs sense numerar, escriviu la vostra guia de l’usuari amb passos senzills i explícits, cadascun d’ells clarament numerats.
5. Comenceu cada pas amb un imperatiu. Un imperatiu és un verb orientat a l'acció. Començant cada pas amb un verb, doneu al lector una pista sobre l’acció necessària per completar el pas. Per exemple, en funció del producte sobre el qual escriviu, podeu iniciar els passos amb una ordre com ara "Connecta", "Confirma" o "Diapositiva". Tanmateix, no comenceu els passos amb una resposta del sistema.
   • Per exemple, si la pantalla es torna blava i comença a parpellejar, no comenceu el pas amb: "La pantalla parpellejarà i es tornarà blava." Proveu: "Mantingueu premuda la tecla d'inici. La pantalla parpellejarà i es tornarà blava. "
6. Determineu quin vocabulari utilitzarà. Si escriviu un manual de jo-yo, el vostre públic serà majoritàriament de nens petits. Utilitzeu paraules i vocabulari senzills per explicar com funciona el jo-yo. Quan escriviu un manual de microscopi electrònic d’escombratge, el vostre públic està format per científics altament qualificats que poden entendre informació molt detallada, de manera que no defugiu l’ús de vocabulari especialitzat ni explicacions matisades.
   • En general, intenteu evitar l'argot i el llenguatge tècnic.
   • Per ser eficaç per a la base d’usuaris el més àmplia possible, intenteu escriure a un nivell del sisè al setè de primària.
7. Quan envieu un producte a l'estranger, assegureu-vos que les vostres traduccions siguin exactes. Contracteu un traductor per traduir el vostre manual d’usuari a l’idioma nadiu del país on envieu el producte. També podeu utilitzar un programa de traducció en línia, però demaneu a un parlant nadiu que llegeixi la traducció i que comprovi si hi ha errors.
   • Si hi ha representats diversos grups d'idiomes al vostre públic, incloeu traduccions del manual d'usuari en cada idioma pertinent.
   • El traductor ha d’estar familiaritzat amb el producte, ja que pot haver-hi paraules diferents en l’idioma de destinació per a termes específics que no siguin traduccions paraula per paraula.
8. Escriu en frases curtes. En lloc d’uns quants paràgrafs llargs, utilitzeu molts paràgrafs curts. Cerqueu trencaments lògics a cada secció i digereu informació útil en trossos d’una o dues frases. El mateix passa amb el nivell de les frases. Mantingueu les frases curtes i senzilles en lloc de llargues i detallades.
   • Si un pas s’allarga massa, descomponeu-lo en passos més petits. Això no reduirà el recompte de paraules, però els salts de línia facilitaran la lectura.
9. Consulteu el manual per si hi ha errors. Un manual pot perdre credibilitat a causa d’errors gramaticals i ortogràfics. Feu que un company o escriptor tècnic editi i reviseu el manual també. A més de l’ortografia i la gramàtica, un corrector hauria de prestar atenció a les qüestions següents:
   • Veu passiva
   • Llenguatge poc clar o confús
   • Estructura de frases embolicades
   • Paràgrafs massa llargs

Consells

• La gent aprèn de maneres diferents; Si és possible i adequat, incloeu ajudes visuals o enllaços a vídeos en línia al manual per acollir lectors orientats visualment.