4 min lectura • Guide 433 of 877
Generación de Release Notes
Las release notes informan a usuarios qué cambió. Buenas release notes destacan valor y cambios importantes. Malas release notes son listas llenas de jerga que nadie lee. Esta guía cubre cómo crear release notes que importan.
Tipos de Release Notes
| Tipo | Audiencia | Enfoque |
|---|---|---|
| User-facing | Clientes | Valor, features |
| Técnico | Developers | APIs, breaking changes |
| Interno | Equipo | Todos los cambios |
| Seguridad | Todos | Vulnerabilidades arregladas |
Escribiendo Buenas Notes
ESTRUCTURA DE RELEASE NOTES
═══════════════════════════
SECCIONES ESTÁNDAR:
─────────────────────────────────────
## Versión X.Y.Z (Fecha)
### 🚀 Nuevas Features
[Nuevas capacidades mayores]
### ✨ Mejoras
[Mejoras a features existentes]
### 🐛 Bug Fixes
[Issues user-facing resueltos]
### ⚠️ Breaking Changes
[Qué se romperá, pasos de migración]
### 🗑️ Deprecaciones
[Qué desaparecerá, timeline]
EJEMPLO DE ENTRADA:
─────────────────────────────────────
### 🚀 Nuevas Features
**Exportar a CSV**
Ahora puedes exportar datos de tu proyecto a formato CSV.
Click Exportar → Elegir CSV → Listo.
Ideal para reportes y análisis.
**Inbox de Equipo**
Inbox compartido para notificaciones de equipo.
Nunca te pierdas un update importante.
Encuéntralo en Configuración → Equipo → Inbox.
### 🐛 Bug Fixes
- Arreglado: Dashboard cargaba lento para proyectos grandes
- Arreglado: Notificaciones de email no enviaban los fines
- Arreglado: Date picker mostraba timezone incorrecto
Bueno vs Malo
COMPARACIÓN
═══════════
MALO: Demasiado vago
┌─────────────────────────────────────────────────────────────┐
│ │
│ "Varios bug fixes y mejoras de performance" │
│ │
│ → Usuario: "¿Qué bugs? ¿Cuánto más rápido?" │
│ │
└─────────────────────────────────────────────────────────────┘
BUENO: Específico y útil
┌─────────────────────────────────────────────────────────────┐
│ │
│ "Dashboard carga 40% más rápido para proyectos con │
│ más de 1000 tareas. Arreglado: duplicación de tareas │
│ al arrastrar rápidamente entre columnas." │
│ │
└─────────────────────────────────────────────────────────────┘
MALO: Demasiado técnico
┌─────────────────────────────────────────────────────────────┐
│ │
│ "Migrado de SQL a NoSQL para el servicio de auth" │
│ │
│ → Usuario: "¿Y a mí qué?" │
│ │
└─────────────────────────────────────────────────────────────┘
BUENO: Enfocado en beneficio
┌─────────────────────────────────────────────────────────────┐
│ │
│ "Login ahora es 3x más rápido y más confiable │
│ durante picos de tráfico." │
│ │
└─────────────────────────────────────────────────────────────┘
Automatización
GENERANDO RELEASE NOTES
═══════════════════════
FUENTES DE DATOS:
┌─────────────────────────────────────────────────────────────┐
│ │
│ 1. COMMITS (Conventional Commits): │
│ feat: nueva feature de export │
│ fix: corregir duplicación de tareas │
│ docs: actualizar guía de usuario │
│ │
│ 2. ISSUES/PRS: │
│ Título + descripción + labels │
│ │
│ 3. TASKS EN GITSCRUM: │
│ Tareas completadas en milestone │
│ │
└─────────────────────────────────────────────────────────────┘
PROCESO:
┌─────────────────────────────────────────────────────────────┐
│ │
│ Automático + Humano │
│ ───────────────────────────────────────── │
│ Extraer commits → Escribir highlights │
│ Agrupar por tipo → Agregar contexto │
│ Generar lista → Simplificar lenguaje │
│ Crear draft → Revisar/publicar │
│ │
└─────────────────────────────────────────────────────────────┘
En GitScrum
WORKFLOW DE RELEASE NOTES
═════════════════════════
1. TRACKEAR DURANTE DESARROLLO:
┌─────────────────────────────────────────────────────────────┐
│ │
│ ☐ Cada tarea tiene descripción clara │
│ ☐ Labels apropiados (feature, bug, improvement) │
│ ☐ Asignado a milestone/release │
│ │
└─────────────────────────────────────────────────────────────┘
2. AL MOMENTO DEL RELEASE:
┌─────────────────────────────────────────────────────────────┐
│ │
│ ☐ Filtrar tareas por milestone │
│ ☐ Exportar lista de tareas completadas │
│ ☐ Agrupar por tipo de cambio │
│ ☐ Escribir highlights │
│ ☐ Revisar para audiencia │
│ │
└─────────────────────────────────────────────────────────────┘
3. PUBLICAR:
┌─────────────────────────────────────────────────────────────┐
│ │
│ ☐ CHANGELOG.md en repo │
│ ☐ Email a usuarios │
│ ☐ Blog post (releases mayores) │
│ ☐ In-app notification │
│ │
└─────────────────────────────────────────────────────────────┘