Lizandro GuarnizoandClaude Opus 5
32c209710c
21 documentos en cuatro secciones, escritos sobre el comportamiento real del sistema —incluidos los casos que costaron diagnosticar esta semana. Manual de usuario (visible para todos): primeros pasos, recepción, toma de muestras, portal del enfermero y administración. Orientado a tareas concretas, no a describir pantallas. Documentación técnica: índice de módulos, turnero, formularios y firma digital, WhatsApp y bot, domicilios, webhook (migrado de WEBHOOK_ENDPOINTS.md) e inventario de endpoints. Arquitectura: visión general, enrutamiento y registro de módulos, roles y permisos, modelo de datos, integración con WhatsApp, y decisiones tomadas con su deuda técnica asociada. Operación: runbook de incidentes ordenado por síntoma, configuraciones críticas —incluido qué vive en Meta y no en la base— y despliegue. Se documentan explícitamente las trampas conocidas: role/role_id que hay que mantener sincronizados, las columnas can_* que el control de acceso no lee, las URL de plantilla que no se cambian desde el código, y las columnas históricas que quedaron en NULL sin forma de recuperarlas. README_DOCS.md apunta al módulo y explica cómo agregar páginas. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
46 lines
1.7 KiB
Markdown
46 lines
1.7 KiB
Markdown
# Documentación del proyecto
|
|
|
|
La documentación vive **dentro del sistema**, en el módulo Soporte:
|
|
|
|
/erp.php?m=soporte&v=documentacion
|
|
|
|
Se escribe en Markdown, en `modules/soporte/docs/`, y se versiona con el código.
|
|
|
|
| Sección | Carpeta | Quién la ve |
|
|
|---|---|---|
|
|
| Manual de usuario | `docs/manual/` | Cualquier usuario autenticado |
|
|
| Documentación técnica | `docs/tecnica/` | Administradores |
|
|
| Arquitectura | `docs/arquitectura/` | Administradores |
|
|
| Operación y soporte | `docs/operacion/` | Administradores |
|
|
|
|
## Agregar o editar una página
|
|
|
|
Creá un `.md` en la carpeta de la sección. El nombre lleva un prefijo numérico
|
|
que solo sirve para ordenar:
|
|
|
|
modules/soporte/docs/tecnica/70-mi-tema.md
|
|
|
|
El título sale del primer encabezado `#` del archivo. No hay que registrar nada
|
|
en ningún índice: se descubre solo.
|
|
|
|
## Contenido que se genera solo
|
|
|
|
Estos marcadores, en una línea propia, se reemplazan al cargar la página con
|
|
datos leídos del código y de la base:
|
|
|
|
| Marcador | Qué inserta |
|
|
|----------|-------------|
|
|
| `{{modulos}}` | Módulos, con sus vistas y endpoints |
|
|
| `{{endpoints}}` | Todos los endpoints por módulo |
|
|
| `{{tablas}}` | Tablas de la base, agrupadas por prefijo |
|
|
| `{{roles}}` | Roles, usuarios activos y sus permisos |
|
|
| `{{servicios}}` | Clases de `core/`, `services/` y `classes/` |
|
|
|
|
Así los inventarios no pueden quedar desactualizados. La descripción de cada
|
|
endpoint sale de su comentario de cabecera: si lo escribís bien, aparece bien.
|
|
|
|
## Documentos anteriores
|
|
|
|
`DOCUMENTACION_LAB.md` y `README_LAB.md` quedaron de una etapa previa y están
|
|
desactualizados. `WEBHOOK_ENDPOINTS.md` se migró a la sección técnica.
|