migration-guide

$npx mdskill add 686f6c61/alfred-dev/migration-guide

Drafts migration guides for breaking changes and version updates.

  • Prevents user adoption delays by documenting API deprecations.
  • Depends on changelogs and commit history from stable releases.
  • Categorizes modifications as breaking changes, deprecations, or new behaviors.
  • Outputs structured markdown files with before/after code examples.

SKILL.md

.github/skills/migration-guideView on GitHub ↗
---
name: migration-guide
description: "Generar guías de migración entre versiones para los usuarios del proyecto. Activar ante: guia de migracion, actualizar version, breaking changes, instrucciones de actualizacion"
---

# Guía de migración entre versiones

## Resumen

Este skill genera una guía de migración cuando el proyecto lanza una versión con cambios que afectan a los usuarios existentes (breaking changes, APIs deprecadas, cambios de configuración). La guía explica exactamente qué cambió, por qué y qué pasos debe seguir el usuario para actualizar sin romperse.

Las migraciones sin guía son la causa principal de que los usuarios se queden en versiones antiguas. Una buena guía de migración facilita la adopción y reduce la carga de soporte.

## Proceso

### Paso 1: identificar los cambios

- Revisar el changelog y los commits desde la última versión estable.
- Clasificar cada cambio: breaking change, deprecación, nuevo comportamiento, eliminación.
- Para cada breaking change, documentar: qué era antes, qué es ahora, por qué se cambió.

### Paso 2: escribir la guía

Crear `docs/migration-vX.Y.md` con la estructura:

1. **Resumen de cambios**: lista breve de lo que cambia en esta versión.

2. **Breaking changes**: para cada uno:
   - Qué hacía antes y qué hace ahora.
   - Código de ejemplo antes/después.
   - Pasos exactos para migrar.

3. **Deprecaciones**: funcionalidades que siguen funcionando pero se eliminarán en una versión futura. Indicar la alternativa recomendada.

4. **Nuevas funcionalidades**: lo que se ha añadido y cómo usarlo.

5. **Pasos de migración**: checklist ordenado que el usuario puede seguir de arriba a abajo.

6. **Problemas conocidos**: si hay limitaciones o bugs conocidos en la nueva versión, mencionarlos con workaround si existe.

### Paso 3: verificar la guía

- Simular la migración siguiendo los pasos de la guía.
- Verificar que los ejemplos de código son correctos y ejecutables.
- Comprobar que no falta ningún breaking change.

## Qué NO hacer

- No omitir breaking changes por pequeños que sean. Si algo deja de funcionar, se documenta.
- No asumir que el usuario lee el changelog. La guía de migración es autosuficiente.
- No mezclar instrucciones de migración con documentación de la nueva versión. Son documentos distintos.

More from 686f6c61/alfred-dev

SkillDescription
acceptance-criteriaGenerar criterios de aceptación en formato Given/When/Then. Activar cuando el usuario quiera definir criterios de aceptacion, usar formato Given When Then, escribir en Gherkin, saber como determinar que algo esta terminado o establecer una definicion de hecho.
architecture-docsUsar para documentar la arquitectura del sistema. Activar ante: documentar arquitectura, diagrama del sistema, como funciona el proyecto, vision general tecnica
bundle-sizeAnalizar y reducir el tamaño de bundles frontend. Activar cuando el bundle sea grande, se quiera reducir tamaño, aplicar tree shaking, configurar lazy loading, usar webpack analyzer o analizar el peso de la aplicacion.
choose-stackUsar para evaluar y elegir tecnologías con matriz de decisión ponderada. Activar cuando el usuario quiera elegir tecnología, comparar frameworks, decidir entre alternativas técnicas, construir una matriz de decisión, evaluar stack, seleccionar base de datos, elegir lenguaje o comparar herramientas.
ci-cd-pipelineConfigurar pipeline CI/CD adaptado al proyecto. Activar cuando el usuario quiera configurar CI, crear GitHub Actions, configurar GitLab CI, montar un pipeline de despliegue, automatizar tests o implementar integracion continua.
code-review-responseUsar al recibir feedback de code review para responder técnicamente. Activar cuando el usuario quiera responder a comentarios de PR, gestionar feedback de code review, resolver comentarios de un revisor, o cuando el revisor pide cambios en el código.
compliance-checkUsar para verificar cumplimiento RGPD, NIS2 y CRA. También: verificar RGPD, cumplimiento normativo, NIS2, CRA, Cyber Resilience Act, protección de datos, regulación europea.
copy-reviewRevisar textos publicos: claridad, tono, ortografia y CTAs. Activar ante: revisar textos, mejorar copy, tono de comunicacion, textos de la web, landing page copy
dependency-strategyEstrategia integral de gestion de dependencias: inventario, evaluacion de riesgo, politica de actualizaciones y documentacion. Usar para auditar el estado global de las dependencias del proyecto.
dependency-updateRevisar dependencias desactualizadas, con CVEs o end-of-life, y proponer actualizaciones seguras. También: actualizar paquetes, actualizar dependencias, Dependabot, Renovate, versión desactualizada, breaking changes.