En le gestión y actualización de la documentación de manuales de Aranda se deben tener en cuenta elementos básicos para escribir, organizar y presentar los contenidos de manera adecuada y de fácil comprensión del usuario o lector final.

El objetivo final de los manuales es describir la funcionalidad, sus procesos y características con la mayor claridad y fluidez posible, convirtiendo este documento en una herramienta de soporte y consulta.

En el proceso de costrucción de los contenidos se deben tener en cuenta las siguientes fases:

1. Proceso de Documentación

En el ejercicio permanente de documentar los manuales de producto, debe tener en cuenta las consideraciones para escribir, corregir y actualizar los contenidos generados.

2. Estructura del Contenido

La estructura de la documentación de producto se consolida con una descripción lógica del uso de la funcionalidad, la formulación correcta de preguntas para desarrollar conceptos, el conocimiento de la interfaz y una visión general de la conceptualización de la funcionalidad.

3. Normas de Estilo Redacción y Ortografía

Todo proceso de escritura a nivel informal o técnico requiere mantener los niveles óptimos de redacción y ortografía que permitan compartir contenidos claros y bien expuestos.

4. Revisión de Terceros/ Autoevaluación

El proceso de generación de contenidos implica una constante tarea interdisciplinaria de construcción, validación y revisión de la información. En este proceso participan en primera instancia los autores del contenido(ingenieros de desarrollo y pruebas), el redactor técnico; El área de soporte o proyectos a nivel interno pueden hacer sus aportes o sugerencias y finalmente el cliente también ayuda a generar una retroalimentación permanente.

5. Actualización

El manual es el reflejo final de lo que hace la funcionalidad y de acuerdo a esto, debe mantener en constante construcción y actualización frente a los cambios o mejoras que se implementan en cada verión de producto,