Buscar en la documentación

Documentación de Trazo

Punto de entrada a la documentación funcional y técnica de Trazo.

2 min de lecturaVer en GitHub

Trazo es un sistema de gestión de solicitudes e incidentes. Esta documentación está organizada por público: quien necesita entender el producto encuentra lo suyo sin pasar por detalles técnicos, y quien lo construye u opera encuentra el detalle completo.

Para soporte y directivos

SecciónContenido
ProductoQué es Trazo, roles, ciclo de vida de un incidente y guías de uso
SoporteCatálogo de errores y preguntas frecuentes

Para el equipo técnico

SecciónContenido
ArquitecturaVisión general, capas y flujos
FlujosCada flujo en carriles por actor, con sus errores y dónde está en el código
BackendMódulos de la API
FrontendMódulos de la SPA y sistema de diseño
Base de datosModelo, diccionario de datos y crecimiento
APIConvenciones y referencia
SeguridadAutenticación, OWASP y logs
OperaciónInstalación, Docker, despliegue y CI/CD
CalidadEstrategia de pruebas
DecisionesRegistro de decisiones (ADR)
MejorasLo agregado más allá de lo pedido y las propuestas a futuro

Convenciones de esta documentación

  • Cada página empieza con metadatos (title, description, audience, area, module, order) que ordenan y filtran el contenido. Los ADR llevan además tags con su tema.
  • Las páginas técnicas incluyen la sección Dónde está en el código, con enlaces a los archivos que implementan lo descrito.
  • Los diagramas se escriben en Mermaid, junto al texto, para que se actualicen en el mismo cambio que el código.
  • A nivel de función, la referencia vive en el propio código (PHPDoc y TSDoc) y se genera de forma automática.