Una guía de usuario , también denominada comúnmente documento o manual de comunicación técnica , está destinada a brindar asistencia a las personas que utilizan un sistema en particular. [1] Por lo general, la redacta un redactor técnico , aunque las guías de usuario las redactan programadores, gerentes de productos o proyectos u otro personal técnico, particularmente en empresas más pequeñas. [2]
Las guías de usuario se asocian más comúnmente con productos electrónicos, hardware y software de computadora , aunque se pueden escribir para cualquier producto. [3]
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 a la audiencia destinataria , con la jerga mínima o explicada a fondo.
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 documentos relacionados e información sobre cómo navegar por la guía del usuario.
- Una página de contenido
- Una sección de propósito. Debe ser una descripción general en lugar de detallar el objetivo del documento.
- Una sección de audiencia para indicar explícitamente quién no es tan bueno como quién debe leer, incluidos los 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 los posibles errores o problemas que pueden ocurrir, junto con cómo solucionarlos.
- Un FAQ (Frequently Asked Questions)
- Dónde encontrar más ayuda y detalles de contacto
- Un glosario y, para documentos más grandes, un índice
Historia
Se han encontrado guías de usuario con dispositivos antiguos. Un ejemplo es el mecanismo de Antikythera , [4] una computadora analógica griega de 2.000 años de antigüedad que se encontró frente a la costa de la isla griega de Antikythera en el año 1900. En la portada de este dispositivo hay pasajes de texto que describen las características y el funcionamiento de el mecanismo.
A medida que se desarrollaba la industria del software, la cuestión de cómo documentar mejor los programas de software estaba indecisa. Este fue un problema único para los desarrolladores de software, ya que los usuarios a menudo se frustraban con los documentos de ayuda actuales. [5] Algunas consideraciones para escribir una guía del usuario que se desarrolló en este momento incluyen:
- el uso de lenguaje sencillo [5]
- longitud y dificultad de lectura [5]
- el papel de las guías de usuario impresas para programas digitales [6]
- diseño centrado en el usuario [6]
Manuales y guías de software informático
Los manuales de usuario y las guías de usuario para la mayoría de las aplicaciones de software no triviales son documentos en forma de libro con contenido similar al de la lista anterior. Pueden distribuirse impresas o electrónicamente. Algunos documentos tienen una estructura más fluida con muchos enlaces internos. La Guía del usuario de Google Earth [7] es un ejemplo de este formato. El término guía se aplica a menudo a un documento que trata un aspecto específico de un producto de software. Algunos usos son Guía de instalación , Guía de inicio y varias guías de procedimientos. Un ejemplo es la Guía de introducción a Picasa . [8]
En algunas aplicaciones de software empresarial , donde los grupos de usuarios tienen acceso solo a un subconjunto de la funcionalidad completa de la aplicación, se puede preparar una guía de usuario para cada grupo. Un ejemplo de este enfoque es el documento de Ayuda de Autodesk Topobase 2010 [9] , que contiene Guías del administrador , Guías del usuario y una Guía del desarrollador independientes .
Ver también
Referencias
- ^ "Redacción técnica en línea: guías de usuario" . [email protected] . Consultado el 13 de agosto de 2009 .
- ^ Gary Blake y Robert W. Bly , Los elementos de la escritura técnica , pág. 143. Nueva York : Macmillan Publishers , 1993. ISBN 0020130856
- ^ "Manuals Brain: ¡todos los manuales útiles en un solo lugar!" . manualesbrain.com . Consultado el 15 de agosto de 2017 .
- ^ "Manual de descifrado de Boffins para computadora griega antigua de 2.000 años" . Consultado el 29 de noviembre de 2018 .
- ^ a b c Chafin, Roy (enero de 1982). "Manuales de usuario: ¿Qué necesita realmente el usuario?". SIGDOC '82 Actas de la 1ª conferencia internacional anual sobre documentación de sistemas : 36–39 - a través de la Biblioteca digital ACM.
- ^ a b McKee, John (agosto de 1986). "Manuales de usuario de computadora impresos: ¿tienen futuro?". ACM SIGDOC Asterisk Journal of Computer Documentation . 12 : 11–16: a través de la biblioteca digital ACM.
- ^ "Guía del usuario de Google Earth" . Google. 4 de junio de 2009 . Consultado el 13 de agosto de 2009 .
- ^ "Introducción a Picasa: Guía de introducción" . Google. 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 .