Documentar una decisión de arquitectura con alternativas
Redactar un registro ADR en Markdown con contexto, decisión, alternativas descartadas, consecuencias positivas y negativas, notas de implementación y referencias, numerado junto a los existentes.
Ficha elaborada por peopleofthe.ai con asistencia de IA. Consulta el criterio editorial y los límites de las pruebas.
Revisión documental de contenido, licencia MIT completa, atribución histórica y requisitos; los originales y LICENSE coinciden en bytes, SHA256 y Git blob SHA con la API pública de GitHub en la revisión fijada. Sin instalación, ejecución, conversión, pruebas de calidad o compatibilidad. Límite: Un ADR documenta la decisión aportada; no demuestra que sea la mejor opción ni que esté aprobada. Los números de alternativas y consecuencias deben sustentarse en hechos, sin inventar contenido para completar la plantilla.
Antes de empezar
Comprueba que tienes lo necesario para usar este recurso.
- Visual Studio Code con GitHub Copilot y un entorno que interprete perfiles .agent.md; su carga y compatibilidad nativa no se han probado.
- No declara modelo, lista de herramientas, MCP ni clave API propia. Para seguir el flujo completo, el entorno debe poder leer y escribir archivos del proyecto.
- Aportar título, contexto, restricciones, decisión con motivos, alternativas y participantes; el texto exige pedir los datos obligatorios ausentes antes de continuar.
- Acceso autorizado al repositorio y a docs/adr para comprobar numeración y crear adr-NNNN-[title-slug].md. La carpeta y los ADR existentes son entradas/salidas del proyecto, no archivos auxiliares omitidos del paquete.
- Contenido gratuito bajo MIT; la disponibilidad del motor de IA, modelos y herramientas depende del acceso y las condiciones de sus proveedores. No se ha comprobado una ejecución íntegramente gratuita.
Compatibilidad declarada
Según la documentación de origen. La presencia en esta lista no implica una prueba de ejecución en cada entorno.
Una forma de empezar
EJEMPLO ILUSTRATIVOUna solicitud para adaptar a tu contexto y usar con el recurso.
Caso ficticio: documenta la decisión propuesta de mantener un monolito modular. Aporto contexto, restricciones, alternativas y motivos; identifica las incógnitas y revisa la numeración de docs/adr antes de crear el archivo.
Posible fragmento de ADR: estado Proposed; contexto y restricciones aportadas; decisión de monolito modular; POS-001, despliegue conjunto sencillo; NEG-001, necesidad de cuidar límites internos; ALT-001, microservicios descartados por la carga operativa descrita. Faltaría validar participantes y referencias antes de completar el registro.
Ejemplo editorial ilustrativo, redactado para explicar el uso. No procede de una ejecución del recurso; los hallazgos y resultados son hipotéticos. La salida es un fragmento explicativo, no el ADR completo que prescribe el original. Este ejemplo no es una salida observada de una prueba del recurso.
La fuente, a la vista
- Recurso original
- ADR Generator
- Autor
- André Silva (@askpt), contribución original a github/awesome-copilot; copyright del repositorio: GitHub, Inc.
- Versión o revisión
- 613efc8c21d9b3ce642dff361d17006cd9967e28
- Licencia
- MIT
Conservar Copyright GitHub, Inc. y el permiso MIT completo con las copias o porciones sustanciales. El ZIP mantiene el original y LICENSE sin cambios y añade atribución, procedencia y nota editorial.
Ver fuente original