¿Con qué frecuencia te pasas una eternidad buscando un archivo de ayuda para algo que saber que debería estar ahí, pero eres incapaz de encontrar? La documentación de ayuda suele ser el primer lugar en que miramos cuando no sabemos cómo funciona algo. Si la información que hay en el archivo de ayuda no es fácil de entender, o peor, puede conducir a error, terminaremos frustrados y hasta rechazando el producto por algo que en realidad es más fácil de entender.

Lee Mas →

Crear documentación de ayuda para productos tiene muchas similitudes con un proyecto académico típico. Un proyecto académico a menudo deberá:

• Hablar de un tema en profundidad, tratando cada aspecto del tema en profundidad
• Dividir un tema en secciones claramente identificables
• Incluir referencias detalladas que apoyen la conclusión del proyecto
• Proporcionar un índice completo que cubra el tema bajo discusión

Todas estas tareas se pueden gestionar mucho mejor en un software de creación de documentación de ayuda que en un paquete convencional de procesamiento de textos. Para redactar un proyecto académico en Microsoft Word, no queda otro remedio que empezar por el principio del tema y escribirlo todo seguido. Este enfoque convierte la redacción del proyecto en algo complicado y que requiere mucho tiempo.

Lee Mas →

Redactar documentación de ayuda es un trabajo duro, los autores técnicos tienen que explicar con claridad cada función del producto. La documentación debe escribirse para una amplia variedad de usuarios de producto, ya que no todos tendrán el mismo nivel de experiencia técnica ni idénticas expectativas.
A pesar de estas consideraciones, en muchos casos los autores técnicos descubren que redactar la documentación es la parte más sencilla del proceso. Una vez escrito todo lo que tienen que decir para cubrir el tema de manera adecuada, deben darle formato para que sea accesible y fácil de leer en una variedad de formatos. Entre los formatos que pueden ser necesarios se incluyen PDF, Word, HTML online, quizá HLP o CHM. El proceso completo necesario para dar formato puede requerir gran cantidad de tiempo, cuando lo que la mayoría de los autores técnicos quieren de verdad es concentrarse en escribir documentación de ayuda de gran calidad, y no tener que pasarse una eternidad preocupándose por cómo se muestran sus páginas en diferentes dispositivos.
Cuando la documentación está terminada por fin, a menudo no es el final del proceso, porque cada vez que se revisa el producto, es necesario modificar la documentación para que incluya las funciones nuevas o actualizadas.

Lee Mas →