¿Qué es la canalización de OpenDocs?
La canalización de OpenDocs es una conexión entre los diagramas de Visual Paradigm Desktop y OpenDocs
documentos. Permite publicar los diagramas como artefactos de la canalización y rastrearlos a través de los proyectos
revisiones e insertarlos en los documentos cuando sea necesario.
Este flujo de trabajo es útil para especificaciones de software, documentos de diseño de sistemas, requisitos empresariales
, documentación de arquitectura, propuestas de proyecto y otros entregables que
contengan diagramas de Visual Paradigm.
Cómo funciona el flujo de trabajo de revisión de diagramas
Un diagrama no se agrega automáticamente a la canalización de OpenDocs. Debe enviarlo manualmente
el diagrama a la canalización al menos una vez. Después del envío inicial, los futuros compromisos del proyecto
generan automáticamente nuevas revisiones para ese diagrama.
- Abra el diagrama en Visual Paradigm Desktop.
- Abra el panel lateral en el lado derecho del diagrama.
- Haga clic en Enviar a la canalización de OpenDocs.
- Opcionalmente, ingrese un comentario para describir el cambio.
- Haga clic en Aceptar para enviar el diagrama a la canalización.
- Comprometa los cambios posteriores del proyecto para generar nuevas revisiones de diagrama automáticamente.
El comentario opcional puede ayudar a los miembros del equipo a entender por qué se envió un diagrama o qué cambió
entre revisiones. Por ejemplo, podría registrar que un diagrama de casos de uso se actualizó para
reflejar un nuevo flujo de autenticación.
Revisiones de diagramas basadas en escritorio y en línea
La disponibilidad de las revisiones depende de dónde se gestione el diagrama.
Diagramas creados en Visual Paradigm Desktop
Después de que un diagrama basado en escritorio se haya enviado a la canalización una vez, cada compromiso del proyecto
crea una nueva revisión. Esto permite seleccionar una versión anterior o más reciente
cuando se mantiene un documento.
Diagramas basados en línea
Para los diagramas basados en línea, OpenDocs muestra la última revisión junto con cualquier revisión
que se enviaron manualmente. Esto proporciona acceso a la versión actual mientras también preserva
revisiones seleccionadas con fines de documentación.
Cómo abrir OpenDocs
- En Visual Paradigm, abra el Herramientas menú.
- Seleccione Aplicaciones.
- Iniciar OpenDocs.
Una vez que OpenDocs esté abierto, puede crear o editar un documento e insertar diagramas desde el
pipeline.
Cómo insertar un diagrama en un documento de OpenDocs
- Abra el documento en OpenDocs.
- Coloque el cursor donde desea que aparezca el diagrama.
- Haga clic en Insertar.
- Seleccione Pipeline.
- Haga clic en el artefacto necesario para insertar su versión actual o la última revisión.
Si necesita insertar una versión específica en lugar de la última revisión, haga clic en el
icono de revisión asociado con el artefacto. Luego puede revisar las revisiones disponibles y
seleccionar la versión requerida para su documento.
Cómo seleccionar una revisión específica de un diagrama
OpenDocs le permite elegir la revisión que mejor se ajuste al contenido y propósito de su
documento. Esto es especialmente útil cuando un documento describe un hito específico del proyecto,
lanzamiento o línea base de diseño.
- Abra el panel de flujo de trabajo del documento.
- Localice el artefacto del diagrama.
- Haga clic en el icono de revisión.
- Revise las revisiones disponibles.
- Seleccione la revisión que desea insertar o utilizar en el documento.
Seleccionar una revisión específica ayuda a evitar que un documento muestre de forma no intencionada un
diagrama que refleje cambios realizados después de que el documento fuera aprobado.
Cómo actualizar un diagrama ya utilizado en un documento
El panel de flujo de trabajo de OpenDocs muestra los artefactos disponibles para el proyecto y los artefactos
actualmente asociados con el documento. Cuando se actualiza un diagrama utilizado en el documento, aparece un
indicador en el panel.
- Abra el panel de flujo de trabajo del documento.
- Busque el artefacto con el indicador de actualización.
- Haga clic en el indicador para ver las revisiones disponibles.
- Compare las revisiones disponibles con la revisión que se está utilizando actualmente.
- Seleccione la revisión preferida para actualizar el documento.
Puede elegir la revisión más reciente u otra revisión disponible, dependiendo de si el
documento debe reflejar los cambios más recientes del proyecto o mantenerse alineado con una
línea base específica.
Beneficios de utilizar el flujo de trabajo de OpenDocs
- Documentación coherente:Mantenga los diagramas y el contenido escrito alineados con
los cambios del proyecto. - Control de revisiones:Elija la versión del diagrama que corresponde a un
documento o hito del proyecto específico. - Actualizaciones eficientes: Identifica los artefactos modificados mediante indicadores visuales
en el panel de la tubería. - Mejor colaboración: Facilita el trabajo para los equipos de proyecto, analistas,
desarrolladores y partes interesadas para trabajar con las mismas versiones de diagramas. - Trabajo manual reducido: Evita exportar y reemplazar diagramas repetidamente
cuando las revisiones del proyecto están disponibles a través de la tubería.
Flujo de trabajo recomendado para equipos
- Finaliza la versión inicial de un diagrama antes de enviarlo a la tubería de OpenDocs.
- Añade un comentario significativo al enviar el diagrama, especialmente al documentar un cambio importante
de diseño. - Confirma los cambios del proyecto regularmente para que se registren las nuevas revisiones de los diagramas.
- Inserta la revisión de diagrama adecuada en el documento de OpenDocs.
- Revisa el panel de la tubería antes de publicar o aprobar el documento.
- Revisa los indicadores de actualización y decide si el documento debe usar la última revisión
o una revisión anterior específica.
Disponibilidad y requisitos
La función de tubería de OpenDocs está disponible en la Edición Professional o superior.
Funciona cuando tanto el repositorio como el proyecto están alojados en Visual Paradigm Online.
Antes de usar el flujo de trabajo, confirma que tu edición de Visual Paradigm admite la función y
que el repositorio y el proyecto relevantes cumplan con los requisitos de alojamiento.
Preguntas frecuentes
¿Se añaden automáticamente todos los diagramas de Visual Paradigm Desktop a la tubería?
No. Un diagrama debe enviarse manualmente a la tubería de OpenDocs al menos una vez. Después de eso
acción inicial, las confirmaciones del proyecto pueden generar nuevas revisiones para el diagrama.
¿Qué sucede después de enviar un diagrama a la tubería?
El diagrama queda disponible como un artefacto de la tubería. Los futuros compromisos del proyecto generan nuevas
revisiones, lo que le permite insertar o actualizar el diagrama en OpenDocs.
¿Puedo insertar una revisión anterior de un diagrama en un documento?
Sí. Abra el panel de la tubería, haga clic en el icono de revisión del artefacto y seleccione la revisión
necesaria para el documento.
¿Cómo sé cuándo ha cambiado un diagrama en mi documento?
Un indicador de actualización aparece en el panel de la tubería de OpenDocs cuando un artefacto utilizado en el
documento tiene una revisión disponible más reciente.
¿Puedo elegir si usar la revisión más reciente?
Sí. Puede insertar la revisión actual o la más reciente, o seleccionar una revisión específica de la
lista de revisiones disponibles.
¿Qué edición de Visual Paradigm admite esta función?
La función está disponible en la Edición Professional o superior.
¿Dónde deben alojarse el repositorio y el proyecto?
Tanto el repositorio como el proyecto deben alojarse en Visual Paradigm Online.
Conclusión
La tubería de OpenDocs proporciona una forma práctica de conectar los diagramas de Visual Paradigm con
la documentación estructurada del proyecto. Al publicar manualmente un diagrama una vez, rastrear las revisiones posteriores
y seleccionar la versión adecuada durante la edición del documento, los equipos pueden mantener
los documentos técnicos y comerciales precisos sin perder el control sobre las líneas base de los documentos.
Este flujo de trabajo es particularmente valioso para los equipos que actualizan regularmente los modelos del sistema,
los diagramas de arquitectura de software, los modelos de procesos y la documentación de requisitos.
