Lizandro GuarnizoandClaude Opus 5
dc27184051
Un documento puede declarar qué roles lo ven mediante una cabecera al inicio del archivo; sin ella hereda el permiso de su sección. Los administradores ven todo. Se aplica tanto al índice como al acceso directo por URL, y una sección que queda sin documentos visibles deja de mostrarse. Con esto un recepcionista ve solo el manual de recepción, un bacteriólogo el de toma de muestras y un enfermero el suyo, en vez del manual completo. El módulo declaraba cinco enlaces que apuntaban todos a la misma vista, así que al abrir una sección quedaban dos entradas marcadas como activas a la vez. Queda una sola, "Documentación": la navegación por secciones ya vive dentro de la página. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
61 lines
2.1 KiB
Markdown
61 lines
2.1 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.
|
|
|
|
## Limitar un documento a ciertos roles
|
|
|
|
Por defecto un documento hereda el permiso de su sección. Para restringirlo más,
|
|
se declara al inicio del archivo:
|
|
|
|
---
|
|
roles: enfermero, supervisor
|
|
---
|
|
|
|
# Enfermeros — domicilios
|
|
|
|
Solo esos roles lo ven; para el resto no aparece en el índice ni es accesible
|
|
por URL. Los administradores ven todo, siempre. Una sección que queda sin
|
|
documentos visibles no se muestra.
|
|
|
|
## 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.
|