Documentación

Todos los documentos están disponibles como Markdown puro para consumo por LLMs. Ver llms.txt para el índice legible por máquina. La mayoría de las páginas de referencia de la edición para la JVM están alojadas aquí; unas pocas (los enlaces a GitHub de abajo) enlazan directamente a su guía en el repositorio narrativetrace-java, en su propia traducción al español, en lugar de a una segunda copia. Cada runtime carga su propia documentación en su propio repositorio — comienza por ahí.

Por runtime

TypeScript — mira un trace en 60 segundos @narrativetrace/* — traceObject, el decorator @traced, la fixture de Vitest; 20 paquetes publicados en npm
Java — mira un trace en 60 segundos ai.narrativetrace en Maven Central — el plugin Gradle, el proxy, JUnit 5
.NET — mira un trace en 60 segundos NarrativeTrace.* en nuget.org — NarrativeTraceProxy.Create, AddNarrativeTracing, la fixture de xUnit
Python — mira un trace en 60 segundos narrativetrace en PyPI — trace_object, el decorator @narrated, la fixture de pytest

Primeros pasos

Primeros pasos Elige un runtime, mira un trace en 60 segundos, luego encuentra las guías de instalación y de funcionalidades

Conceptos centrales (en el repositorio Java, con su propia traducción al español)

Referencia de anotaciones Referencia de @Narrated, @OnError, @NotTraced y @NarrativeSummary
Niveles de captura Cinco niveles de OFF a DETAIL — la arquitectura de dos puertas
Formatos de salida Markdown, JSON y prosa renderizados desde una única traza
Trazas de aprobación narrativa Trazas .nt sin valores, el delta desde el último verde, baselines de aprobación que rompen el build — 0.2.0
Diagnóstico de claridad Puntuación de calidad de código a partir de la narrativa de ejecución, con una observación por elemento
Glosario de dominio y trazas traducidas Lenguaje ubicuo recolectado de ejecuciones reales, aplicado en CI, trazas en el idioma de tu equipo — 0.2.0
Diagramas Diagramas de secuencia Mermaid y PlantUML

Integraciones

TypeScript

Fixture de Vitest Fixture narrativeTest por test — archivos de traza automáticos, reporte de claridad y fallos por test
Middleware Express Middleware que abre un contexto de traza por cada petición, con extractores a prueba de fallos
NestJS AutoProxyModule envuelve automáticamente cada provider de DI — tracing sin código
Pino Envía los eventos de llamada a un logger Pino, con la identidad de traza también en tus propias líneas de log
OpenTelemetry Traduce las narrativas de llamada capturadas en spans de OpenTelemetry, en vivo o por lote

Java

Spring Boot @EnableNarrativeTrace, soporte async, integración con Spring Boot
JUnit 5 Archivos de traza por prueba, delta desde el último verde, modo de aprobación, reporte de claridad
JUnit 4 Integración vía @Rule para suites de prueba heredadas
Puente SLF4J Campos MDC, convivencia con el logging existente
Agente Java Instrumentación de bytecode sin código; jar independiente para servidores de aplicación y WARs sin modificar
Micrometer Propagación de contexto entre hilos para @Async y CompletableFuture
Plugin Gradle Configuración en un solo bloque; tareas clarityCheck, glossaryScan y approveNarratives — 0.2.0

.NET

Microsoft.Extensions.Logging Enruta los eventos de traza a través de tu ILogger, vía decorator, exporter o listener de DI
Middleware ASP.NET Core Contexto de traza por petición con ámbito propio, exporters configurables, exclusión de rutas
Auto-wrap por DI AddNarrativeTracing decora automáticamente cada servicio de DI por namespace — sin tocar el código
xUnit NarrativeFixture narra la traza capturada automáticamente cuando un test falla
NUnit NarrativeTestBase conecta el contexto de setup/teardown y narra los fallos vía TestContext
OpenTelemetry Exporta las trazas como spans Activity de OpenTelemetry, en vivo o por lote

Python

Plugin pytest Fixture narrative_trace por test, reportes de traza en fallos, resumen de claridad de la suite
Middleware FastAPI / ASGI Un árbol de traza por petición HTTP; propaga las cabeceras W3C traceparent
structlog Un processor de structlog que inyecta las mismas claves de correlación de traza en cada evento
OpenTelemetry Emite la traza capturada como spans de OpenTelemetry, en vivo o por lote

Agregación, integración con IA y compliance

Visión general Agregación, integración con IA, grafos de dependencias y eventos de auditoría — acceso anticipado
Agregación de flujos Resúmenes de flujo, diffs de migración, análisis de frecuencia de caminos
Grafos de dependencias Visualización de dependencias en tiempo de ejecución como grafos Mermaid
Servidor MCP Servidor Model Context Protocol para agentes de IA — próximamente
Auditoría y SecOps @AuditEvent, @SecurityEvent, políticas de compliance
Especificación de auditoría Inferencia determinista, enmascaramiento de campos, clasificación de datos

Arquitectura

Separación narrativa/valor Principio de diseño central — separar la estructura de los valores en tiempo de ejecución
Especificación de formatos de salida Especificaciones de los formatos JSON canónico, Markdown y prosa
Estructura de módulos Organización, coordenadas y dependencias de los módulos