Paso 1 Obtener conocimientos generales sobre la plantilla de Manual de usuario
antes de usar realmente la plantilla de Manual de usuario y las otras herramientas que desarrollé para Philip, quería asegurarme de que tenemos el mismo punto de partida. Le proporcioné información general sobre instrucciones de usuario y algunos buenos ejemplos de manuales de usuario existentes.
he enumerado esta información a continuación.,
¿Cuál es la definición de un manual de usuario?
un manual de usuario es un documento de comunicación técnica destinado a dar asistencia a las personas sobre cómo utilizar un producto. Un buen manual de usuario ayuda a los usuarios a usar un producto de forma segura, saludable y efectiva.,
otros nombres, u otras formas de un manual de usuario, podrían ser:
- Guía de usuario
- documentación técnica
- manual de instrucciones
- manual de operaciones
- manual de formación
- Guía de inicio rápido
- manual de instalación
- manual de mantenimiento
- manual de Software
Además del objetivo principal de un manual de para ayudar a un usuario), los objetivos secundarios podrían ser crear una mejor experiencia de usuario y cumplir con los requisitos legales.
un manual de usuario consiste en información visual textual(ilustraciones, capturas de pantalla, tablas, etc.,) para ayudar al usuario a completar tareas específicas.
el usuario desempeña el papel central a la hora de elaborar un manual de usuario. Un manual de usuario bien redactado solo proporciona la información que es relevante para el usuario previsto del producto.
el manual del Usuario debe contener tanto información de procedimiento (instrucciones paso a paso) como información conceptual (información que el usuario necesita para comprender la información de procedimiento).
un buen manual de usuario es conciso y utiliza un lenguaje libre de jerga. Un buen manual de usuario debe responder cómo y qué preguntas., Deben contener información sobre lo que sucede si una tarea no se realiza correctamente.
en algunos casos, un producto está destinado a ser utilizado por diferentes tipos de usuarios. Los tipos de usuario típicos son el usuario final, el instalador, el ingeniero de mantenimiento y el operador. Cada tipo de usuario necesita un enfoque diferente en términos de lenguaje a utilizar, el tono de voz y la información conceptual proporcionada.
¿qué información debe estar en un manual de usuario?
diferentes tipos de productos necesitan un manual de usuario. Un producto puede ser un sistema, una herramienta, un dispositivo, un instrumento, un software o una aplicación.,arnings
usando una plantilla de manual de usuario
la herramienta principal que desarrollé para ayudar a Philip a elaborar su manual de usuario es una plantilla de manual de usuario., La plantilla contiene toda la información y más de la lista anterior. Cumple con los requisitos para su producto.
La Plantilla Manual Del Usuario se puede utilizar para crear su manual para su sistema, herramienta, dispositivo, instrumento, o para crear un manual de instalación, manual de software, manual de operación, manual de mantenimiento o manual de capacitación.
basado en la primera plantilla para Philip, hemos desarrollado plantillas para los siguientes grupos de productos:
- dispositivos médicos
- Juguetes
- Maquinaria
- electrónica
¿qué formatos tiene un manual de usuario?,
los manuales de usuario se pueden proporcionar en formato de papel o como documento electrónico (PDF o colocados en línea o en el dispositivo en HTML). La plantilla de manual de usuario es un documento de MS Word que se puede imprimir o colocar en línea.
los manuales de usuario se pueden crear utilizando una variedad de herramientas. Cada herramienta tiene sus propias ventajas y desventajas., contenido posible
solución todo en uno
td>
ejemplos de manuales de usuario
al redactar un manual de usuario con la ayuda de la plantilla manual de usuario, puede ser útil tener algunos buenos ejemplos., A través de los siguientes enlaces puede descargar un ejemplo de manual de usuario para la documentación:
- instrucciones de instalación de IKEA
- manual de usuario de Jura
Paso 2 identifique al usuario(s) de su plantilla de Manual de usuario
Ok, por lo que ahora Philip tiene algunos conocimientos básicos sobre los manuales de usuario. Vamos a sumergirnos en los detalles y acciones.
cuando desea escribir un manual que ayude a su usuario a resolver problemas, primero debe definir quién es su usuario. Esto se puede hacer creando un perfil de usuario, también llamado persona.,
con una persona, haces algunas suposiciones razonables sobre las características de tu usuario. Esto no solo es útil para crear sus instrucciones de usuario, pero es un elemento esencial en el inicio del desarrollo de cualquier producto! Como ingeniero de diseño industrial educado, así es como comenzamos todas nuestras tareas de diseño.
al revisar el sitio web de ISOVOX, ni siquiera encontré una descripción clara de sus usuarios previstos. Por eso le pedí a Philip que definiera a sus usuarios y respondiera preguntas como:
- ¿Quién es el usuario de tu producto?,
- ¿El producto se utiliza de forma profesional o principalmente privada?
- ¿Qué otras experiencias técnicas tienen? ¿Qué describe al usuario?
he creado una plantilla que contiene las preguntas. Le pedí a Philip que llenara la plantilla.
Puede usar la plantilla usted mismo para determinar quién es su usuario. Tenga en cuenta que la segunda pestaña también contiene las respuestas de Philip, por lo que tiene un ejemplo de cómo se podría usar la hoja.acción
: utilice la plantilla para describir a sus usuarios.
Soy un gran fan de visualizar cosas., Así que si quieres llevar la definición de tu USUARIO un paso más allá, te sugeriría que visualices a tu usuario en forma de persona. Al crear una persona, le estás dando a tu USUARIO un nombre, edad, etc., para que se convierta en una persona real que represente a tu usuario.
hice esto por Philip., Este es el resultado:
acción: crea una visualización de tu usuario
Si quieres saber más acerca de la definición de tu público y la creación de personas:
Paso 3 Creación de temas para los problemas de tu usuario
comience con la identificación de los problemas que su(s) Usuario (S) podrían encontrar durante el ciclo de vida del producto y que él/ella quiere resolver. Los problemas típicos pueden incluir: la instalación del producto, el uso del producto, el uso del producto de forma segura, el mantenimiento del producto y la eliminación del producto.,
si el problema es demasiado complejo, puede dividirlo en trozos.
le pedí a Philip que identificara los problemas y soluciones que su usuario podría encontrar durante el ciclo de vida del producto. Para hacerlo, creé otra plantilla para Philip. En la columna izquierda de la pestaña ciclo de vida, se mencionan las etapas del ciclo de vida de un producto. Estos se derivan del estándar internacional para instrucciones de usuario, el IEC / IEEE 82079. Nuestras plantillas de manual de usuario cumplen con este estándar.
en la pestaña ciclo de vida puede ver cómo Philip ajustó el ciclo de vida a su propio producto.,
acción: Utilice esta plantilla y las instrucciones de la primera pestaña para identificar los problemas que su usuario pueda tener durante el ciclo de vida de su producto y presentar sus soluciones.,
si quieres saber más sobre cómo definir los problemas de tu USUARIO y crear temas:
- creación basada en temas
- Minimalismo
- mapeo de Información
- Chunking
Paso 4 Define la estructura de la plantilla manual del Usuario
Philip ahora ha identificado los problemas que un usuario podría tener con su producto durante su ciclo de vida y ahora ha pensado en la solución para resolver el problema. En otras palabras: Philip ha definido los temas para su manual de usuario., Cada tema solo puede ser sobre un tema específico, tiene un propósito identificable, y debe ser capaz de mantenerse por sí solo.
un tema debe dar la respuesta a la pregunta de un solo usuario. Un usuario quiere resolver un problema a la vez. Cuando un usuario ha resuelto el problema, él / ella irá y resolverá el siguiente problema.
un tema se convertirá en una sección en el manual del usuario. Puede ser un capítulo o un (sub)párrafo. Tan pronto como un usuario está buscando una respuesta a su problema, utilizará la tabla de contenidos para averiguar cómo navegar a esa respuesta.,
le pedí a Philip que estructurara los temas y definiera su lugar en el manual del usuario, asignando un tema determinado a un capítulo o (sub)párrafo específico. El resultado se puede ver en la pestaña ToC.
acción: para definir la estructura de su manual de usuario:
- Copie el contenido de la pestaña ciclo de vida a la pestaña ToC.
- En la pestaña ToC, reemplace el nombre del producto con su propio nombre de producto.
- añadir una columna a la izquierda. Llámalo «sección».
- si corresponde, organice sus secciones lógicamente.
- Determine qué temas se convertirán en capítulos agregando números de capítulo., Comience a numerar el producto de preparación para usar con el número 4. Agregaremos algunos capítulos más en el siguiente paso.
- Determine qué temas se convertirán en párrafos agregando los números de sección.
- Determine qué temas se convertirán en subpárrafos agregando los números de subsección.
ahora ha creado la tabla de contenido (ToC). El índice es el esquema de su manual de usuario. Más adelante agregaremos algunos temas/secciones más, como la introducción, información de seguridad, etc., así que no te preocupes por agregar eso ahora.,
Paso 5 crear encabezados significativos
cada tema en el manual del usuario obtiene su propio encabezado. Los encabezados son los (sub)títulos que preceden al texto real. Aparecen en el índice, para que el usuario pueda navegar a la información necesaria.
entonces, Philip acaba de crear los (sub)títulos para sus temas.
debido a que las entradas de ToC juegan un papel tan importante para ayudar a su usuario a encontrar su camino, y para ayudarlos a omitir lo que no es importante, necesitan un poco más de atención.
básicamente, debes tratar de trabajar con tres niveles de encabezados: encabezados de primer, segundo y tercer nivel.,
el encabezado de primer nivel describe de qué trata todo el capítulo o sección (por ejemplo, la instalación del producto). Los encabezados de segundo nivel deben usar el estilo de fraseo «cómo qué» (por ejemplo, cómo ensamblar el producto y cómo realizar la instalación eléctrica). Un título de tercer nivel utiliza frases nominales (por ejemplo, Contenido del envase y herramientas que se utilizarán).
le pedí a Philip que redireccionara sus encabezados y tomara nota de las siguientes pautas generales:
- Use la estructura como se muestra arriba para el encabezado de primer, segundo y tercer nivel.,
- asegúrese de que los encabezados se expliquen por sí mismos. El encabezado hacer panqueques está mucho más orientado al usuario que usar el MagicCook5000.
- asegúrese de que el encabezado cubre el tema completo. Si la sección abarca el mantenimiento y la reparación de un producto, el epígrafe mantenimiento sería incompleto.
- Si es posible, intente omitir los artículos al principio de los encabezados
acción: escriba nuevos encabezados para sus entradas de índice.
el índice de Philips con encabezados significativos se puede encontrar en la pestaña Índice w. encabezados significativos.,
Paso 6 determinar el contenido Legal
dependiendo del mercado en el que se coloca o se pone en servicio su producto, y dependiendo del grupo de productos al que pertenece su producto, se aplica legislación específica a su producto.
en general, la legislación requiere que su producto sea «seguro» y, por lo tanto, establece los requisitos generales de seguridad que su producto debe cumplir.
estos requisitos también incluyen requisitos sobre el contenido de su manual de usuario e instrucciones de seguridad.,
para vender su producto en un mercado específico, debe asegurarse de que su manual de usuario cumpla con estos requisitos.
estos dos artículos a continuación le indicarán cómo puede averiguar exactamente qué legislación se aplica a su producto para el mercado europeo y estadounidense y cuáles son los requisitos para su manual de usuario. Consejo profesional: cuando ya hay una declaración de conformidad disponible, puede encontrar las directivas aplicables allí.,
- Cómo crear manuales compatibles para la UE
- Cómo crear manuales compatibles para los EE.UU
Philip no tuvo que realizar estos pasos, ya que la plantilla que utilizó ya contenía el contenido legal requerido por las directivas pertinentes.
para su producto, significa que se requiere la siguiente información para el manual de usuario de su producto:
UE (directivas relevantes de marcado CE: LVD, EMC, RoHS, WEEE, REACH):
- el manual de usuario debe traducirse al idioma(s) del país donde se vende el producto.,
- El manual de usuario debe describir el uso previsto del producto.
- el manual de usuario debe describir el uso no intencionado razonablemente previsto del producto.
- si procede, deberá mencionarse el incumplimiento en zonas residenciales.
- El tipo, lote o número de serie u otro elemento que permita la identificación del producto debe mencionarse en el producto. Si el producto es demasiado pequeño, se puede colocar en el manual del usuario.
- El nombre, el nombre comercial registrado o la marca registrada y la dirección postal deben mencionarse en el producto., Si el producto es demasiado pequeño, se puede colocar en el manual del usuario.
- debe realizarse un análisis de riesgos para determinar los riesgos residuales relacionados con el uso del producto. La información de seguridad se facilitará para informar al usuario de las medidas que deban adoptarse.
- Se incluirá información sobre los RAEE
- se incluirá información sobre los residuos de envases.
además de esta legislación, también hay un estándar internacional para manuales de usuario, el IEC / IEEE 82079-1: 2019. Esta norma ha sido armonizada en la UE., El cumplimiento de las normas armonizadas proporciona una presunción de conformidad con la legislación correspondiente!
la plantilla manual de usuario cumple con este estándar.
También he creado una lista de verificación IEC 82079 que se puede usar para verificar que su manual de usuario cumpla con esta norma.
para crear un manual de usuario que cumpla con los requisitos internacionales, siempre debe asegurarse de que su manual cumpla con los requisitos de la UE, EE.,
acción: para determinar los requisitos legales en su manual de usuario:
- siga los pasos 1-2 del cumplimiento de la UE y / o los pasos 1-6 de los artículos de cumplimiento de los EE.
- estudie la lista de verificación IEC 82079 para asegurarse de que su manual cumpla con el estándar 82079.
en este video explico cómo puedes crear un manual que cumpla con el estándar 82079:
a la tienda
Paso 7 descarga y prepara la plantilla del manual de usuario
ahora Philip puede comenzar la creación real de su manual de usuario.,
le pedí que ajustara la tabla de contenido de la plantilla de acuerdo con su propia tabla de contenido. Sin eliminar y elementos obligatorios, por supuesto…
¿recuerdas del paso 4 que pedí comenzar la numeración de las secciones con el capítulo 4? Una vez que descargue el manual de usuario template doc usted mismo, verá que se han agregado algunos capítulos estándar, así como algunos apéndices.,
acción: para ajustar la plantilla manual del usuario:
Si desea trabajar con la plantilla gratuita:
- descargue la plantilla manual del usuario gratuita Word 2013 o 2007
- cambie los encabezados de sección de acuerdo con su propio índice. ¡Aviso! No Ajuste la tabla de contenido. La tabla de contenidos se puede actualizar automáticamente una vez que haya ajustado los encabezados de sección.
- agregue el contenido obligatorio como se determina en el paso 6 de su manual.
- si corresponde, modifique las secciones 1-3 y los apéndices de acuerdo con sus propias necesidades.,
o use una de nuestras plantillas de pago que contengan todo el contenido obligatorio, como hizo Philip:
- dispositivos médicos EU
- dispositivos médicos US
- Machinery EU
- Machinery US
- Electronics EU
- Toys EU
Paso 8 cree el contenido para su plantilla de manual de usuario
escriba el>
el propósito de su producto, o mejor: el uso previsto, es el corazón de un manual de usuario y forma la base para garantizar el uso seguro y saludable del producto.,
la forma en que se describe el uso previsto también determina su responsabilidad y afecta el contenido adicional del manual del usuario.
la mayoría de la legislación requiere que incluya una descripción del uso previsto en las instrucciones del usuario.
el estándar internacional para instrucciones de usuario, el IEC 82079-1, proporciona la siguiente definición para el uso previsto:
una gama exhaustiva de funciones o aplicaciones previstas definidas y diseñadas por el proveedor del producto
Al describir el uso previsto, determina la envoltura segura del producto., Y una vez que haya determinado el uso previsto, puede centrarse en proporcionar solo esas instrucciones de seguridad y de usuario sobre cómo usar el producto dentro del sobre dado.
Además, para el uso previsto, muchas más normas, directivas y regulaciones también requieren que incluya una descripción del uso indebido razonablemente previsible.
por ejemplo, el uso indebido razonablemente previsible de un detergente agresivo podría ser su uso en un entorno de procesamiento de alimentos.
prestar muy poca atención a la descripción del uso indebido razonablemente previsible afectará a la responsabilidad de la empresa.,
Las leyes / regulaciones de responsabilidad del producto responsabilizan al fabricante por un producto defectuoso. Si es necesario determinar la deficiencia de un producto, se tendrán en cuenta todas las circunstancias. Que incluye el uso razonablemente previsible del producto.
la descripción del uso previsto determina qué instrucciones se dan en el resto del manual. Por ejemplo, si un sistema de enfriamiento solo se usa para enfriar ciertos medicamentos, solo se deben describir estos procedimientos.,cuando pueda preverse razonablemente que el sistema de refrigeración pueda utilizarse como sistema para enfriar órganos, deberá describirse en las instrucciones. Al hacerlo, usted, como fabricante, limitará su responsabilidad y podrá centrarse solo en describir cómo usar el sistema para enfriar medicamentos.
acción: escriba el uso previsto y el uso indebido razonablemente previsible de su producto.
Figura 1. ¿Uso indebido razonablemente previsible?,
escriba las advertencias de seguridad basadas en el análisis de riesgos
aunque el uso previsto ya se ha definido claramente, esto no significa que el uso de un producto esté completamente libre de riesgos.
para identificar los peligros que conlleva el uso de un producto, puede realizar un análisis de riesgos. Un análisis de riesgos también puede ser obligatorio para ciertos grupos de productos, como equipos de baja tensión, juguetes, maquinaria y equipos para su uso en atmósferas explosivas.
Se han desarrollado normas, como la ISO 12100, sobre cómo realizar un análisis de riesgos., La ISO 12100 también da un método para tomar medidas de mitigación: el método de tres pasos. De acuerdo con este método, existe la siguiente jerarquía de medidas de reducción de riesgos:
- Medidas de diseño inherentemente seguras
- Medidas de salvaguardia y protección complementaria
- Información para el uso
esto significa que la guía del Usuario debe advertir de cualquier riesgo residual relacionado con el uso del producto. Esto se hace con advertencias de seguridad.,
Comprar ahora
una buena advertencia de seguridad describe la naturaleza de una situación peligrosa, las consecuencias de no evitar una situación peligrosa y los métodos para evitarla.
para indicar el grado de peligro que puede encontrar el Usuario, se deben usar las palabras de advertencia «Peligro», «Advertencia» y «precaución».
eche un vistazo a los siguientes mensajes de seguridad:
¡atención! Piezas giratorias. Riesgo de lesiones graves. Mantén las manos despejadas. Bloqueo / etiquetado antes del servicio.
entonces desea advertir al usuario donde se puede encontrar una situación peligrosa. El ANSI Z535.,6 estándar describe las siguientes ubicaciones en el manual del usuario donde esto podría ser:
- agrupado en un capítulo separado.
- En la primera parte de la sección específica:
- Embebido en un procedimiento:
1. Haz esto.
2. Conseguirlo. ¡Advertencia! Esto es Mensajes de seguridad incrustados. Texto General texto general texto general.3. Haz esto.,
- En el prefacio se pueden colocar todas las directivas complementarias, como leer todas las instrucciones antes de usar o mantener estas instrucciones para futuras referencias, en la introducción de un manual del usuario.
en la UE, dependiendo del tipo de producto, solo se puede proporcionar la información de seguridad en forma impresa y el resto de la información en línea.
para ayudar a Philip a crear y colocar un mensaje de seguridad, he creado otra plantilla.
acción: realice un análisis de riesgos y elabore sus mensajes de seguridad utilizando esta plantilla.,
crear todo el otro contenido
ahora le pedí a Philip que creara todo el otro contenido, como los Procedimientos, las especificaciones técnicas y la información legal.
Di los siguientes consejos:
- excluir material innecesario para evitar la sobrecarga de información (por ejemplo, promoción de ventas, repetición extensa, etc.).
- asegúrese de que los Términos sean familiares para el usuario, las características técnicas y los Términos estén bien explicados y use los Términos de manera consistente.
- describa los requisitos previos que deben cumplirse antes de que comiencen las instrucciones reales., Esto también puede describir herramientas especiales o espacio para el mantenimiento y reparación.
- Proporcionar información conceptual cuando la información sea necesaria para la adecuada comprensión y ejecución de las tareas.
- siempre escribe basado en temas.
- utilice un tipo de letra negrita para todos los elementos del producto.
- Use una guía de estilo para ayudarle a escribir y formatear la documentación de una manera más clara.
- indique cuándo desea agregar una imagen para una mejor comprensión más adelante.
- asegúrese de que las palabras y frases no sean demasiado complicadas o demasiado sofisticadas.,
- Use frases simples / estandarizadas y cortas: una oración – un comando.
- No pongas demasiada información en una oración.
- utilice los comandos de voz activa directa y asertivos.
- Use palabras como sustantivos y verbos consistentemente para evitar ambigüedades.
- Para escribir mejores instrucciones, utilice los principios del minimalismo en la comunicación técnica y el Inglés Técnico Simplificado.
acción: crea el resto del contenido para tu manual de usuario.
de nuevo, para la mayoría de los grupos de productos hay plantillas de pago disponibles que podrían hacer el trabajo más fácil., Estas plantillas contienen todos los textos legales, información de eliminación obligatoria, declaraciones de derechos de autor y cumplen con la norma IEC 82079 sobre instrucciones de uso.
coloque las advertencias de seguridad en la posición correcta
al usar la plantilla para elaborar los mensajes de seguridad, le pedí a Philip que indicara si un mensaje de seguridad es una directiva complementaria, o debe colocarse como un mensaje de seguridad agrupado, de sección o incorporado.
ahora que se ha creado todo el texto, los mensajes de seguridad se pueden colocar en el lugar correcto.,
acción: coloque todos los mensajes de seguridad en la ubicación correcta en el manual del usuario.
Paso 9 agregue navegación a su plantilla de Manual de usuario
un manual de usuario debe ayudar a las personas proporcionando información sobre cómo usar un producto. Encontrar la información correcta que resuelve el problema del Usuario debe tomar el menor tiempo posible.
La elaboración de encabezados significativos es una de las herramientas que ayudan a los usuarios a encontrar información., Sin embargo, hay varias otras herramientas para ayudar al usuario a encontrar la información que desea, como:
- tabla de contenidos
- numeración de páginas
- Index
le pedí a Philip que actualizara la tabla de contenidos y agregara numeración de páginas y un índice.
acción: agregue o actualice su tabla de contenido, numeración de páginas e Índice.
Paso 10 revise su Manual de usuario
Philip ha creado la versión preliminar de su manual de usuario, utilizando la plantilla manual de usuario. Llamamos a esta versión el diseño de contenido textual.,como Philip tiene un socio comercial y un desarrollador con un profundo conocimiento técnico del producto, le pedí a Philip que les permitiera revisar el trabajo hasta ahora.
tanto su socio comercial como el desarrollador proporcionaron comentarios. Philip utilizó esta retroalimentación para optimizar el manual del usuario.
acción: envíe la versión preliminar del manual del Usuario a cualquier persona de su equipo que pueda enviar comentarios. Pídeles que combinen todos los comentarios en un documento antes de enviártelo. Esto estimula la discusión de los miembros de su equipo y evita desacuerdos en una etapa posterior.,
paso 11 crear las imágenes
Una vez revisado y optimizado el manual de usuario, los textos son más o menos definidos. Esto significa que cualquier imagen ahora se puede crear y agregar al contenido.
la razón para esperar hasta que los textos estén listos es que crear o editar imágenes puede llevar mucho tiempo. Como las imágenes deben soportar, reemplazar o aumentar el texto, debe esperar para crearlas hasta que los textos sean finales.
Las imágenes en los manuales de usuario pueden incluir ilustraciones, fotos, capturas de pantalla, tablas, diagramas y esquemas.,
Hay muchas herramientas excelentes que pueden ayudarlo a crear sus imágenes, como:
- Snagit o Adobe Photoshop para editar capturas de pantalla o fotos
- Solidworks Composer o Google Sketchup para crear dibujos lineales
- Lucidchart o Microsoft Visio para diagramas y esquemas
aconsejé a Philip no usar fotos como alternativa barata para ilustraciones. A menudo, las fotos no son tan informativas porque contienen demasiada información. Además de eso, las fotos pueden hacer que un manual de usuario se vea desordenado.,
Por esa razón, Philip utilizó Google Sketchup para crear sus ilustraciones.
acción: crea las imágenes para tu manual de usuario.
si quieres saber más sobre la creación de imágenes:
- usando texto, imágenes o video
- creando manuales IKEA-ish
paso 12 comprobación Final de la plantilla del manual de usuario
antes de empezar a hacer que se vea bien y traducir el contenido, queremos estar seguros de que el contenido está completo.
para hacerlo, le pedí a Philip que usara una lista de verificación.,
acción: l asegúrese de que su manual de usuario cumple con todos los requisitos relevantes de la IEC 82079-1: 2012 utilizando esta lista de verificación.
paso 13 Diseña tu plantilla de manual de usuario
Un manual bien diseñado contribuye a una mejor marca y experiencia de usuario.
Puede ajustar la plantilla del manual del usuario en MS Word agregando un logotipo de la empresa y ajustando la fuente, los colores, etc., pero eso podría tener limitaciones.
Cuando sepas cómo trabajar con Adobe Indesign, o estés dispuesto a aprender a trabajar con él, esto te ofrecerá muchas mayores posibilidades de diseño.,
creé esta plantilla en Indesign y le pedí a Philip que la ajustara para que coincidiera con su identidad de marca.
acción: Ajuste la plantilla del manual del usuario para que se ajuste a su identidad de marca, o descargue la plantilla del manual del usuario de InDesign y ajústela.
Paso 14 DTP Works
DTP significa Desktop Publishing y Wikipedia lo describe como «la creación de documentos utilizando habilidades de diseño de página en una computadora personal principalmente para imprimir».
Philip ahora tiene tanto el contenido de su manual de usuario (archivo de Word) como la plantilla de manual de usuario (archivo de InDesign)., El contenido debe colocarse en la plantilla de InDesign. Esto se llama autoedición.acción
: coloque el contenido de su archivo de Word en la plantilla de Indesign. Si decidió no usar la plantilla de InDesign pero se adhirió al archivo de Word, puede omitir este paso.
paso 15 traduzca y publique sus manuales de usuario
dependiendo del mercado en el que vaya a vender su producto, es posible que deba traducir el manual de usuario.
Algunos consejos generales:
- Busque un traductor con experiencia similar., Esto podría ser un traductor que tiene experiencia en la traducción de contenido técnico, con productos similares o con la traducción de manuales de usuario.
- Si necesita traducir a varios idiomas, trabajar con una agencia de traducción puede ahorrarle mucho tiempo.
- pregunte al traductor o agencia sobre sus procedimientos de calidad y quién va a revisar el texto después de la traducción.
- como usted conoce mejor su producto y quién es su audiencia, podría ser una buena idea proporcionar al traductor o agencia un glosario o una lista con la terminología que desea utilizar.,
- Busque un traductor que pueda trabajar directamente en su archivo de Word o InDesign o encuentre una agencia que también pueda hacer los trabajos de DTP. Alternativamente, puede hacerlo usted mismo, por supuesto.
como Philip venderá su producto tanto en los EE.UU. como en la UE, decidió trabajar con una agencia.
acción: encuentre un traductor o agencia que se ajuste a sus necesidades y traduzca su manual de usuario.
en general, un manual de usuario debe estar disponible en un formato que sea fácilmente accesible para el usuario. Que se puede imprimir, o utilizar en línea o en el dispositivo.,
como un usuario quiere información en el momento en que la necesita y por lo tanto no piensa en los canales, el mejor enfoque sería proporcionar las instrucciones omni-plataforma.
en la Unión Europea, para algunos grupos de productos, todavía está restringido proporcionar el manual de usuario impreso con el producto.
sin embargo, a partir de abril de 2016, las instrucciones de muchos grupos de productos pueden entregarse en un formato diferente en lugar de en forma impresa. Sin embargo, hay una excepción.
la información de seguridad se entregará en papel junto con el producto., Además, a petición de un consumidor, debe ponerse a su disposición un manual de usuario en papel.
Philip decidió lo siguiente:
- proporciona un manual completo impreso con el producto, incluidas las instrucciones de seguridad.
- creó una guía de inicio rápido separada que también se proporcionará con el producto.
- colocó una versión en pdf del manual completo en línea.
- creará una sección de ayuda en línea en su sitio web con la versión HTML del manual de usuario. Aquí también puede agregar videos., Y al optimizar la versión HTML para los motores de búsqueda, hace que sea más fácil para su usuario encontrar información para su usuario
conclusión
Eso es todo. Así es como Philip creó un manual de usuario compatible con la ayuda de la plantilla de manuales de usuario y las otras herramientas disponibles que proporcioné.
la mejor parte de todo esto es que puedes obtener los mismos resultados que Philip siguiendo este proceso paso a paso sobre cómo crear un manual de usuario.