- Created project overview document for UECKO application. - Added README file for project documentation structure. - Introduced template for architectural decision records (ADR). - Defined backend architecture guidelines. - Established conventions for project-wide consistency. - Documented data persistence architecture. - Outlined frontend architecture principles. - Developed testing strategy documentation. - Provided a general architecture overview. - Created guides for task closure and ChatGPT-Codex workflow. - Organized chat management guidelines for development projects. - Added template for current work status reporting. |
||
|---|---|---|
| docs | ||
| AGENTS.md | ||
Documentación del proyecto
Este directorio contiene la documentación técnica y operativa del proyecto.
Estructura
docs/
├── architecture/
├── adr/
├── work/
├── guides/
└── README.md
architecture/
Documentación estable sobre la arquitectura y las reglas generales del sistema.
adr/
Decisiones arquitectónicas o técnicas relevantes y duraderas.
work/
Estado de trabajos largos, migraciones, refactors o iniciativas en curso.
guides/
Procedimientos operativos y guías para desarrolladores.
Principios
- Evitar duplicar información.
- Mantener una única fuente de verdad por tema.
- Actualizar la documentación cuando cambien decisiones o contratos relevantes.
- No documentar detalles triviales que ya se expresen claramente en el código.