academia/docs/architecture/diagrams
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
..
.svg docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
01-use-cases.puml docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
01-use-cases.svg docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
02-domain-model.puml docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
02-domain-model.svg docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
03-sequence-enrollment.puml docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
03-sequence-enrollment.svg docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
04-components.puml docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
04-components.svg docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
05-entity-relationship.puml docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
05-entity-relationship.svg docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
06-state-enrollment.puml docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
06-state-enrollment.svg docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
07-deployment.puml docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
07-deployment.svg docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
08-c4-context.puml docs: add project documentation and env template 2026-01-07 23:00:56 -05:00
08-c4-context.svg 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

Diagramas UML - Sistema de Registro de Estudiantes

Diagramas de arquitectura y diseño del sistema, creados con PlantUML siguiendo el estándar UML 2.5.

Diagramas Disponibles

# Diagrama Archivo Descripción
1 Casos de Uso 01-use-cases Funcionalidades del sistema desde perspectiva del estudiante
2 Modelo de Dominio 02-domain-model Entidades, Value Objects y servicios de dominio
3 Secuencia: Inscripción 03-sequence-enrollment Flujo completo del proceso de inscripción
4 Componentes 04-components Arquitectura de componentes frontend y backend
5 Entidad-Relación 05-entity-relationship Modelo de base de datos
6 Estados: Inscripción 06-state-enrollment Estados del estudiante según créditos
7 Despliegue 07-deployment Infraestructura Docker
8 C4 Contexto 08-c4-context Vista de alto nivel del sistema

Regenerar Diagramas

Los archivos .puml son la fuente. Para regenerar los SVG:

cd docs/architecture/diagrams

# Regenerar todos
for f in *.puml; do
  cat "$f" | plantuml -tsvg -pipe > "${f%.puml}.svg"
done

# O uno específico
cat 01-use-cases.puml | plantuml -tsvg -pipe > 01-use-cases.svg

Requisitos

  • PlantUML instalado
  • Java Runtime (requerido por PlantUML)
# Ubuntu/Debian
sudo apt install plantuml

# Verificar instalación
plantuml -version