Antora Tracer — Project Site
Welcome to the project site for the Antora Tracer extension — a role-based traceability extension for Antora/AsciiDoc.
Where to start
Pick the section that matches what you need:
-
Tutorial: Getting Started — follow a step-by-step guide from zero to a working traceability setup
-
How-to Guides — solve a specific task (set up a project, define a custom domain model, export to Neo4j, troubleshoot issues)
-
Reference — look up macro syntax, CLI commands, configuration options, or the API
-
Explanation — understand the traceability model, processing pipeline, architecture, and design decisions
What’s here
This site follows the Diátaxis documentation framework:
| Section | Answers the question | Example pages |
|---|---|---|
Tutorial |
"Can you teach me to…?" |
Getting Started |
How-to Guides |
"How do I…?" |
Set up a project, Define a domain model, Export to Neo4j |
Reference |
"What does X do?" |
Item macro syntax, CLI commands, Configuration options, API |
Explanation |
"Why does it work that way?" |
Traceability model, Processing pipeline, Architecture, ADRs |
A fifth section, Self-Traceability, demonstrates the extension applied to its own development — requirements, use cases, test plan, and dashboard — traced against each other using the same [item] macros.
Built from 3191517.
Generated Traceability
The traceability matrices are generated by the extension at build time and included in the site:
-
Use Cases → Requirements — Which requirements each use case leads to
-
Requirements → Architecture — Which architecture sections address each requirement
-
Requirements → Tests — Which tests verify each requirement
To regenerate after changing content, rebuild the site:
npx antora antora-playbook.yml
This produces 112 items, 118 relationships, and 0 validation errors across the content files.