Desarrollo
Plantilla de decisión de arquitectura (ADR)
Dentro de seis meses alguien preguntará por qué el sistema funciona como funciona. Una decisión de arquitectura responde eso en una o dos páginas. Esta plantilla cubre el contexto, las opciones que evaluaste, la decisión, sus consecuencias, el trabajo de seguimiento y las condiciones para revisarla.
Abrir esta plantilla en el editor- Categoría
- Desarrollo
- Estilo predeterminado
- Técnico
Cuándo usarla
Escribe un ADR cuando una elección técnica sea costosa de revertir: una base de datos, un framework, un modelo de hospedaje, un estilo de API. Quienes mantengan el sistema en el futuro, las personas nuevas en el equipo y quienes revisan la decisión la leen para entender las restricciones que enfrentaste en ese momento. Escríbela mientras la discusión está fresca y mantén la línea de estado actualizada a medida que avanza la propuesta.
Qué incluye
- Un título de ADR numerado con campos para completar el proyecto, la persona autora y la fecha, y una línea de estado.
- Una tabla de opciones que compara beneficios y costos, incluida una fila para mantener el enfoque actual.
- Decisión, consecuencias positivas y negativas, una lista de verificación de implementación y un motivo de revisión.
Consejos para un mejor documento
- Expresa la decisión en una frase y da la razón más fuerte. Si necesitas cinco razones, la sección de contexto probablemente necesita más trabajo.
- Sé honesto en las consecuencias negativas. Si un diagrama explica el cambio mejor que el texto, añade un bloque Mermaid y se mostrará en el PDF.
Vista previa de la plantilla
ADR-001: Proyecto o tema
Autor: Tu nombre · Fecha: Fecha
Estado: Propuesta
Contexto
Describe el problema, las restricciones y los factores que determinan esta decisión.
Opciones consideradas
| Opción | Beneficios | Costos |
|---|---|---|
| Opción A | Ventaja principal | Compensación principal |
| Opción B | Ventaja principal | Compensación principal |
| Mantener el enfoque actual | Sin migración | Limitación existente |
Decisión
Indica el enfoque elegido y la razón más importante para elegirlo.
Consecuencias
Positivas: Qué se vuelve más fácil.
Negativas: Qué se vuelve más difícil o costoso.
Implementación
- Asignar un responsable
- Planificar la migración y la reversión
- Actualizar la documentación
Motivo de revisión
Especifica qué evidencia o cambio haría que se reconsiderara esta decisión.
Los campos por completar, como tu nombre y la fecha, se sustituyen cuando abres la plantilla en el editor.