Formatos de documentación


Formatos de documentación generados mediante un programa o herramienta de creación de documentación de ayuda.

¿Debería utilizar Microsoft Word para crear la documentación de mi producto?

¿Debería utilizar Microsoft Word para crear la documentación de mi producto?

Microsoft Word es un programa de software increíble. Permite a los usuarios redactar rápida y fácilmente cualquier cosa, desde un trabajo escolar hasta una carta profesional. La mayor ventaja de Microsoft Word es su familiaridad para los usuarios, es un programa con la que la mayoría de nosotros hemos crecido, utilizándolo tanto en el colegio como en la oficina. Para muchas personas sigue siendo la opción natural a la hora de redactar cualquier cosa en un entorno profesional. Y en la mayoría de los casos Microsoft Word es perfecto, pero hay algunas aplicaciones, incluyendo la redacción de documentación de productos, para los que no funciona tan bien.
Hay muchas razones por las que Microsoft Word no es la herramienta adecuada para ayudarte a escribir la documentación de tu producto, estas son solo cinco de ellas.

Lee Mas →

¿Por qué deberías crear versiones ePub y Kindle de tus archivos de ayuda?

dispositivo Kindle

Todos entendemos la importancia de una documentación de ayuda precisa y actualizada. El único modo de sacar el máximo partido a cualquier producto es leer el manual y aprender a utilizar correctamente todas sus funciones. Una dificultad a la que se enfrentan los desarrolladores de muchos productos es elegir los formatos en que deberían producir su documentación de ayuda. En el pasado, un manual impreso se consideraba suficiente para la mayoría de los productos. En los últimos años, el manual impreso a menudo se ha visto sustituido bien por un PDF o bien por una versión online, pero, ¿son estas realmente las mejores opciones disponibles?

Lee Mas →

¿Qué es una herramienta de creación de documentación de ayuda?

images/what-is-a-help-authoring-tool.jpg

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 →