El manual para tontos para escribir manuales y documentos de ayuda

Escribir manuales y documentos de ayuda [Featured]

Si nunca antes has escrito documentación de ayuda, intentarlo puede dar un poco de miedo. Los usuarios finales de tu producto confían en ti para que les ayudes a entender cada función del producto, y que continúen utilizando el producto depende del éxito que tengas en ofrecer respuestas a sus preguntas. Aquí te ofrecemos nuestro “manual para tontos” para escribir manuales y documentos de ayuda. Estos trucos te ayudarán a escribir documentos de ayuda que cubran todos los detalles que deben incluir de un modo fácil de entender para tus usuarios finales.

Comprende a los usuarios de tu producto

Este es el punto más fundamental de la redacción de documentación de ayuda. Si quieres que lo que escribas resulte útil para aquellos que están intentando entender el producto, debe cubrir los puntos que más les preocupen. No tiene sentido escribir un manual de ayuda magníficamente presentado si no ayuda a nadie que está utilizando el producto o si responde a preguntas que nadie está haciendo sobre el producto.
Empieza hablado con los usuarios del producto. Descubre por qué lo usan, ¿para qué lo utilizan? ¿Qué funciones son las más utilizadas? Habla con el centro de soporte o con atención al cliente para determinar las preguntas que los usuarios hacen con mayor frecuencia.
Una vez entiendas perfectamente cómo usan los clientes tu producto, tendrás una idea mucho más clara de qué funciones del producto deberás explicar con mayor detalle y qué temas puedes tratar de manera más superficial.

Planifica cuidadosamente tu tabla de contenidos

Es importante que incluyas todas las funciones de tu producto, pero es todavía más importante asegurarte de que la guía esté estructurada de una manera lógica. Los usuarios necesitan poder encontrar lo que estén buscando. Una guía de ayuda no es algo que la mayoría de las personas quieran leer de cabo a rabo. La mayor parte de la gente solo abre la guía de ayuda cuando tiene una pregunta específica y quiere ir directa al punto de la documentación de ayuda que trata ese tema.
Intenta pensar en todas las formas en que se utilizará tu producto y haz una lista de los pasos en el orden en que deberá ser completados para lograr la tarea requerida, esto facilitará a los lectores encontrar la información que necesitan.

Escribe para el público correcto

Escribe el manual o la documentación de ayuda al nivel adecuado para los usuarios de tu producto. Piensa en quién va a usar tu producto y la cantidad de experiencia técnica que es probable que posean. Una buena documentación de ayuda evita asumir conocimientos que los usuarios no tienen, pero también evita resultar condescendiente con los usuarios y explicar todo en tanto detalle que sienten que están siendo tratado como preescolares.

Simplifica la creación de tus documentos de ayuda

Utiliza software de creación de documentación de ayuda para guiarte mientras creas tu manual. El modo más fácil de escribir una buena documentación de ayuda es utilizar software especialmente diseñado para escribir esa clase de material. Un paquete de creación de documentación de ayuda puede facilitar mucho la estructuración de tu documentación. Con un editor de temas, la capacidad para crear plantillas y una biblioteca audiovisual versátil incluidos, diseñar documentación de ayuda es sencillo y el manual finalizado se puede exportar a continuación en una variedad de formatos sin necesidad de dar formato al manual cada vez.