Cómo crear una guía de usuario: 12 pasos (con fotos)

3 partes:La creación de la documentación de usuario correspondiente Los componentes de un manual de usuario El diseño de un manual legible

que puede ser impreso o disponible en formato digital - - que proporcionan instrucciones sobre cómo hacer algo o el uso de cualquier producto Los manuales de usuario son guías escritas. Aunque el término "guía del usuario" Se asocia con manuales de software, manuales de usuario también equipos de acompañamiento y otros dispositivos electrónicos, tales como televisores, radios, teléfonos y reproductores de MP3, así como artículos para el hogar y equipos de jardinería. Un buen manual educa a los usuarios acerca de las funciones del producto, al mismo tiempo les enseña cómo utilizar de manera eficiente, con todo lo explicado en términos sencillos. A continuación encontrará cosas a considerar al crear un manual de usuario, el contenido de la disposición.

parte 1

La creación de la documentación de usuario correspondiente

Imagen titulada Crear un manual de usuario Paso 1

Definir quién será el usuario. Para escribir un buen libro, es necesario desarrollar el perfil de usuario de destino, ya sea formal - para crear un perfil escrito - o informal - a tomar tiempo para identificar las características de los posibles usuarios del producto. Este perfil es útil cuando usted es parte de un equipo de documentación del usuario por escrito, y le ayudará a llevar el producto desde su concepción hasta su forma final. Para formar un perfil de usuario, tenga en cuenta:

Donde los usuarios van a utilizar la guía, ya sea en casa, en la oficina, en un único ordenador de sobremesa o en el coche. Esto puede determinar no sólo el contenido sino el manual de estilo.
A medida que los usuarios utilizan la ficha. Si el manual debe ser consultado con poca frecuencia o servir sólo como una forma de investigación, se debe tomar la forma de un documento de referencia. Si es algo que los usuarios a menudo consultan desde el principio, la sección de referencias debe ir acompañada de una sección "comienzo" y las instrucciones de las funciones más comunes del producto.
Los usuarios experimentan ya cuentan con el producto y similares. Si el producto es nuevo o muy diferente de competidores similares, es necesario explicar las diferencias e incluir instrucciones sobre cómo empezar a utilizar. Si el producto se ocupa de algo que los usuarios suelen encontrar problemas, ya que algunos programas informáticos, es necesario proporcionar información adecuada y detallando ellos de una manera comprensible.

Imagen titulada Crear un manual de usuario Paso 2

Escriba las necesidades del usuario para que pueda entenderlo. A menos que el usuario tiene un conocimiento técnico, lo mejor es evitar el lenguaje técnico, optando siempre por explicaciones sencillas y claras. El texto debe ser organizada con el fin de imitar el pensamiento de opciones de la lista usuarios- agrupados por función tiene más sentido a la lista de acuerdo a la frecuencia de uso, por ejemplo.

A menudo no hay escape de los términos técnicos, la forma de escribir un manual para un creador de software de gráficos que incluye gráficos de Fibonacci en conjunción con otros gráficos más comunes. En este caso, es útil para definir los términos y proporcionar algún tipo de fondo como una explicación de lo que son los gráficos de Fibonacci y cuáles son sus usos en el análisis financiero.

Imagen titulada Crear un manual de usuario Paso 3

Explicar el problema de que el usuario está tratando de resolver y presentar la solución. Ofrecer una opción como una solución para el problema general es algo que trabaja en la promoción del producto, pero después de la compra que usted necesita aprender cómo poner el producto en uso. Identificar los problemas específicos que enfrentan las personas, explicarlos en el manual y siga las instrucciones para resolverlos.

Si el problema es complejo, romperlo en pedazos más pequeños. Enumerar las instrucciones y soluciones en secuencia. Dividir la información de esta manera es un método conocido como "fragmentación".

parte 2

Los componentes de un manual de usuario

Imagen titulada Crear un manual de usuario Paso 4

Incluir las páginas de portada y el título. Usted necesitará una cubierta para cualquier manual de referencia que una tarjeta simple y una página de título para cualquier manual que es algo más que una hoja de papel doblada.

