Traceability.
Without leaving your docs.
A role-based traceability extension for Antora. One [item] macro.
Your domain model. Matrices, coverage reports, and Neo4j exports โ generated from your AsciiDoc, driven by your config.
How It Works
Annotate your AsciiDoc, configure your domain model, and let Antora generate the traceability artifacts.
Write
Annotate .adoc files with [item] macros and relationship links โ stays in your editor, stays in Git.
Configure
Define your roles and relations in traceability.yml. No rigid schema โ your domain model, your rules.
Generate
Antora builds your site โ automatically producing matrices, coverage reports, and Neo4j CSV exports.
Built for the Whole Team
antora-tracer bridges the gap between docs-as-code developers and compliance-focused requirements engineers.
For Developers & Architects
-
Git-native. Traceability data lives alongside your docs โ versioned, reviewed, merged.
-
CI/CD integrated. Matrices and validation run in your pipeline โ traceability gates, not afterthoughts.
-
CLI + API. Scriptable
process,matrix,validate,exportโ fits into any workflow. -
Extensible roles. Define your own:
requirement,architecture,test,riskโ whatever your domain needs.
For REs & Project Managers
-
Visual traceability. Color-coded HTML matrices show coverage at a glance โ every requirement, every relationship.
-
Coverage at a glance. Instantly see which requirements are addressed, which have gaps, and where orphans exist.
-
Neo4j export. Export to Neo4j for advanced graph queries, impact analysis, and custom dashboards.
-
Compliance evidence. Generated matrices and coverage reports serve as audit artifacts โ traceability is always current because it's built from source.
See Traceability in Action
The project documents itself with antora-tracer. Explore the live traceability matrices generated from 36 requirements, 82 relationships, and zero validation errors.
| Requirement | System Context | Building Block | Runtime View | Deployment |
|---|---|---|---|---|
| REQ-001: Extension registration | ✓ | ✓ | ✓ | |
| REQ-002: Document parsing | ✓ | ✓ | ||
| REQ-003: Graph construction | ✓ | |||
| REQ-004: Matrix generation | ✓ | |||
| REQ-005: Neo4j export | ✓ |
Quick Start
Already have an Antora site? You're three steps away from full traceability.
Install the extension
npm install antora-tracer --save-dev
Configure your domain model
Define roles and relations that match your domain โ not ours. Built-in presets get you started.
roles:
- id: requirement
label: Requirement
- id: architecture
label: Architecture Decision
relations:
- id: addresses
label: addresses
from: architecture
to: requirement
Annotate and build
Add [item] macros to your AsciiDoc files. Matrices, coverage reports, and exports appear automatically in your site.
[#REQ-001, item, role=requirement, title="User Authentication"]
The system SHALL authenticate users via OAuth 2.0.
[#ARCH-001, item, role=architecture, title="Auth Module"]
addresses:REQ-001[]
The authentication module implements the OAuth 2.0 Authorization Code flow.
By the Numbers
The project traces itself โ 36 requirements tracked across architecture and tests with complete coverage.
Tests Passing
Requirements Tracked
Relationships
Validation Errors