Guía del usuario

Un guía de usuario o Guía del usuario, También conocido como Manual, Es un documento de comunicación técnica destinado a dar asistencia a las personas que utilizan un sistema en particular.^[1] Por lo general, este documento esta escrito por un escritor técnico, Aunque las guías del usuario están escritas por los programadores, de producto o de los directores de proyectos, o el personal técnico, especialmente en las empresas más pequeñas.

Los Guías del usuario son más comúnmente asociados con los productos electrónicos, computadoras y programas.

La mayoría de las guías de usuario contienen tanto una guía escrita y imágenes asociadas. En el caso de las aplicaciones informáticas, es habitual incluir imágenes de pantallas de cómo el programa debería ser, y manuales que a menudo incluyen diagramas claramente detallados y sencillos. El lenguaje utilizado esta sencillo, dirigido a una audiencia que puede no entender la jerga técnica.

Las secciones de un manual de usuario a menudo incluyen

Una página de portada Una página de título y los derechos de autor Un prefacio, que contiene detalles de los documentos relacionados y la información sobre cómo navegar por la guía del usuario Una página de contenido Una guía sobre cómo utilizar al menos las principales funciones del sistema Una sección de solución de problemas que detalla los posibles errores o problemas que pueden surgir, junto con la forma de solucionarlos Una sección de Preguntas frecuentes ¿Dónde encontrar más ayuda, y datos de contacto Un Glosario y, para documentos más grandes, un Índice

Manuales y guías de programas informáticos

Manuales de usuario y guías de usuario para la mayor parte no trivial las aplicaciones de software son parecidos a un libro de documentos con contenidos similares a la lista anterior. El Starta Manual del usuario^[2] es un buen ejemplo de este tipo de documento. Algunos documentos tienen una estructura más fluida con muchos enlaces internos. El Google Earth Guía del usuario^[3] es un ejemplo de este formato. El término guía se suele aplicar a un documento que aborda un aspecto específico de un producto de software. Algunos usos son Guía de Instalación , Guía de introducción, Y varias de Cómo guíar. Un ejemplo es el Picasa Guía de introducción.^[4]

En algunos software de negocios de aplicaciones, donde los grupos de usuarios tienen acceso sólo a un subconjunto, conjunto de toda la funcionalidad de la aplicación, una guía de usuario puede ser preparado para cada grupo. Un ejemplo de este enfoque es el Autodesk Topobase 2010 Ayuda[^[5] documento, que contiene por separado Guía del Administrador, Guías de Usuario, Y una Guía de desarrollo. Estas guías son una herramienta valiosa para el entrenamiento en el trabajo.

Referencias

1. ↑ «Online Technical Writing: User Guides». [e-mail]. Consultado el 13 de agosto de 2009.
2. ↑ «Starta User Manual». Starta Development, Inc. (16 de octubre de 2006). Consultado el 13 de agosto de 2009.
3. ↑ «Google Earth User Guide». Google (4 de junio de 2009). Consultado el 13 de agosto de 2009.
4. ↑ «Getting Started with Picasa: Getting Started Guide». Google (15 de junio de 2009). Consultado el 13 de agosto de 2009.
5. ↑ «Autodesk Topobase 2010 Help». Autodesk. Consultado el 13 de agosto de 2009.

Véase también

Notas de la versión Libro de Moe Redactor técnico Página de manual (Unix) Manual de instrucciones (de juego) Tarjeta de referencia