Workflow de documentacion
Cuando documentar
Sección titulada «Cuando documentar»Actualizar docs cuando una tarea:
- Agrega o cambia una funcionalidad en produccion.
- Cambia reglas de negocio.
- Cambia permisos, roles, datos sensibles o multi-tenant.
- Cambia contratos API, DTOs o eventos.
- Crea una decision tecnica o funcional que otros deben respetar.
- Cambia comportamiento visible para usuarios o despliegue.
Donde documentar
Sección titulada «Donde documentar»- Features en produccion:
features/. - Arquitectura tecnica:
architecture/. - Guias de desarrollo y testing:
development/. - Decisiones:
adr/. - Release notes:
releases/. - Plantillas:
templates/.
Relacion con tareas
Sección titulada «Relacion con tareas»En cada tarea relevante, dejar evidencia de:
- Documento creado o actualizado.
- Tests agregados o ejecutados.
- Build ejecutado.
- Riesgos no cubiertos.
Release notes
Sección titulada «Release notes»Las release notes se escriben manualmente dentro de releases/. Deben ser curadas por una persona o agente con contexto de producto, no generadas automaticamente desde commits.
Actualizar release notes cuando una tarea:
- Agrega una funcionalidad visible para usuarios.
- Cambia comportamiento operativo.
- Corrige un bug relevante.
- Cambia permisos, seguridad, privacidad o datos sensibles.
- Requiere pasos de migracion o despliegue.
Las release notes deben explicar que cambio, por que importa y si hay algo que el equipo deba saber antes de desplegar. No son una copia literal de commits ni de issues.