Si el manual está protegido por derechos de autor, la notificación debe ser insertado en la portada y la página del título.
Si hay términos y condiciones de uso del manual y el producto asociado a él, los puso dentro de la cubierta.

Imagen titulada Crear un manual de usuario Paso 5

Colocar referencias a los documentos relacionados en el prefacio. Si la documentación no es sólo el manual, hacer referencia a los documentos que tienen las versiones actuales aquí. También inserta la sección "Cómo utilizar esta guía"Si hay uno, en el prefacio.

Imagen titulada Crear un manual de usuario Paso 6

Incluir un índice si el manual tiene más de 10 páginas.

Imagen titulada Crear un manual de usuario Paso 7

Ponga instrucciones / procedimientos y materiales de referencia en las referencias. En la mayoría de los casos, estos elementos deben tener sus propias secciones, pero se puede instruir al lector a consultar a un contenido específico de una sección en la otra. Así, el usuario es capaz de encontrar la información deseada rápidamente.

Los procedimientos deben ser escritos con una estructura coherente en la sección de las instrucciones del manual. Comienza con una visión general de la tarea y luego describa lo que debe hacer y lo que el resultado que se obtendrá. Los pasos deben ser numerados y comienzan con verbos de acción, así como los pasos de las secciones de este artículo.

Los materiales de referencia pueden incluir listas de opciones, consejos para la solución de problemas y preguntas más frecuentes. Los glosarios e índices también se pueden añadir al final del manual a pesar de la lista de términos comunes suele aparecer al principio. El índice puede omitirse si el manual es de menos de 20 hojas.

Imagen titulada Crear un manual de usuario Paso 8

Use imágenes para apoyar, si es necesario. Las imágenes pueden ilustrar algunas ideas mejores que los textos, sobre todo para describir procedimientos complejos en los que el usuario necesita información visual para asegurarse de que está llevando a cabo los pasos correctamente. Las imágenes se pueden producir con software de dibujo, las cámaras digitales y software de edición de imágenes (que también se puede utilizar en casos de captura de pantalla).

Después de crear la imagen, guardarla en un formato comprimido y está soportado por software en el que está la diagramación del manual. también reducir el tamaño físico para que se ajuste al tamaño de las páginas, pero sin eliminar los detalles necesarios para el usuario. Si es necesario, puede dividir la imagen en trozos para mostrar las partes pertinentes al lado del texto.

Si está utilizando varias imágenes, estandarizar su tamaño, ya sea de la misma longitud y la anchura o la reducción de la proporción en el tamaño original. Esto hará que se vean más atractivo para el lector. Lo mismo vale para la creación de capturas de pantalla de un ordenador, donde es necesario estandarizar la combinación de colores del sistema para que todos los permisos similares.

A pesar de software de edición como Photoshop y Paint Shop Pro, ofrecen una funcionalidad de captura de pantalla decente, un software dedicado como Snaglt también tiene opciones para modificar, catálogo e insertar anotaciones en las capturas con facilidad.

parte 3

El diseño de un manual legible

Imagen titulada Crear un manual de usuario Paso 9

Elija fuentes legibles. A pesar de las computadoras que llevan cientos de diferentes fuentes, el objetivo de un manual de usuario es fácil de leer. Elegir un pequeño número de fuentes de ese partido es la mejor opción para esto. Las fuentes se pueden dividir fácilmente en dos tipos: gracias y sin gracias.

Las fuentes serif tienen pequeñas líneas decorativas en los extremos de los trazos que componen las letras. Esta fuente funciona mejor para grandes bloques de texto en tamaños de entre 10 y 12 en el cuerpo de un manual impreso. Los ejemplos incluyen fuentes como Times New Roman, Baskerville y Book Antiqua.
Las fuentes sans serif tienen sólo los rasgos que componen las letras sin decoraciones. Estas fuentes pueden ser utilizados en grandes bloques de texto en tamaños de entre 8 y 10 libros de texto digitales, debido a la falta de serif difícil de leer en tamaños hasta 12. Estas fuentes pueden, sin embargo, ser utilizados en grandes tamaños en títulos y encabezados, además de ser grandes para las notas y los números de columnas y tablas. Los ejemplos incluyen fuentes como Arial, Calibri y gótico del siglo.
Optar por las fuentes comunes, como Arial o Times New Roman, de los libros de texto, pero elegir opciones más decorativas para citas y títulos si está escribiendo un manual para un juego de fantasía o ciencia ficción. En el caso de las cotizaciones, también puede mantener la fuente predeterminada del texto, pero ponerlo en cursiva.
Después de definir las fuentes que utilizan, crear una página de prueba para comprobar si coinciden con el papel. Mostrar la prueba a la persona que tiene el poder de establecer el aspecto manual antes de proceder.

