David
0e7106f30c
- Updated "Ficha del proyecto UECKO.md" to clarify architectural boundaries and continuity rules. - Revised "README.md" to enhance structure and clarify sources of truth for documentation. - Improved "backend.md" with clearer definitions of responsibilities and architectural layers. - Streamlined "convenciones.md" to emphasize naming conventions and TypeScript best practices. - Enhanced "datos-persistencia.md" to specify persistence rules and data integrity measures. - Updated "frontend.md" to define frontend rules and state management practices. - Refined "testing.md" to clarify testing levels and validation processes. - Revised "vision-general.md" to outline system architecture and module boundaries more clearly.
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
# 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/`](arquitectura/).
|
|
- Restricciones funcionales estables del producto: [`Ficha del proyecto UECKO.md`](Ficha%20del%20proyecto%20UECKO.md).
|
|
- Decisiones duraderas: [`adr/`](adr/).
|
|
- Procedimiento de trabajo y cierre: [`guias/`](guias/).
|
|
- Estado de iniciativas largas: [`trabajo/`](trabajo/).
|
|
|
|
## Estructura
|
|
|
|
```text
|
|
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.
|