Guía del usuario

Documento de comunicación técnica

Una guía de usuario , también conocida comúnmente como manual de usuario , tiene como objetivo ayudar a los usuarios a utilizar un producto, servicio o aplicación en particular. Suele estar escrita por un técnico, un desarrollador de productos o el personal de atención al cliente de una empresa.

La mayoría de las guías de usuario contienen tanto una guía escrita como imágenes asociadas. En el caso de las aplicaciones informáticas, es habitual incluir capturas de pantalla de las interfaces hombre-máquina, y los manuales de hardware suelen incluir diagramas claros y simplificados . El lenguaje utilizado se adapta al público al que va dirigido , y se reduce al mínimo la jerga o se explica detalladamente.

Contenido de un manual de usuario

Las secciones de un manual de usuario a menudo incluyen:

Una portada
Una página de título y una página de derechos de autor
Un prefacio que contiene detalles de los documentos relacionados e información sobre cómo navegar por la guía del usuario.
Una página de contenidos
Una sección de Propósito. Debe ser una descripción general, no un detalle del objetivo del documento.
Una sección de Audiencia para indicar explícitamente quién es la audiencia prevista que debe leer, incluidos los elementos opcionales.
Una sección de Alcance es crucial ya que también sirve como descargo de responsabilidad, indicando lo que está fuera del alcance y lo que está cubierto.
Una guía sobre cómo utilizar al menos la función principal del sistema.
Una sección de solución de problemas que detalla posibles errores o problemas que pueden ocurrir, junto con cómo solucionarlos.
Preguntas frecuentes ( FAQ )
Dónde encontrar más ayuda y datos de contacto
Un glosario y, para documentos más grandes, un índice

Historia

Se han encontrado manuales de usuario en dispositivos antiguos. Un ejemplo es el Mecanismo de Antikythera , ^[1] una computadora analógica griega de 2000 años de antigüedad que fue encontrada en la costa de la isla griega de Antikythera en el año 1900. En la tapa de este dispositivo hay pasajes de texto que describen las características y el funcionamiento del mecanismo.

A medida que la industria del software se fue desarrollando, la cuestión de cómo documentar mejor los programas de software no estaba resuelta. Este era un problema exclusivo de los desarrolladores de software, ya que los usuarios a menudo se frustraban con los documentos de ayuda actuales. ^[2] Algunas consideraciones para escribir una guía de usuario que se desarrolló en esta época incluyen:

el uso de un lenguaje sencillo ^[2]
longitud y dificultad de lectura ^[2]
El papel de las guías de usuario impresas para programas digitales ^[3]
Diseño centrado en el usuario ^[3]

Manuales y guías de software informático

Antes de Unix , por ejemplo, GCOS , la documentación del mainframe consistía en páginas impresas, disponibles localmente para los usuarios (personal, estudiantes...), organizadas en carpetas de acero, bloqueadas entre sí en un estante de lectura de acero monolítico, atornillado a una mesa o mostrador, con páginas organizadas para actualizaciones de información modulares, reemplazos, erratas y adendas. ^{[ cita requerida ]}

Los manuales y guías de usuario de la mayoría de las aplicaciones de software para PC y navegadores no triviales son documentos de tipo libro con contenidos similares a la lista anterior. Pueden distribuirse en forma impresa o electrónica. Algunos documentos tienen una estructura más fluida con muchos enlaces internos. La Guía del usuario de Google Earth^[4] es un ejemplo de este formato. El término guía se aplica a menudo 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 guías prácticas . Un ejemplo es la Guía de introducción de Picasa . ^[5]

En algunas aplicaciones de software empresarial , donde los grupos de usuarios tienen acceso únicamente a un subconjunto de la funcionalidad completa de la aplicación, se puede preparar una guía del usuario para cada grupo. Un ejemplo de este enfoque es el documento de Ayuda de Autodesk Topobase 2010 ^{[6] , que contiene}Guías del administrador , Guías del usuario y una Guía del desarrollador independientes .

Véase también

Referencias

^ "Los científicos descifran el manual de un ordenador griego de hace 2000 años" . Consultado el 29 de noviembre de 2018 .
^ abc Chafin, Roy (enero de 1982). "Manuales de usuario: ¿Qué necesita realmente el usuario?". Actas de la 1.ª conferencia internacional anual sobre documentación de sistemas - SIGDOC '82 . pp. 36–39. doi : 10.1145/800065.801307 . ISBN . 089791080X.S2CID6435788 .
^ ab McKee, John (agosto de 1986). "Manuales de usuario de ordenador impresos: ¿tienen futuro?". ACM SIGDOC Asterisk Journal of Computer Documentation . 12 (2): 11–16. doi :10.1145/15505.15507. S2CID 35615987.
^ "Guía del usuario de Google Earth". 4 de junio de 2009. Consultado el 13 de agosto de 2009 .
^ "Introducción a Picasa: Guía de introducción". 15 de junio de 2009. Consultado el 13 de agosto de 2009 .
^ "Ayuda de Autodesk Topobase 2010". Autodesk . Consultado el 13 de agosto de 2009 .

[1] "Los científicos descifran el manual de un ordenador griego de hace 2000 años" . Consultado el 29 de noviembre de 2018 .

[:0-2] Chafin, Roy (enero de 1982). "Manuales de usuario: ¿Qué necesita realmente el usuario?". Actas de la 1.ª conferencia internacional anual sobre documentación de sistemas - SIGDOC '82 . pp. 36–39. doi : 10.1145/800065.801307 . ISBN . 089791080X.S2CID6435788 .

[:1-3] McKee, John (agosto de 1986). "Manuales de usuario de ordenador impresos: ¿tienen futuro?". ACM SIGDOC Asterisk Journal of Computer Documentation . 12 (2): 11–16. doi :10.1145/15505.15507. S2CID 35615987.

[4] "Guía del usuario de Google Earth". 4 de junio de 2009. Consultado el 13 de agosto de 2009 .

[5] "Introducción a Picasa: Guía de introducción". 15 de junio de 2009. Consultado el 13 de agosto de 2009 .

[6] "Ayuda de Autodesk Topobase 2010". Autodesk . Consultado el 13 de agosto de 2009 .