EST-BDT-003 Estándar de versionamiento
v 6.0
Propósito
El propósito de este documento es establecer un estándar simplificado para el versionamiento de archivos dentro del proyecto, facilitando así la gestión y el seguimiento de cambios a lo largo del tiempo.
Notas introductorias
Este estándar busca reemplazar los métodos de versionamiento complejos o detallados por un sistema más directo y fácil de seguir, permitiendo a los miembros del equipo identificar rápidamente la secuencia de cambios y la versión actual de un archivo o documento.
Productos de trabajos en los que se aplica el estándar
Todo lo que se encuentre en la matriz de configuración
Estándares
Cada nueva versión debe tener:
- Versión: Número de versión
- Cambio realizado: Nombre de los cambios realizados
- Análisis: Explicación detallada de los cambios realizados
- Autor: Autor(es) de los cambios realizados
- Revisor(es): Revisor(es) de los cambios realizados
- Fecha de cambio: Fecha de los cambios realizados
¿Cómo se versiona?
La versión inicial de cada producto de trabajo es v 1.0 y, en la tabla de control de cambios, la descripción debe ser Creación del producto de trabajo y puede no incluir análisis.
El versionamiento de un producto de trabajo se actualiza conforme a los siguientes criterios:
-
Versiones principales: Se utilizará un sistema de numeración secuencial simple para identificar cada nueva versión mayor de un archivo. Estas versiones representan cambios significativos, revisiones completas, el lanzamiento de nuevas funcionalidades importantes o modificación al contenido del documento.
Ejemplo:v 1.0,v 2.0,v 3.0, etc. -
Errores ortográficos, links y versionamiento Se utilizará un sistema de numeración secuencial decimal para identificar correcciones a errores ortográficos o de redacción, cambio de links o corrección de versionamiento que se encuentren en algún documento.
Ejemplo:v 1.1,v 2.1,v 3.1, etc.
Notas de versión: Junto con cada versión, se debe proporcionar una breve descripción y análisis de los cambios realizados. Esto ayudará a los miembros del equipo a entender el alcance de las modificaciones y la razón detrás de la nueva versión.
Documentación y Registro
Para realizar una nueva versión de un producto de trabajo, esta se debe actualizar tanto en la tabla de control de cambios al final de cada producto de trabajo como en la parte superior izquierda debajo del título.
La tabla de control de cambios se debe de llenar de la siguiente manera:
| Versión | Cambio realizado | Análisis | Autor | Revisor(es) | Fecha de cambio |
|---|---|---|---|---|---|
| Versión del último cambio del producto de trabajo | Resumen general de lo realizado en el último cambio del producto de trabajo (Si se creó o qué se modificó) | Resumen un poco más detallado sobre lo realizado en el último cambio del producto de trabajo (Si se creó o qué se modificó) | Nombre de los autores del último cambio del producto de trabajo | Nombre de las personas que revisaron el último cambio del producto de trabajo | Fecha en la que se realizó el último cambio |
Ejemplo:
| Versión | Cambio realizado | Análisis | Autor | Revisor(es) | Fecha de cambio |
|---|---|---|---|---|---|
| 1.0 | Creación del estándar | Se creó el estándar de versionamiento del departamento Black Dot para que todos los productos de trabajo en la Wiki tenga un historial de versiones | Carlos Velasco | Sergio Garnica | 19/05/2024 |
Revisión
Cada vez que se cree una nueva versión, en caso que la versión anterior no tenga un revisor, el autor de la nueva versión debe asignarse como revisor.
¿Cómo regresar a una versión anterior?
Para regresar a la versión anterior de un producto de trabajo, seguir la guía GUI-BDT-018
Control de cambios
| Versión | Cambio realizado | Análisis | Autor | Revisor(es) | Fecha de cambio |
|---|---|---|---|---|---|
| v 1.0 | Creación del documento | N/A | Daniel Hurtado | Frida Bailleres | 01/03/2024 |
| v 1.1 | Correción ortográfica | N/A | Olimpia García | Diego Llaca | 04/03/2024 |
| v 2.0 | Agregar sección de errores ortográficos | N/A | Sergio Garnica González | 05/03/2024 | |
| v 2.1 | Corrección ortográfica | La palabra versionamiento tenía un error ortográfico | Yuna Chung | Olimpia García | 28/04/2024 |
| v 3.0 | Aclaración del estándar | Se especificó lo que tiene que tener la tabla de control de cambios, cómo se gestiona el versionamiento, cómo documentar las versiones y la versión inicial de cada producto de trabajo | Carlos Velasco Sergio Garnica Diego Perdomo | Carlos Velasco | 10/05/2024 |
| v 4.0 | Agregar guía de rollback | Se referenció la guía de rollback al estándar para regresar a una versión anterior de un producto de trabajo | Carlos Velasco Sergio Garnica | Diego Perdomo | 13/05/2024 |
| v 4.1 | Corrección ortográfica del título | El título decía "Estandar" en lugar de "Estándar" | Carlos Velasco Sergio Garnica | Diego Perdomo | 13/05/2024 |
| v 5.0 | Cambio a Errores ortográficos, links y versionamiento | Redefinir los cambios menores agregando cambio a links y de versionamiento | Sergio Garnica | Diego Llaca | 16/05/2024 |
| v 6.0 | ¿Cómo se llena la tabla de control de cambios? | Se agregó una sección donde se explica cómo llenar la tabla de control de cambios en los productos de trabajo | Carlos Velasco | 19/05/2024 |