Proceso de documentación para actualización de Manuales en AZURE
El proceso de documentación para los manuales construidos en AZURE, hace referencia a las actualizaciones o nuevos contenidos (texto, imágenes, tablas y funcionalidad) del manual de producto, generados por el autor (responsable) de la aplicación en la plataforma AZURE, para ser atendidos por el redactor técnico de forma puntual para el contenido generado. El proceso es el siguiente:
1. Generar Requerimiento: El Autor de producto genera requerimiento (PR) por actualización en funcionalidad con impacto en documentación.
2. Recibo información: El redactor técnico recibe el requerimiento de producto, se validan los cambios de contenido, se determina el impacto a nivel gráfico y de contenido y se estiman los tiempos de trabajo.
3. Cambios y Validaciones: El Redactor técnico realiza los ajustes respectivos de acuerdo a valoración previa.
4. Cierre El Autor del contenido aprueba y cierra el requerimiento (PR), integrando la rama al repositorio.
Proceso de documentación de Manuales de Versiones en PDF o WORD
El proceso de documentación para de manuales de versiones anteriores, hace referencia a las tareas de conversión, estructuración y subida del manual al entorno web del portal de documentación de Aranda SOFTWARE. Este proceso no incluye actualización de contenido e imágenes. El proceso es el siguiente:
1. Generar Requerimiento: El redactor técnico genera requerimiento (PR) para subir los manuales de PDF a AZURE.
2. Recepción Documento: El redactor técnico valida la información del manual (tabla de contenido, número de páginas, imágenes), y estima los tiempos de trabajo.
3. Conversión a Azure: El redactor técnico en colaboración con Diseñadora UX, realiza diferentes tareas para subir el manual al entorno web de Aranda, como conversión de PDF a Markdown, clonar repositorio en Azure, organización y estructuración de tabla de contenido en nueva plantilla desde Atom o VisualStudio, configuración de estilos, llamado correcto de las imágenes o pantallas, ajuste de tablas.
4. Cambios y Validaciones: El equipod de documentación valida que el cambio de versión fue implementado adecuadamente. Si existen problemas en las actividades de conversión de Azure, se realizan los comentarios y sugerencias respectivas, para que el redactor técnico realice los cambios pertinentes, rechazando el requerimiento. Si la conversión fue exitosa se realiza la aprobación y cierre del requerimiento e integración a la rama principal del repositorio.
5. Se hace el llamado del manual desde el portal de documentación.
Proceso documentación de manuales para cambios en estructura
El proceso de documentación con cambios de estructura, hace referencia a la actualización de manuales en un nuevo formato de documentación donde se debe tener en cuenta los siguientes lineamientos de la Estructura de Contenido para Manuales: División de Contenidos, Visión Conceptual, Orden lógico de Uso y Descripción de Procesos de Gestión.
⚐ Nota: Este proceso no incluye actualización de contenido e imágenes para versiones V8. El contenido aprobado con la nueva estructura será generado a partir de la información existente.
El proceso para el cambio de estructura es el siguiente:
1. Generar Requerimiento: El redactor técnico genera requerimiento (PR) para actualizar el manual a nivel de estructura. En espera de revisión y validación de autor de producto y diseño UX.
2. Aprobación: En reunión entre redactor técnico, autor de producto y diseño UX se aprueba el cambio de la documentación a nivel de estructura y se establece la planeación de las actividades.
3. Recibo Información: En reunión con autor de producto se amplían conceptos para incluir en estructura. El redactor técnico valida los cambios de contenido, se determina el impacto de los cambios; se estiman los tiempos de trabajo.
4. Cambios: El redactor técnico realiza los cambios de estructura en el manual teniendo en cuenta los lineamientos definidos en documentación.
5. Validaciones: El autor del producto y el redactor técnico confirman los cambios de acuerdo a las validaciones para cambios en documentación definidas.
6. Cierre: Se cierra el requerimiento (PR) y se integra la rama al repositorio.