Documentación del proyecto

Este directorio reúne la documentación técnica, funcional y operativa del proyecto. Cada tema debe tener una fuente de verdad principal; los demás documentos deben enlazarla sin duplicarla.

Dónde consultar cada regla

• Arquitectura, contratos y convenciones técnicas: arquitectura/.
• Restricciones funcionales estables del producto: Ficha del proyecto UECKO.md.
• Decisiones duraderas: adr/.
• Procedimiento de trabajo y cierre: guias/.
• Estado de iniciativas largas: trabajo/.

Estructura

docs/
├── README.md
├── Ficha del proyecto UECKO.md
├── adr/
├── arquitectura/
├── guias/
└── trabajo/

Documentos normativos

Las reglas de arquitectura, contratos, persistencia, frontend, convenciones y testing se definen respectivamente en los documentos de arquitectura/. La ficha define el contexto e invariantes funcionales transversales disponibles en el repositorio.

Guías y plantillas

Las guías describen procedimientos operativos; no sustituyen las normas de arquitectura. Las plantillas de adr/ y trabajo/ no establecen reglas por sí mismas.

Mantenimiento

• Redactar la documentación en castellano y Markdown.
• Actualizar el documento normativo aplicable cuando cambie una decisión, contrato o invariante.
• No documentar detalles triviales ya expresados con claridad por el código.