La administración de los contenidos en un proyecto de documentación en un repositorio en Azure DevOps permite realizar las modificaciones (creación o edición de artículos; creación o edición de carpetas; subir o borrar imágenes) actualización y mantenimiento de los manuales de usuario e información relacionada a cada uno de los productos de Aranda.
Definir los contenidos en un proyecto de documentación debe tener en cuenta las siguientes etapas:
1. Crear Rama
Las ramas en Azure DevOps son un recurso que permite la gestión organizada y sincronizada de un proyecto en Azure DevOps.
La rama principal (Main) aloja el contenido actualizado de todo el proyecto. Las actualizaciones al contenido son bifurcaciones de la rama principal y se comportan como versiones paralelas hasta la unificación del contenido.
Para cada cambio que se realice en el proyecto (creación o edición de artículos, carpetas, archivos e imágenes, modificación del sidebar) se debe crear una rama.
La gestión de las ramas en un entorno colaborativo (varios usuarios aportan) permite actualizar el contenido con una retroalimentación permanente (revisión, corrección) y calificada.
2. Subir contenidos
La información más relevante del funcionamiento del producto debe estar representada en el tipo de contenido que se entrega al usuario final. Descripciones del proceso, definiciones, imágenes de contexto, tablas de apoyo, videos, son algunos de los recursos que integran un proyecto de documentación.
3. Generar PullRequest
La solicitud de cambios (Pull Request) permite mantener un proyecto estable y actualizado, con los aportes permanentes de los usuarios involucrados.
Los usuarios registrados pueden crear solicitudes de incorporación de cambios (Pull Request) a partir de ramas generadas. Los equipos de trabajo que realizan sus aportes al proyecto, podrán revisar los Pull Request y agregar comentarios sobre los cambios, revisar el historial de cambios y aprobar o rechazar los cambios propuestos.
4. Impresión PDF
El Usuario siempre tendrá disponible la acción para imprimir en formato PDF el manual respectivo del proyecto de documentación (Manual de Usuario, manual de administración, guía de instalación, release notes, entre otros).