Como escribir manuais de usuario claros e concisos
Que é un manual de usuario?
Hai varios nomes para un manual de usuario. Os documentos técnicos, os manuais de mantemento e os manuais de instrucións son todos nomes que fan referencia ao mesmo elemento. Realízase un manual de usuario para axudar aos clientes a utilizar correctamente o seu produto ou servizo ou resolver problemas que ocorren durante o uso. Poden estar dispoñibles en formato impreso, dixital ou ambos os dous.
Os manuais de uso proporcionan ao usuario final instrucións detalladas paso a paso e algún soporte para problemas. Un índice debe estar presente en cada manual de usuario porque son materiais de referencia en lugar de libros que se deben ler de principio a fin. Debería engadir un tutorial de inicio rápido ou de inicio no seu manual de usuario para que os usuarios poidan sentirse a gusto comezando a usar o produto.
tipos de manuais de usuario
Para unha variedade de materias e obxectivos, pódense elaborar manuais de usuario. Aquí tes algunhas das túas posibilidades, así que vexámolas.
- Manual de instrucións
Un manual de instrucións é un tipo de guía de usuario que ofrece instrucións sinxelas para usar un produto na forma en que estaba pensado. - Manual de Formación
Este tipo de guía de usuario ofrece unha lista de pautas para rematar unha determinada tarefa, proxecto ou traballo. - Manual de servizo
Os manuais de servizo son guías de usuario que describen como coidar e manter unha peza de maquinaria ou equipamento en diferentes stages da súa vida útil. - Manual de usuario
Os manuais de usuario son publicacións técnicas que explican como utilizar ou manexar correctamente un produto. - Manual de operación
Os papeis, deberes e procedementos específicos dunha empresa ou organización descríbense nos manuais de operación. - Manual de políticas organizativas
Un manual de políticas organizativas é a documentación que define as políticas, as prácticas e as mellores prácticas dunha empresa. - Manual de procedementos operativos estándar (SOP).
Os usuarios benefícianse das instrucións detalladas dun manual de procedementos operativos estándar para levar a cabo os procedementos establecidos.
Por que a túa empresa necesita manuais de usuario?
As persoas están mellor equipadas para xestionar os problemas por si mesmas co apoio dun manual de usuario. Un manual de usuario decente pode ofrecer aos seus clientes as ferramentas que necesitan para acadar de forma rápida e eficaz o valor que desexan do seu produto ou servizo na cultura de gratificación inmediata actual.
Un excelente servizo ao cliente debe complementarse con manuais de usuario. Escribir excelentes manuais de usuario proporcionará o seguinte advantages para a súa empresa:
- Para simplificar a incorporación e a formación
As guías de usuario ben escritas poden simplificar os procedementos de incorporación e formación. É certo, ao desenvolver e implementar manuais de usuario de primeira categoría, tanto os seus empregados como os consumidores poden gañar.
A túa empresa pode usar guías de usuario para axudar aos novos contratados a pasar por algúns dos procesos e sistemas que forman parte dos seus novos roles, en lugar de só organizar sesións de formación presencial difíciles, que teñen un tempo e gastos económicos importantes. Dado que os empregados poden aprender mentres realizan as tarefas relacionadas cos seus postos grazas ás guías de usuario, é posible que se perdan menos horas durante a incorporación. - Para reducir os gastos de apoio
As guías de usuario son un gran complemento para os teus esforzos de atención ao cliente para o consumidor, pero tamén serven ao propietario da empresa como compoñente do sistema de atención ao cliente.
É máis probable que os clientes atopen solucións de inmediato e é menos probable que teñan que poñerse en contacto cun técnico ou representante para obter asistencia especializada cando lles dá acceso rápido a unha guía de usuario que se pode buscar. - Para aforrar tempo
Tanto os seus clientes como os seus empregados, desde o persoal de nivel inicial ata a dirección, poden aforrar tempo usando os manuais de usuario. Cando os seus clientes están dispoñibles manuais de usuario, non terán que perder o tempo intentando atopar información sobre como usar un produto porque terán acceso directo a esa información de inmediato.
Cando os teus empregados están equipados con manuais de usuario útiles, non teñen que perder tempo buscando solucións de forma independente nin monopolizando a atención dos seus compañeiros de traballo e xestores con consultas porque teñen acceso ás solucións directamente no seu manual de usuario. - Para minimizar a responsabilidade
Un enfoque para demostrar que probaches o teu produto a fondo e sabes como usalo de forma segura é escribir e distribuír manuais de usuario. Isto pode reducir significativamente as obrigas relacionadas coa produción de algo para o público en xeral.
Ter advertencias e precaucións de seguridade anotadas e accesibles aos usuarios a través dunha guía do usuario é unha forma eficaz (aínda que non infalible) de evitar problemas legais relacionados con lesións ou outros danos causados por un mal uso se o produto que vende pode ser perigoso para os usuarios (pense quentadores, ferramentas eléctricas, etc.).
Que compoñentes constitúen os mellores manuais de usuario?
Hai algunhas prácticas recomendadas de documentación do usuario final ás que debes cumprir, aínda que cada produto é único e necesitará compoñentes distintos para xerar unha documentación de usuario realmente excelente.
- Linguaxe sinxela
Nada irritará máis aos teus clientes, ademais de non ofrecer un, que descubrir que o seu manual de usuario está cheo de xerga e linguaxe difícil de entender. As túas instrucións de usuario son difíciles de usar debido a estas opcións de idioma, que tampouco promoven un excelente servizo ao cliente. Garantir que estás escribindo para o usuario, non para o programador, é un compoñente crucial para crear excelentes guías de usuario. Non asumas que o teu usuario final sabe ou está familiarizado con nada. Os acrónimos, a xerga e a terminoloxía da oficina farán que os teus clientes se sintan mal informados, frustrados e non preparados. O punto ideal para elaborar un manual de usuario é conseguir un equilibrio entre non escribir coma se os consumidores fosen nenos (a menos que, por suposto, o sexan!) lingua. - Sinxeleza
Escribir un manual de usuario require manter as cousas sinxelas. Este concepto debe reflectirse tanto no contido como no deseño. Se sobrecargas a túa documentación con imaxes complicadas e longas pasaxes de texto, parecerá demasiado sofisticada e difícil de entender. É probable que este tipo de manual de usuario intimide o teu usuario e o faga a chamar á túa liña de axuda en lugar de tentar descubrir o seu problema por conta propia. - Visuais
A máxima "Mostrar, non contar" é unha pedra angular da escritura do manual de usuario. As capturas de pantalla anotadas, as películas e outros contidos visuais son moi útiles para comprender os conceptos. Con frecuencia é moito máis útil ver algo en acción que ler sobre el. Os elementos visuais non só rompen longas pasaxes de texto, senón que tamén reducen a cantidade de texto nos manuais de usuario que pode dar medo. Demostrouse que as persoas conservan a información visual un 7% máis rápido que a información escrita. Nun estudo de Techsmith, tamén se demostrou que o 67% das persoas realizaban tarefas de forma máis eficaz cando se lles daban instrucións que incluían capturas de pantalla anotadas en lugar de palabras só para transmitir información. - Centrarse no problema a resolver
É moi probable que alguén comprou o teu produto para solucionar un problema. É fundamental manter o foco nesta cuestión á hora de redactar o manual de usuario que se incluirá co produto. En lugar de enumerar e discutir todas as funcións que ofrece o teu produto ou os intrigantes elementos de deseño que incorporaches, informa aos teus usuarios sobre elas de forma que facilite o uso do produto. Coloca o problema que se está a resolver no contexto das características e beneficios do teu produto ao describilos. - Fluxo lóxico e xerarquía
Para que o usuario vexa o que aprenderá de cada sección do seu manual de usuario, utilice cabeceiras e subtítulos que sigan unha estrutura xerárquica clara. Para guiar sen esforzo aos seus clientes a través de todo o que necesitan saber desde o principio ata a conclusión, a xerarquía que elixa debe seguir un fluxo lóxico. Asegúrate de comezar cos fundamentos e incorporar unha progresión lóxica cara ás funcións máis sofisticadas do teu produto. - Lista de contidos
A súa guía de usuario será máis útil para os lectores se comeza cunha táboa de contidos. Sen ter que explorar moitas páxinas de información allea ao problema actual ao que se enfrontan, é un enfoque familiar para alguén explorar un documento de forma rápida e sinxela. - Facelo buscable
Aínda que poida imprimir os seus manuais de usuario, é probable que a documentación dixital sexa a súa principal prioridade. É moi probable que os seus manuais de usuario se utilicen con máis frecuencia nun formato dixital nun mundo no que a maioría da xente ten un teléfono intelixente consigo en todo momento. Engadir unha función de busca aos seus manuais de usuario dixitais promoverá unha facilidade de uso agradable para os usuarios que buscan resolver un problema accedendo a el, de xeito similar ao que serve unha táboa de contidos para dirixir aos usuarios ao lugar adecuado nun documento impreso. - Accesibilidade
É posible que algunhas das persoas que requiren o teu manual de usuario poidan beneficiarse dunha asistencia adicional para garantir que funciona correctamente. Independentemente de que sexan obrigados pola lei, os requisitos de accesibilidade son xeralmente unha boa práctica. Manter os requisitos de accesibilidade nos seus manuais de usuario é só unha excelente práctica comercial. Deseñar guías de usuario con contido accesible para usuarios que poidan ter problemas visuais, audibles ou cognitivos é fundamental. - Ben deseñado
Ten en conta a túa audiencia ao crear as túas guías de usuario. Estarán moito máis inclinados a usalo de forma eficaz se fas algo que lles guste mirar! Evite usar bloques de texto longos e proporcione moito espazo en branco. A combinación destas dúas características pode axudar aos consumidores a parecer menos asustado e facer que aprender algo novo pareza emocionante en lugar de ameazante. O enfoque "mostrar, non contar" que describimos anteriormente tamén se aplica aquí. Para os manuais de usuario impresos e dixitais, engadir imaxes e fotos ao texto é unha excelente alternativa. Para os manuais de usuario dixitais, os vídeos e os GIF ofrecen interese e un elemento útil. Se a túa empresa ten unha guía de estilo, o teu deseño debería seguila; en caso contrario, se está a operar sen un, é fundamental manter a súa guía de usuario coherente. O tipo de letra e os esquemas de cores utilizados en todo o papel, e idealmente en todas as súas guías de usuario, deben ser coherentes. - Comentarios de clientes reais ou probadores beta
Non poderás determinar se as guías de usuario que preparaches teñen ou non o maior éxito posible ata que busques e escoites os comentarios das persoas que realmente utilizarán o teu produto. As guías de usuario que desenvolvas para o teu produto deberían ter en conta os problemas que a xente ten con el. Podes aprender algo que parece extremadamente evidente, pero hai moitas máis posibilidades de que aprendas algo que che axude a comprender as necesidades dos clientes aos que intentas chegar.
Como escribo un manual de usuario?
Facer un manual de usuario é unha tarefa crucial que pode ter un gran impacto tanto na túa empresa como nos consumidores aos que queres atender. Simplificamos o proceso de desenvolvemento dun manual de usuario para que poidas seguir facilmente porque pode ser abrumador.
- Identificar os usuarios
Encontrar o destinatario da túa comunicación é un paso inicial esencial, igual que con calquera outra comunicación que xeres. O público destinatario do manual de usuario axudarache a decidir sobre cuestións como o ton, o nivel de detalle a proporcionar e como entregar o contido. Escribir unha guía de usuario para o usuario final do seu produto é significativamente diferente de escribir unha para un enxeñeiro técnico. O primeiro paso é determinar a túa audiencia. - Concéntrase no problema
Os manuais de usuario están feitos para axudar a resolver problemas ou instruír a alguén sobre como facer algo novo. Debes determinar con precisión o que pretende facer o teu manual de usuario e asegurarte de manter ese foco.
Pode ser tentador ampliar o tema e discutir numerosas funcións ou aplicacións para o seu produto. Isto pode frustrar aos usuarios e levar a chamadas á túa liña de atención ao cliente ao nublar a resposta xenuína que necesitan.
Se o teu cliente é un consumidor que está a aprender a usar o produto ou un técnico que necesita arranxalo, concéntrate na solución precisa que necesitará. - Emprega un enfoque secuencial
As instrucións do seu manual de usuario deberían estar dispostas na orde secuencial necesaria para rematar o traballo en cuestión. Enumere cada paso para comezar. A continuación, esfórzase para facer a tarefa mentres segues os pasos precisos que indicaches na orde indicada. A medida que repasas a túa lista orixinal, é posible, quizais mesmo probable, que atopes algún stages que faltan. Ademais, podes descubrir que algo que antes crías que era unha única tarefa en realidade ten que dividirse en varias actividades por motivos de claridade.
Asegúrate de especificar un resultado claro para cada paso secuencial que asignaches antes de pasar á seguinte fase de redacción dunha guía de usuario. Antes de pasar ao seguinte nivel, os lectores deben ter completamente claro o que queren lograr e como debería parecer. - Mapear a viaxe do usuario
Comprender como pensan usar os teus consumidores o teu produto e simplificarlles o seu uso son os obxectivos da elaboración dunha guía de usuario. Debes esforzarte por comprender o problema que o consumidor está a tratar de resolver ou o obxectivo que está tentando lograr mediante a utilización da túa solución, así como como se relacionan co teu negocio. Podes planificar os pasos necesarios para guiar ao cliente a través do proceso usando estes detalles para visualizar a súa viaxe do problema á solución. - Escolla un modelo
A tarefa de escribir e desenvolver manuais de usuario pódese facer moito máis sinxela do que podería esperar creando unha serie de modelos. O seu procedemento pode ser simplificado, e a coherencia converteríase nun obxectivo moito máis realista.
No seu modelo de manual de usuario, ademais de definir detalles como fontes (tipo e tamaño), requisitos de contraste e esquemas de cores, tamén debe incluír o seguinte:- Área asignada para unha introdución
- Subseccións e seccións diferenciadas
- O formato escollido para transmitir unha serie de accións
- Notas de precaución e advertencias
- Área asignada para unha conclusión
- Escribe contidos sinxelos e fáciles de seguir
O material do manual de usuario debe ser o máis sinxelo e sinxelo de entender posible. É importante pensar e analizar o formato e o contido para obter claridade e comodidade.
Asegúrese de que cada fase do proceso só describe unha tarefa e emprega unha linguaxe tan clara e breve como sexa posible. Asegúrate de modificar correctamente o teu texto ata que teñas un manual de usuario que conteña só a información que é realmente necesaria. - Achégase a cada usuario como un novato
Supoña que o lector do seu manual de usuario non ten coñecementos previos do seu produto ao crealo. Escribe coma se lle falases a un profano.
Debe evitarse calquera uso de xerga ou linguaxe técnica. Por suposto, haberá momentos nos que debe evitarse, pero estes deberían ser a excepción absoluta. - Proba as instrucións do produto con usuarios novatos
A fase de proba do proceso de creación do manual de usuario é crucial. O tema da experimentación ten un impacto significativo no resultado.
O ideal é que as probas se fagan en persoas que nunca usaron o teu produto nin viron a documentación. A medida que avanzas polo manual de usuario, observa como completan o proceso e rexistra onde se atascan. Entón, a información debe actualizarse adecuadamente.
Só debería ser necesaria a axuda do manual de usuario para que os probadores poidan utilizar o produto. Non deberían pedir máis axuda. A Guía da URSS debería ter toda a información que precisan. - Construír contidos utilizando un enfoque práctico
Débese facer todo o posible para ofrecer exampleiros e descricións detalladas de calquera resultado que poidan experimentar os usuarios despois de seguir cada paso do manual de usuario. O usuario debe ser consciente de calquera comentario que poida recibir do produto, así como de calquera imaxe ou son que poida atopar ao longo do camiño. - Explica os símbolos, iconas e códigos antes
É posible que teñas que empregar iconas, símbolos ou códigos mentres escribes un manual de usuario para proporcionar as instrucións necesarias. Para evitar a confusión ou a frustración dos lectores, é fundamental identificalos o antes posible no seu manual de usuario.
Preguntas frecuentes do manual de usuario
Que son exactamente os manuais de usuario?
A documentación do usuario é información proporcionada en forma de manuais ou guías de usuario e ten como obxectivo axudar aos usuarios finais a interactuar con éxito cun produto.
- Que tipo de documentación de usuario hai?
A documentación física, como folletos ou manuais, utilizouse tradicionalmente para ofrecer documentación ao usuario. Hoxe en día, os manuais de usuario prodúcense e distribúense con maior frecuencia dixitalmente. - Que contén os manuais de usuario?
Un manual de instrucións ou unha guía de usuario utiliza un bo deseño, unha escrita clara e un enfoque para resolver problemas. Debo ter unha táboa de contidos, adherirme a unha xerarquía e fluxo lóxicos e ofrecer contido accesible. Ademais, pódese buscar un bo manual de usuario e terá en conta o usuario reviews. - Como se fai un documento de usuario?
Pódense usar pasos sinxelos para desenvolver manuais de usuario. Primeiro hai que determinar os obxectivos da guía de usuario e desenvolver unha estratexia que permita a súa consecución. O manual de usuario debe ser probado e actualizado segundo sexa necesario antes de ser publicado. Por último, é importante manter actualizada a guía do usuario, facendo cambios a medida que se engaden novas actualizacións ou edicións.