docs: README, ARCHITECTURE, roadmap futuro y manual de QA del dashboard

- README.md: pitch, arquitectura, quickstart, demo guiada en 3 pasos, tabla de
  capacidades, estructura del repo, comandos de tests.
- ARCHITECTURE.md: patrones (Strategy, config-over-code, fail-closed,
  trazabilidad), tabla de persistencia, patrón HITL, observabilidad, errores.
- docs/futuro.md: roadmap post-MVP.
- docs/manual_qa.md: checklist del smoke manual del dashboard (5 páginas + PII +
  persistencia).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Juan
2026-05-11 13:02:06 +02:00
co-authored by Claude Opus 4.7
parent 03941acb52
commit 6216689511
4 changed files with 245 additions and 0 deletions
+15
View File
@@ -0,0 +1,15 @@
# Roadmap (post-MVP)
- **NeMo Guardrails full**: configuración Colang con KB embedding + dialog rails.
- **Autenticación**: OAuth2/OIDC con MSAL para entornos Azure AD.
- **OpenTelemetry**: spans por nodo del grafo, métricas de violaciones por validador.
- **Multi-tenant**: `tenant_id` aislado por registry, política y datos.
- **Evaluadores LLM-as-judge**: regression suite que ejecuta cada agente
sobre escenarios canónicos y mide deriva.
- **UI de aprobación con SLA**: cola Kanban, reasignación entre operadores,
alertas cuando un HITL rebasa SLA.
- **Persistencia migrable a Postgres + pgvector**: requerido para alta
disponibilidad multi-instance.
- **Esquema de prompts mejorado**: variables tipadas en system_prompt
(Jinja-like), valores por entorno.
- **Promoción explícita draft → active** vía PR/aprobación.
+58
View File
@@ -0,0 +1,58 @@
# Smoke manual del dashboard
> Esta lista cubre los flujos no automatizados (Streamlit). Ejecutar tras
> cambios visuales o estructurales del dashboard.
## Setup
```bash
cp .env.example .env
docker compose up -d
sleep 15
```
Abrir [http://localhost:8501](http://localhost:8501).
## 1) Registro
- [ ] Aparece `incident_analyzer` en el desplegable.
- [ ] Detalle muestra version, owner, propósito, guardrails, system_prompt.
- [ ] Tabla de versiones lista `v1` y `v2`.
- [ ] Diff `v1 → v2` muestra cambios coloreados.
## 2) Ejecutar
- [ ] Botones de escenarios cargan texto en el textarea.
- [ ] Invocar `02_mos_degradation_pool_sbc` → status=`completed`, sin HITL,
decision_path con 6 steps.
- [ ] Invocar `01_sip_registration_drop` → status=`awaiting_approval`,
banner amarillo redirige a Aprobaciones.
## 3) Aprobaciones
- [ ] La ejecución pendiente aparece en el desplegable.
- [ ] Cada acción muestra risk_score con color, target y rollback_plan.
- [ ] Aprobar acciones seleccionadas → status=`completed`.
- [ ] Rechazo con razón → status=`failed`, error=`rejected_by_human`.
## 4) Historial
- [ ] Tab "Ejecuciones" lista todas las ejecuciones con summary.
- [ ] Detalle muestra trace + violations.
- [ ] Tab "Violaciones" filtrable por severity.
## 5) Politicas
- [ ] `default` aparece con sus validadores de input/output.
- [ ] Cada validador expandible con su config.
## Bloqueo por PII (input)
- [ ] Pegar `El cliente con NIF 12345678Z reporta caída`.
- [ ] Invocar → status=`blocked_by_guardrail`, violación `DetectPII`.
## Persistencia
- [ ] `docker compose down && docker compose up` → ejecuciones previas
siguen accesibles vía Historial; aprobaciones pendientes siguen
pendientes.