Imagen titulada Crear un manual de usuario Paso 10

Piense en el diseño de página. Después de elegir las fuentes, se debe elegir el diseño de todo lo que sucede en la página.

En general, se debe poner el título o el nombre del capítulo en el encabezado o pie de página y puede poner el título del manual en la página izquierda y el título del capítulo en la página derecha. También introducir los números de página en estas regiones, ya sea en el lado derecho (en el encabezado o pie de página) o central (sólo en el pie de página). Puede diferenciar la primera página de cada sección o capítulo de poner el número de página en el pie de página central, mientras que las páginas posteriores se numeran en la esquina exterior de la cabecera.

Puede introducir un texto explicativo en cajas de colores o sombra para separarlos del resto del texto. Elija un color o nivel de sombra que no se superpone el texto.

Crear márgenes razonables en todos los lados, dando espacio adicional alrededor de los bordes para estar unidos.

Imagen titulada Crear un manual de usuario Paso 11

Tenga en cuenta el tipo de encuadernación. Si el manual tiene más de cuatro páginas, tienen que ser asegurados de alguna manera. Los documentos internos se pueden grapar en la esquina superior izquierda de la página, pero el manual que acompaña el producto normalmente están vinculados con uno de tres métodos:

El grapado lateral es adecuado para el manual compuesta por hojas de 21 x 27,5 cm, 21 x 35 cm o 27,5 x 42,5 cm. Los materiales más baratos de 48 páginas o menos se recortan de modo.

La costura de silla es más común que las guías de referencia de terceros que a los manuales suministrados con productos distintos de los vehículos, a pesar de la mano ya obligarse por el mismo. (Paint Shop Pro se vende con una guía, con grapado cuando fue producido por JASC de software).

La espiral es adecuado para guías para utilizar al aire libre, donde los otros enlaces podrían ser demasiado frágil. Algunos de estos manuales tienen páginas plastificadas para prevenir los daños causados por el agua o por tierra.

Imagen titulada Crear un manual de usuario Paso 12

Crear una plantilla para el manual. Varios software de edición de texto y de procesamiento tiene una función para crear una plantilla, así que introduzca el texto y se visualizará automáticamente en la fuente seleccionada para la parte del manual con el que está trabajando. (Este artículo fue escrito inicialmente usando una plantilla de Microsoft Word). La mayoría de estos programas tienen plantillas predefinidas que se pueden adaptar a sus necesidades, por lo que es necesario crear un modelo cero.

Estos software también permite crear "estilos", Pre-definir las fuentes y los tamaños de los encabezados, pies de página, encabezados y texto del cuerpo. Puede seleccionar uno de los estilos definidos (como "Título 1", "normal", "cita") O puede crear su propio estilo. Siga las convenciones de nombres de estilo si tiene varios mensajes de texto para las clases. (Por ejemplo, Word identifica los estilos de títulos como "título 1", "título 2"Etcétera para los diferentes niveles de las partidas.) Trate de crear todos los estilos utilizarán con antelación para que no se detenga y criarlos durante el proceso de escritura.

consejos

Utilice variables de texto siempre que sea posible. Puede asignar valores a ellos, como el nombre de un producto o el título del capítulo, e insertarlos en el documento en lugar de escribir el texto mismo. Cuando obtiene una vista previa o imprimir el manual, el texto tomará el lugar de la variable. Si el cambio de nombre del producto, será más fácil para cambiarlo en el manual de la modificación de la variable de buscar y reemplazar de forma manual en el documento.