andresgarcia0313
/
academia
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
academia/docs/architecture/decisions
History
Andrés Eduardo García Márquez 4fa8dc03a0 docs: add project documentation and env template 
Environment:
- .env.example template with all configuration variables
- Database, API, GraphQL, and frontend settings

Documentation:
- Architecture Decision Records (ADR-001 to ADR-004)
- Deployment guide with Docker and K8s instructions
- OWASP security checklist
- Code review checklist
- Activity plan and deliverables

Architecture diagrams (PlantUML):
- Use cases, domain model, sequence diagrams
- Component, ER, state, and deployment diagrams
- C4 context diagram
 		2026-01-07 23:00:56 -05:00
..
ADR-001-clean-architecture.md docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
ADR-002-graphql-vs-rest.md docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
ADR-003-angular-signals.md docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
ADR-004-validation-strategy.md docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
README.md docs: add project documentation and env template 2026-01-07 23:00:56 -05:00

README.md

Architecture Decision Records (ADR)

Registro de decisiones arquitectónicas del proyecto.

Índice

ADR Título Estado
ADR-001 Clean Architecture Aceptado
ADR-002 GraphQL vs REST Aceptado
ADR-003 Signals vs RxJS Aceptado
ADR-004 Estrategia de Validación Aceptado

Formato ADR

Cada ADR sigue el formato:

  1. Título: Nombre descriptivo
  2. Estado: Propuesto | Aceptado | Deprecado | Reemplazado
  3. Contexto: Por qué se necesita esta decisión
  4. Decisión: Qué se decidió
  5. Consecuencias: Positivas y negativas
  6. Alternativas: Opciones consideradas y descartadas

Convenciones

  • Nuevos ADRs: ADR-XXX-nombre-descriptivo.md
  • Nunca modificar ADRs aceptados (crear uno nuevo que lo reemplace)
  • Mantener este índice actualizado