Documentação
Todos os documentos estão disponíveis como Markdown puro para consumo por LLMs. Veja o llms.txt para o índice legível por máquina. O original em inglês é a versão de referência; cada documento em português abre com um link para ele.
Primeiros passos
- Primeiros passos Guia rápido de 5 minutos — adicione o NarrativeTrace a um projeto Java e capture o seu primeiro trace
Conceitos centrais
- Referência de anotações Referência de @Narrated, @OnError, @NotTraced e @NarrativeSummary
- Níveis de captura Cinco níveis de OFF a DETAIL — a arquitetura de duas portas
- Formatos de saída Markdown, JSON e prosa renderizados a partir de um único trace
- Testes de aprovação narrativa Traces .nt sem valores, o delta desde o último verde, linhas de base de aprovação que quebram o build — 0.2.0
- Diagnóstico de clareza Pontuação de qualidade de código a partir da narrativa de execução, com uma observação por elemento
- Glossário de domínio e traces traduzidos Linguagem ubíqua colhida de execuções reais, aplicada no CI, traces no idioma do seu time — 0.2.0
- Geração de diagramas Diagramas de sequência Mermaid e PlantUML
Integrações
- Spring Boot @EnableNarrativeTrace, suporte a async, integração com Spring Boot
- JUnit 5 Arquivos de trace por teste, delta desde o último verde, modo de aprovação, relatório de clareza
- JUnit 4 Integração via @Rule para suítes de teste legadas
- Ponte SLF4J Campos MDC, convivência com o logging existente
- Agente Java Instrumentação de bytecode sem código; jar standalone para servidores de aplicação e WARs sem modificação
- Micrometer Propagação de contexto entre threads para @Async e CompletableFuture
- Plugin Gradle Configuração em um bloco; tarefas clarityCheck, glossaryScan e approveNarratives — 0.2.0
Pro
- Visão geral do Pro Integração com IA, análises avançadas e recursos de compliance — acesso antecipado
- Agregação de fluxos Resumos de fluxo, diffs de migração, análise de frequência de caminhos
- Grafos de dependências Visualização de dependências de runtime como grafos Mermaid
- Servidor MCP Servidor Model Context Protocol para agentes de IA — em breve
- Auditoria e SecOps @AuditEvent, @SecurityEvent, políticas de compliance
- Especificação de auditoria Inferência determinística, mascaramento de campos, classificação de dados
Arquitetura
- Separação narrativa/valor Princípio central de design — separar a estrutura dos valores de runtime
- Especificação de formatos de saída Especificações dos formatos JSON canônico, Markdown e prosa
- Estrutura de módulos Organização e dependências dos módulos Free e Pro