Una entrada del registro de cambios describe una modificación confirmada: versión, fecha efectiva, usuarios afectados, comportamiento anterior y nuevo y acción necesaria. Esta plantilla trata una función ya desplegada, no el primer lanzamiento.
Reunir hechos de una sola modificación
Confirma con el responsable de la función su nombre, identificador de versión, momento real de despliegue y usuarios afectados. Una fecha prevista no es una fecha efectiva. Si el acceso está limitado, identifica el grupo.
El ticket interno ayuda a recuperar decisiones, pero no sustituye una explicación para clientes. La entrada debe entenderse sin notas internas.
Registrar versión y fecha
Usa el identificador adoptado por el producto. No inventes un número para el artículo. Si utiliza SemVer, interpreta sus componentes según sus reglas y la API pública declarada. Otros sistemas pueden expresar algo diferente.
Escribe una fecha inequívoca, por ejemplo YYYY-MM-DD, y zona horaria cuando importe la hora. La fecha de redacción puede ser distinta. Para un despliegue gradual, indica inicio y cobertura actual en lugar de acceso simultáneo para todos.
Explicar antes y después
Describe el comportamiento que el usuario experimentaba antes y el que observa después. Indica a quién afecta, límites y pasos necesarios. Si no requiere ninguna acción, dilo.
No atribuyas beneficios sin verificar. Cambiar filtros no demuestra más ventas ni una cantidad de horas ahorradas. Las condiciones de precio y facturación permanecen en su documentación correspondiente.
Ejemplo de una entrada
Este ejemplo ficticio no describe una versión de Semly.
- Función: filtros de una lista de documentos.
- Versión: 2.4.1 según la numeración del producto de ejemplo.
- Fecha efectiva: 2026-10-12.
- Antes: elegir un segundo filtro eliminaba el primero.
- Después: la lista aplica ambos filtros seleccionados.
- Alcance: usuarios de la lista de documentos en 2.4.1.
- Acción: actualizar la vista abierta después de la actualización.
- Límite: las plantillas de filtros guardadas no cambian.
El límite evita suposiciones sobre las plantillas. En una entrada real añade un enlace verificado a la documentación. Si no existe, explica el paso sin inventar una URL.
Revisar antes de guardar
Contrasta versión, fecha, cobertura y comportamiento con el equipo de producto. Comprueba que la acción sea realizable y el enlace lleve a instrucciones actuales.
Un lector sin conocer el ticket debe identificar qué cambió y cuándo. Divide funciones independientes en entradas distintas de la versión, sin crear varios artículos sobre el mismo cambio.
Mantener el significado al traducir
Conserva versión, momento, cobertura y límites. Otro idioma no confirma disponibilidad en otro mercado. Explica únicamente diferencias territoriales verificadas.
Si corriges el texto, conserva la fecha real del despliegue y señala aparte la corrección editorial. No es un nuevo despliegue.
Fuente sobre numeración
SemVer se refiere a una API pública declarada. No es un sistema obligatorio para todas las aplicaciones SaaS.
