FactuGES_ERP/docs/README.md

86 lines
3.9 KiB
Markdown
Raw Normal View History

2026-07-06 12:04:47 +00:00
# ERP Docs
2025-04-22 15:09:57 +00:00
Este directorio reúne la documentación técnica, operativa y de apoyo del ERP.
## Cómo leer esta documentación
- Empieza por este índice si necesitas orientarte.
- Usa los documentos en subdirectorios temáticos como fuente de verdad operativa.
- Trata los documentos marcados como históricos o legacy como contexto, no como contrato vigente.
## Estructura documental
### Documentación vigente
#### Arquitectura y runtime
- [Arquitectura general](./architecture/README.md)
2026-07-06 12:04:47 +00:00
- [Contexto tenant y `X-Company-Id`](./architecture/tenant-context.md)
- [Tratamiento de errores HTTP en frontend](./architecture/http-error-handling-frontend.md)
- [API de autenticación de `identity`](./architecture/identity-auth-api.md)
- [Relación entre `identity` y `companies`](./architecture/identity-and-companies.md)
- [Estado de migración a `identity`](./architecture/identity-migration-status.md)
2026-07-29 09:24:06 +00:00
#### Frontend
2026-07-29 09:24:06 +00:00
- [Flujo de auth y selección de empresa](./frontend/auth-and-company-selection.md)
- [README de `apps/web`](../apps/web/README.md)
2026-07-29 09:24:06 +00:00
#### Customer invoices y proformas
2026-07-29 09:24:06 +00:00
- [Índice de `customer-invoices`](./customer-invoices/README.md)
- [Contrato de series de proformas](./customer-invoices/proforma-series-contract.md)
2026-07-29 09:24:06 +00:00
- [Contrato de create de proformas](./customer-invoices/proforma-create-contract.md)
- [Configuración fiscal persistida en proformas](./customer-invoices/proforma-tax-config.md)
- [Reports de proformas](./customer-invoices/proformas-reports.md)
2026-07-29 09:24:06 +00:00
#### Document series
2026-07-29 09:24:06 +00:00
- [README de `document-series`](./document-series/README.md)
- [Diseño de `document-series`](./document-series/document-series-design.md)
- [Validación manual de `document-series`](./document-series/manual-validation.md)
- [Validación manual de concurrencia](./document-series/manual-concurrency-validation.md)
2026-07-29 09:24:06 +00:00
#### Módulos y runtime local
2026-07-29 09:24:06 +00:00
2026-07-06 15:47:05 +00:00
- [README de `modules/identity`](../modules/identity/README.md)
- [README de `modules/companies`](../modules/companies/README.md)
- [README de `modules/auth`](../modules/auth/README.md)
2026-08-11 07:59:09 +00:00
- [API pública de selección y alta rápida de clientes](./customers/customer-selection-and-quick-create.md)
2025-04-22 15:09:57 +00:00
#### Guías y estándares
2026-07-29 09:24:06 +00:00
- [Guía de diseño de DTOs](./DTOS - GUÍA DE DISEÑO.md)
- [Convención de nombres de schemas DTO](./CONVENCION NOMBRADO DE ESQUEMAS DTO.md)
#### SQL operativos y runbooks
- [SQL de `customer-invoices`](./customer-invoices/sql/README.md)
- [Validación de migración a `document-series`](./document-series/sql/validate-document-series-migration.sql)
2026-07-29 09:24:06 +00:00
- [Seed local de admin](./dev/seed-local-admin.sql)
### Material auxiliar
- [Base común para prompts backend](./backend-prompt-base.md)
- [Prompt de auth](./prompt-auth.md)
- [Prompt de customer invoices](./prompt-customer-invoices.md)
- [Plantilla auxiliar](./TEMPLATE.md)
### Histórico, transicional o de descubrimiento
2025-04-22 15:09:57 +00:00
Estos documentos se conservan por trazabilidad, auditoría o contexto de decisiones. No deben usarse como fuente de verdad del runtime actual sin contrastarlos con la documentación vigente.
- [Borrador legacy de API](./API.md)
- [Requisitos generales históricos](./REQUISITOS GENERALES.md)
- [Requisitos históricos del módulo de clientes](./REQUISITOS CLIENTES.md)
- [Notas históricas de facturas de cliente](./FACTURAS DE CLIENTE.md)
- [Split histórico Proforma / IssuedInvoice](./customer-invoices/split-proformas-issued-invoices-migration.md)
- [Migración desde `customer_invoice_series`](./document-series/migration-from-customer-invoice-series.md)
- [InvoiceSeries legacy](./customer-invoices/invoice-series.md)
2025-04-22 15:09:57 +00:00
## Regla práctica de mantenimiento
2025-04-22 15:09:57 +00:00
- Los documentos operativos vigentes deben vivir en subdirectorios temáticos y tener una responsabilidad clara.
- Los documentos raíz en mayúsculas o con naming heredado deben considerarse legacy o auxiliares salvo que este índice los declare explícitamente vigentes.
- Si una regla ya tiene fuente canónica, los demás documentos deben resumirla y enlazarla, no copiarla.