Una guia de l'usuari és un manual en format paper o electrònic (PDF o XPS) que proporciona instruccions sobre un procediment o l'ús d'alguna cosa. Tot i que els “manuals d’usuari” sovint s’associen a les guies d’aplicacions informàtiques, les guies d’usuari també es proporcionen amb ordinadors i altres dispositius electrònics com televisors, equips de música, sistemes telefònics, reproductors MP3 i equipament domèstic i de jardí. Una bona guia d’usuari educa els usuaris sobre les funcions del producte i els ensenya a utilitzar aquestes funcions amb eficàcia. La guia de l'usuari està estructurada de manera que sigui fàcil de llegir i fer referència. Aquests són alguns passos que heu de tenir en compte a l’hora de desenvolupar contingut eficaç i dissenyar dissenys de guia de l’usuari.
Pas
Part 1 de 3: Creació d'una guia d'usuari adequada
Pas 1. Decidiu qui utilitzarà la guia
Per escriure una bona guia de l'usuari, heu de desenvolupar un perfil d'usuari, ja sigui formalment creant un perfil escrit o de manera informal prenent el temps necessari per fer suposicions raonables sobre les característiques de l'usuari. Aquests perfils són útils quan formeu part d'un equip de redacció de guies d'usuari i quan esteu treballant en el producte previst, des del concepte fins a la forma final. Tingueu en compte els factors següents a l'hora de crear un perfil d'usuari:
- La ubicació de l'usuari utilitzarà la guia, per exemple a casa, a l'oficina, en un lloc de treball remot o al cotxe. Aquest factor determina no només el contingut, sinó també l’estil d’escriptura que adoptarà la guia.
- Com utilitzarà la guia l’usuari. Si poques vegades l’utilitzen o només la necessiten per trobar informació, és millor que la guia es faci en forma de document de referència. D'altra banda, si l'usuari l'utilitza regularment al principi, la secció de referència hauria d'anar acompanyada d'una secció "Com començar" i instruccions sobre les funcions més habituals que realitzarà el producte.
- Quanta experiència té l'usuari amb el producte o un element similar. Si el producte és nou o és molt diferent de productes similars, heu d’incloure una explicació sobre la diferència dels altres i instruccions sobre com utilitzar-lo. Si el producte tracta alguna cosa que sovint els resulta difícil als usuaris, com ara una aplicació informàtica, heu de proporcionar informació i detalls adequats de manera comprensible.
Pas 2. Creeu una guia que s'adapti a les necessitats de l'usuari d'una manera que pugui entendre
Si els usuaris no són gent tècnica, probablement és millor evitar un llenguatge altament tècnic i proporcionar explicacions clares i senzilles. El text també s’ha d’organitzar de manera que s’assembli a la manera de pensar de l’usuari. Enumerar les funcions del producte agrupades per funció sovint té més sentit que per les funcions més freqüents.
De vegades, l'ús de termes tècnics és inevitable, per exemple, per a aplicacions de gràfics que inclouen gràfics de Fibonacci juntament amb gràfics circulars i els gràfics de barres més comuns. En un cas com aquest, seria millor definir els termes i proporcionar informació, per exemple, una explicació de què és el gràfic de Fibonacci i com s’utilitza en l’anàlisi financera
Pas 3. Descriviu el problema que l'usuari intenta resoldre i, a continuació, proporcioneu una solució a aquest problema
Oferir funcions com a solucions a problemes comuns està bé quan es fa publicitat d’un producte, però un cop que un client és propietari del producte, ha d’entendre com utilitzar-lo. Identifiqueu el problema amb què es trobarà l’usuari, descriviu-lo a la guia de l’usuari, seguit d’instruccions per solucionar-lo.
Si el problema és complex, divideix-lo en trossos més petits. Escriviu cada secció amb instruccions sobre com resoldre-ho o tractar-lo i, a continuació, seguiu-vos en ordre. Desglossar la informació d’aquesta manera es coneix com el mètode d’agrupació o divisió
Part 2 de 3: Components de la guia de l'usuari
Pas 1. Creeu una portada i una pàgina de títol adequades
Necessitareu una portada per a qualsevol guia de l'usuari que sigui més que una targeta de referència i una portada per a una guia que inclogui més d'un full de paper plegat (de 4 pàgines o més).
- Si la guia està protegida per drets d'autor, cal incloure l'avís de drets d'autor a les portades i contraportades, així com a la portada.
- Si hi ha termes i condicions per utilitzar la guia i els productes associats, incloeu-los a la part interior de la portada.
Pas 2. Introduïu una referència al document relacionat a la introducció
Si hi ha més d'una guia de l'usuari, feu referència a un altre document, inclòs el número de versió correcte, aquí. El pròleg també és un lloc per posar la secció "Com utilitzar aquesta guia" si n'hi ha.
Pas 3. Incloeu una taula de continguts si la guia supera les 10 pàgines
Pas 4. Col·loqueu instruccions / procediments i materials de referència al cos de la guia
En la majoria dels casos, tant el procediment com el material de referència han de tenir la seva secció. Tanmateix, podeu dir als usuaris que facin referència a contingut específic en una secció i que el diferenciï d'altres seccions. D’aquesta manera, l’usuari pot trobar ràpidament la informació que busca.
- Els procediments s’han d’escriure en una estructura coherent al llarg de les instruccions del manual. Comenceu amb una visió general de la funcionalitat del producte i, a continuació, expliqueu què ha de fer l'usuari i quins resultats obtindrà o veurà. Els passos s’han de numerar i començar amb un verb d’acció, com s’escriuen els passos a cada secció d’aquest article.
- El material de referència pot incloure llistes de comprovació, consells de resolució de problemes i preguntes més freqüents. Es pot afegir un glossari i un índex al final de la guia, tot i que al principi es pot proporcionar un glossari de termes d’ús freqüent. L'índex es pot ometre si la guia té menys de 20 pàgines.
Pas 5. Utilitzeu imatges gràfiques segons sigui necessari per donar suport al text
Les imatges gràfiques o captures de pantalla poden il·lustrar millor certs punts d’una guia que el text, especialment en procediments complexos on els usuaris necessiten confirmació visual per assegurar-se que segueixen els passos correctament. Els dibuixos gràfics es poden crear mitjançant aplicacions de redacció assistida per ordinador (CAD) o d’edició de gràfics, càmeres digitals i aplicacions de processament de fotografies, o si voleu utilitzar captures de pantalla, utilitzeu les funcions de captura de pantalla integrades a l’ordinador o un programa gràfic amb funcions de captura de pantalla.
- Un cop creeu una imatge gràfica, deseu-la en format comprimit perquè pugueu utilitzar-la en una aplicació de processament de textos o d’edició personal. També haureu de reduir la mida de la imatge per adaptar-la millor a la pàgina, però, tot i així, proporcionar detalls complets a l’usuari. (Si cal, podeu retallar la imatge original en seccions i mostrar les seccions corresponents juntament amb el text de suport).
- Si utilitzeu diverses imatges gràfiques al procediment, assegureu-vos que les imatges es creïn amb una mida consistent, ja sigui en les mateixes dimensions de longitud i amplada o en proporció a la mida de la imatge original. D’aquesta manera, la imatge serà més atractiva per als usuaris. El mateix passa amb les captures de pantalla des d’un ordinador; assegureu-vos que l’ordinador mostri l’esquema de colors estàndard en fer fotografies, en cas contrari, l’assistent mostrarà una captura de pantalla en color.
- Tot i que les aplicacions d’edició d’imatges com Photoshop i Paint Shop Pro tenen bones capacitats de captura d’imatges, els programes dedicats a fer captures de pantalla com Snagit també ofereixen la possibilitat de modificar, catalogar i anotar captures de pantalla fàcilment.
Part 3 de 3: Dissenyar una guia de l'usuari fàcil d'utilitzar
Pas 1. Trieu alguns tipus de lletra fàcils de llegir
Tot i que un ordinador pot suportar diversos tipus de lletra, el propòsit de crear una guia de l'usuari és fàcil de llegir. Seleccionar diversos tipus de lletra coincidents és la millor manera d’assolir aquest objectiu. Els tipus de lletra es poden agrupar en dos tipus: serif i sans serif.
- Les fonts Serif tenen petites línies decoratives als extrems de les línies principals que componen les lletres. Les fonts serif inclouen Times New Roman, Baskerville i Book Antiqua. Els tipus de lletra Serif són perfectes per a la majoria de text que es mostra en mides 10-12 al cos principal per a guies d’impressió.
- Les fonts sans serif només contenen les línies que componen les lletres, sense adorns. Les fonts que pertanyen al grup sans serif inclouen Arial, Calibri i Century Gothic. Els tipus de lletra Sans serif es poden utilitzar per a la majoria de mides de text de 8 a 10 en fitxers PDF o guies en línia, tot i que el fet de no estar adornat fa que les frases que es mostren en fonts 12 o superiors siguin més difícils de llegir. Tanmateix, els tipus de lletra es poden utilitzar eficaçment en mides més grans per mostrar encapçalaments i encapçalaments, i en mides més petites són perfectes per a notes al peu i números en columnes i taules.
- En general, és millor triar una font senzilla com Arial o Times New Roman per a la vostra guia, tot i que podeu utilitzar una font decorativa per a cometes o títols si escriviu una guia per a un videojoc ambientat en un entorn de fantasia o ciència ficció.. (En el cas de les cites, sovint podeu utilitzar un tipus de lletra senzill i mostrar la cita completa en cursiva).
- Després de decidir quins tipus de lletra voleu utilitzar, creeu pàgines de mostra per comprovar que queden bé en paper. També hauríeu de mostrar aquesta pàgina de mostra a la persona responsable d’aprovar la visualització de la guia abans de continuar amb el procés d’escriptura.
Pas 2. Penseu en el disseny
Un cop hàgiu seleccionat un tipus de lletra per a la guia, haureu de decidir com estructurar el contingut a la part superior de la pàgina.
- En general, és probable que col·loqueu el títol del document o el títol del capítol a la capçalera o al peu de pàgina, potser utilitzant els encapçalaments de la guia a l'esquerra de la pàgina i els encapçalaments del capítol a la dreta de la pàgina. Heu de col·locar el número de pàgina a la capçalera o al peu de pàgina, ja sigui a l'exterior (capçalera o peu de pàgina) o al centre (només al peu de pàgina). És possible que també hàgiu de distingir la primera pàgina de cada secció o capítol d'altres pàgines situant el número de pàgina al mig del peu de pàgina i la pàgina següent a la cantonada exterior de la capçalera.
- És possible que hàgiu de fer inserir el text dins d’un quadre de colors o un quadre de blocs per diferenciar-lo de la resta del text. Assegureu-vos que trieu un color o un nivell de bloqueig perquè no dificulti la lectura del text.
- Deixeu un marge bastant ampli per tots els costats, amb espai addicional a les vores per lligar.
Pas 3. Penseu en el tipus de volum de la guia de l'usuari
Si la guia supera les 4 pàgines, les pàgines hauran d’estar lligades d’una manera determinada. Tot i que els documents interns es poden grapar amb una grapadora a la cantonada de la pàgina, la guia de l'usuari externa que s'envia amb el producte sol grapar-se mitjançant un dels 3 mètodes següents:
- El mètode de grapat lateral (fixat als costats de la pàgina amb una grapadora) per a guies impreses en paper plegat de 21 x 27,5 cm, 21 x 35 cm o 27,5 x 42,5 cm. La majoria de guies econòmiques de 48 pàgines o menys estan vinculades d’aquesta manera.
- El mètode de costura de sella (cosit al lateral de la pàgina) s’utilitza més sovint per a guies de referència de tercers que per a guies incloses amb productes que no siguin automòbils, tot i que algunes guies més llargues s’uneixen d’aquesta manera. (La Guia Paint Shop Pro originalment incloïa una guia de costura de sella mentre encara es produïa per JASC Software).
- L’enquadernació en espiral s’adapta millor a les guies que s’utilitzen en entorns més durs, com ara a l’aire lliure (en aquest cas, els mètodes de grapat lateral i de costura de sella no són prou forts com perquè les pàgines rellisquin). Algunes guies enquadernades en espiral també poden tenir pàgines laminades amb plàstic per evitar que es facin malbé quan estiguin mullades o exposades al fang.
Pas 4. Creeu un document de plantilla com a orientació
Moltes aplicacions de processament de textos i publicació automàtica ofereixen l'opció de crear documents de plantilla per a guies d'usuari. Així, a mesura que escriviu, el text apareixerà automàticament amb el tipus de lletra que heu seleccionat per a la part de l'assistent en què esteu treballant. (En realitat, aquest article es va escriure originalment mitjançant una plantilla de Microsoft Word). La majoria d'aquests programes també inclouen un conjunt estàndard de plantilles que podeu modificar segons calgui, de manera que no hàgiu de crear-ne de zero.
