Skip to content

Traceability.
Without leaving your docs.

A role-based traceability extension for Antora. One [item] macro. Your domain model. Every build populates a queryable traceability graph — matrices and coverage reports render from it, and the CLI, JSON snapshots, and Neo4j export answer questions no doc build can.

Get Started View Documentation GitHub

How It Works

Annotate your AsciiDoc, configure your domain model, and let Antora generate the traceability artifacts.

1

Write

Annotate .adoc files with [item] macros and relationship links — stays in your editor, stays in Git.

2

Configure

Define your roles and relations in traceability.yml. No rigid schema — your domain model, your rules.

3

Generate

Antora builds your site — automatically producing matrices, coverage reports, and Neo4j CSV exports.

Matrices Coverage Reports Neo4j Export Validation

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.
  • Graph-first, not render-only. The build produces a queryable graph — query it (impact, linked, siblings), diff it between versions, or export snapshots and process, matrix, validate — no doc build required.
  • Extensible roles. Define your own: requirement, architecture, test, risk — whatever your domain needs.
  • Shared ID allocation. A standalone allocator server hands out collision-free IDs across teams and branches — next-id requests them, seed bootstraps them.

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.
  • A graph you can leave the docs with. Neo4j export for advanced queries, impact analysis, and dashboards — the same traceability graph the docs render, in your analysis tool of choice.
  • 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 408 traceable items and 486 relationships.

The matrices below are one projection of the traceability graph — the same graph the CLI queries, the snapshot diff compares, and the Neo4j export analyzes.

Requirements → Architecture Traceability Matrix
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 ✓
This is a preview. The live matrix covers all 308 requirements with full interactivity. Explore the Full Matrix

Quick Start

Already have an Antora site? You're three steps away from full traceability.

Install the extension

npm install @antora-tracer/core --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 — 308 requirements tracked across architecture and tests with complete coverage.

573

Tests Passing

308

Requirements Tracked

486

Relationships

0

Validation Errors