¿Qué es la creación de ayuda?
La creación de ayuda se refiere al proceso de diseñar, publicar y mantener la documentación de ayuda de software. El texto resultante se utiliza en guías de explicación, preguntas frecuentes, manuales y archivos de ayuda.
A pesar de ser realizada por escritores técnicos especializados, la creación de ayuda a menudo se considera un proceso de desarrollo. Los equipos de desarrollo emplean la creación de ayuda para crear y mantener la documentación de ayuda para sus productos de software existentes y cualquier nueva característica que pueda añadirse. Las principales herramientas de software utilizadas para este proceso son herramientas de creación de ayuda (HAT) y software de base de conocimiento. Las HATs ayudan a los escritores técnicos al reducir el tiempo y esfuerzo necesarios al crear materiales de asistencia tanto para empleados como para usuarios finales. El software de base de conocimiento permite a los escritores técnicos mantener y actualizar una base de conocimiento central que contiene todo el texto de ayuda de software que crearon sobre su producto. Esta base de conocimiento, que a menudo es una página web o documento accesible para el usuario, puede actualizarse tan pronto como los escritores técnicos añadan nuevo texto o imágenes.
Tipos de creación de ayuda
Dependiendo de para qué se esté utilizando la creación de ayuda o la industria en la que se encuentre una empresa, se utilizará uno o más tipos de creación de ayuda.
- Redacción de preguntas frecuentes (FAQ): Las secciones de preguntas frecuentes son recursos importantes para los clientes que les ayudan a resolver problemas comunes de software. Esto ayuda a las empresas a mitigar la cantidad de tráfico que llega a través de sus canales de servicio al cliente.
- Redacción de tutoriales: Los tutoriales y guías de explicación se escriben para suavizar la curva de aprendizaje para los nuevos usuarios de software. Este tipo de redacción es quizás el ejemplo más esencial del cruce entre el desarrollo de software y la redacción técnica que representa la creación de ayuda. Los tutoriales deben ser claros y concisos, y también deben presentarse claramente mientras un usuario navega por la aplicación de una empresa por primera vez.
- Documentos para empleados: Más allá de los materiales de ayuda orientados al cliente, las empresas también emplean la creación de ayuda para crear documentación interna. Los empleados pueden usar esta documentación como recurso de capacitación, punto de referencia o ambos.
Beneficios de usar la creación de ayuda
- Filtrado de tráfico: La creación de ayuda permite a las empresas proporcionar a sus clientes documentación de ayuda clara y fácilmente accesible. Esto aumenta las probabilidades de que un usuario que experimenta un problema pueda solucionarlo por sí mismo sin tener que entrar en la cola de servicio al cliente.
- Gestión del conocimiento: La creación de ayuda para uso interno asegura que los empleados tengan acceso a la mayor cantidad de información relevante posible. Esto permite a los empleados hacer su mejor trabajo y evita que la información se aísle.
- Incorporación de clientes: La creación de ayuda ayuda a las empresas a guiar a sus nuevos usuarios a través de las características y el uso de su software. Esto promueve una experiencia de incorporación positiva para los nuevos clientes.
- Retención de clientes: Al emplear la creación de ayuda para proporcionar a los clientes recursos de solución de problemas, las empresas retienen a más clientes que de otro modo habrían dejado el servicio por frustración.
Mejores prácticas para la creación de ayuda
La creación de ayuda debe realizarse con minuciosidad, claridad y tono en mente. Para que la documentación de ayuda de cualquier tipo sea efectiva, los lectores deben poder encontrar ayuda para preguntas y problemas comunes y comprender el contenido fácilmente. El tono debe ser directo e informativo o coincidir con la identidad de marca deseada por la empresa.
Para que la creación de ayuda funcione, los usuarios pueden seguir estas mejores prácticas:
- Abordar preguntas y problemas comunes: Al escribir documentación de ayuda, los escritores deben abordar tantas preguntas y problemas comunes como sea posible. Esto hace que sea más probable que los usuarios encuentren lo que necesitan a través de la documentación y evita la frustración.
- Escribir claramente: Al emplear la creación de ayuda, el producto final debe ser lo más claro posible y estar organizado de tal manera que los usuarios puedan navegar fácilmente hacia el tema deseado.
- Usar herramientas de software: Las HATs y el software de base de conocimiento pueden ayudar a las empresas a organizar y gestionar su documentación de ayuda. Otros beneficios incluyen escalabilidad y reducción del tiempo dedicado a la redacción.
Creación de ayuda vs. gestión del conocimiento
La creación de ayuda está estrechamente relacionada con la gestión del conocimiento. De hecho, muchas HATs poseen capacidades de gestión de bases de conocimiento. Para distinguir entre los dos conceptos, es mejor pensar en la creación de ayuda como la creación real de preguntas frecuentes, manuales, archivos de ayuda y otra documentación para almacenar información útil. En contraste, la gestión del conocimiento es un enfoque integrado para identificar, capturar, recuperar y compartir estos activos de información.
Adam Crivello
Adam is a research analyst focused on dev software. He started at G2 in July 2019 and leverages his background in comedy writing and coding to provide engaging, informative research content while building his software expertise. In his free time he enjoys cooking, playing video games, writing and performing comedy, and avoiding sports talk.
