Guía de Manuales - novaDepto/Nova GitHub Wiki

Responsables

Nombre Rol
Irving Dueño de la guía
Alonso Autor

Objetivos

Un manual de usuario o guía de usuario es un documento de comunicación técnica destinado a dar asistencia a las personas que utilizan un sistema en particular. Es decir, es un documento organizado y estructurado con una serie de instrucciones sobre cómo utilizar un determinado sistema, producto o servicio. Los manuales deben ser útiles y entendibles para cualquier usuario.

Recomendaciones generales para la elaboración de un manual

  1. Ser consciente acerca de quién es la audiencia o lector, ya que de esta manera podremos adaptar el manual a sus necesidades.
  2. Crear la estructura que tendrá el manual de usuario.
    • Portada
      • Nombre del manual.
      • Autor del manual.
      • Un aviso de protección de derecho de autor.
    • Introducción
      • Descripción breve acerca de para qué sirve y de qué habla el manual.
    • Índice de contenido
      • Para acceder rápidamente a los contenidos del manual si es muy extenso.
    • Sección de configuración inicial
      • Esta sección se incluye en caso de que el usuario necesite realizar algún tipo de configuración.
    • Sección de control de acceso
      • Esta sección se incluye en caso de que sea necesario usar una forma de autenticación y describir los niveles de acceso del usuario al que está dirigido el manual.
    • Sección de guía o explicación del funcionamiento del producto, sistema o servicio
      • Se detalla por pasos lógicos y dividiendo por secciones las diferentes funcionalidades del producto, sistema o servicio.
      • Se puede realizar en formato libre, siempre y cuando se sigan las recomendaciones generales acerca de la estructura de un manual.
      • Véase el apartado "Explicación del funcionamiento del producto, sistema o servicio".
    • Sección de preguntas frecuentes
      • Se incluyen aquellas preguntas frecuentes que se pueden realizar los usuarios hacia los cuales va dirigido el manual con sus respectivas respuestas.
    • Glosario de términos
      • Se aclaran todos aquellos términos que puedan ser objeto de duda para el lector.

Explicación del funcionamiento del producto, sistema o servicio

La elaboración del manual con base a las recomendaciones propuestas en esta guía queda a criterio del autor siempre y cuando logre satisfacer las necesidades del usuario final acerca de un producto, sistema o servicio.

Recomendaciones generales

  • Redactar las instrucciones utilizando el mismo tiempo verbal en todo momento.
  • Explicar todos aquellos conceptos complejos que pueden causar dudas al lector.
  • Los pasos de cada instrucción deben seguir un orden secuencial y lógico.
  • Usar expresiones sencillas y vocabularios poco técnicos.
  • Especificar y aclarar cuáles son las funciones más importantes para el usuario final.
  • Definir una estructura y forma de explicar las instrucciones (comenzar con el resumen de las tareas, luego describir qué debe hacer el usuario y qué resultado debe observar).

Elaboración de un manual en formato de video

  • Generar un guión que explique claramente la funcionalidad que se desee enseñar al usuario. Se debe ser claro, usar vocabulario simple y ser secuencial.
  • Grabar por separado audio y vídeo utilizando la herramienta de su preferencia. Se recomienda realizar voice over apoyándose del guión que fue previamente redactado.
  • Grabar la voz cuidando la cadencia, manteniendo claridad, enfatizando las oraciones, haciendo pausas cuando sea necesario y no extendiéndose más de un párrafo.
  • Empatar por medio de un editor el audio y el vídeo.
  • Añadir transiciones que no desvíen la atención del usuario.
  • Subir los vídeos a la cuenta de YouTube departamental e insertar los enlaces en la sección de guía o explicación del funcionamiento del producto del manual general.

Elaboración de un manual en formato escrito

  • Añadir tantas secciones como sean necesarias para describir todas las funcionalidades del sistema, producto o servicio.
  • Enumerar las características o agruparlas teniendo en cuenta las funciones comunes o las que más se usan.
  • Incluir imágenes gráficas o capturas de pantalla para explicar los procedimientos más complejos, así el usuario tendrá una confirmación visual de que está realizando los pasos correctamente.
  • Usar imágenes que sean de tamaño y proporciones consistentes a lo largo del documento.
  • Resaltar el texto de las referencias de las imágenes para diferenciarlo del resto.
  • Usar la menor cantidad de familias de texto y verificar que sean legibles incluso a individuos con discapacidad visual.

Referencias

Grupo Carricay. (2018). ¿Cómo escribir un buen manual de usuario?. Noviembre 29, 2020, de Medium Sitio web: https://medium.com/grupo-carricay/c%C3%B3mo-escribir-un-buen-manual-de-usuario-fd8d0c6bae49

Nekodificador. (2017). Cómo hacer un vídeo tutorial. Noviembre 29, 2020, de YouTube Sitio web: https://www.youtube.com/watch?v=YtmzH_GP5vQ.


versión 2.0