Guía del usuario - User guide

No confundir con el manual del propietario .

Una guía de usuario , también conocida comúnmente como manual de usuario , está destinada a ayudar a los usuarios a utilizar un producto, servicio o aplicación en particular. Por lo general, lo escribe un técnico, un desarrollador de productos o el personal de servicio al cliente de una empresa.

Las guías del usuario a menudo se incluyen con la compra de electrodomésticos. Pero ahora es común tanto en servicios, software, aplicaciones ... Se publica en copia impresa, o en copia electrónica (documento o aplicación).

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 es la audiencia prevista que 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

La guía del usuario grabada en un modelo del mecanismo de Antikythera.

Se han encontrado guías de usuario con dispositivos antiguos. Un ejemplo es el Mecanismo de Antikythera , 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 del 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. Algunas consideraciones para escribir una guía del usuario que se desarrolló en este momento incluyen:

  • el uso de lenguaje sencillo
  • longitud y dificultad de lectura
  • el papel de las guías de usuario impresas para programas digitales
  • diseño centrado en el usuario

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 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 .

En algunas aplicaciones de software empresarial , donde grupos de usuarios tienen acceso a solo 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 , que contiene guías del administrador , guías del usuario y una guía para desarrolladores independientes .

Ver también

Referencias