Skip to content

Specification — wf-03-01

US-03-01-02 — Export Trace Matrices

As a QA engineer, I want to export a trace matrix, so that I can analyze relationships such as REQ×Test and US×REQ in tabular form.

REQ-03-01-02-01 — Export Trace Matrices as CSV

When arqix trace matrix runs, arqix SHALL export the selected matrix as CSV.

Coverage: verified.

REQ-03-01-02-02 — Support REQ-Test and US-REQ Matrices

The arqix CLI SHALL support at least the REQ×Test and US×REQ matrix types.

Coverage: uncovered.

REQ-03-01-02-03 — Keep CSV Headers and Row Model Stable

The exported CSV SHALL use stable headers and a deterministic row model for each supported matrix type.

Coverage: uncovered.

Empty-link cases SHOULD remain visible in the exported matrix in a reviewer-friendly form.

Coverage: verified.

US-03-01-04 — Export Scoped Evidence Bundles for Quality Review

As a QA engineer, I want to generate a scoped evidence bundle for selected requirements or stories, so that I can review traceability gaps and verification evidence reproducibly.

REQ-03-01-04-01 — Export Evidence Bundles by ID Scope

When an evidence bundle export is invoked with one or more requirement or story IDs, arqix SHALL export a bundle scoped to those IDs.

Coverage: verified.

REQ-03-01-04-02 — Include Linked Evidence in Bundles

The exported bundle SHALL include the linked requirements, stories, diagnostics, and trace outputs relevant to the chosen scope.

Coverage: verified.

REQ-03-01-04-03 — Keep Bundles Reviewable without Reshaping

The exported bundle SHOULD be reviewable without manual reshaping of the source evidence.

Coverage: verified.

US-03-01-05 — Scan Traceability Information

As a QA engineer, I want to scan traceability information, so that a graph of documentation, code, and test references can be built and analysed objectively.

REQ-00-00-00-03 — Machine-Readable Diagnostics

When arqix emits a diagnostic, arqix SHALL provide it in a documented machine-readable format.

Coverage: verified.

REQ-00-00-00-06 — Effective Configuration as Baseline

The arqix CLI SHALL resolve every command against the effective configuration.

Coverage: verified.

REQ-03-01-05-01 — Detect Trace Markers in Rust Comments

When arqix trace scan runs, arqix SHALL detect configurable trace markers in Rust comments.

Coverage: verified.

REQ-03-01-05-02 — Detect Trace Markers in Markdown Comments

When arqix trace scan runs, arqix SHALL detect trace markers in Markdown HTML comments.

Coverage: uncovered.

When arqix trace scan runs, arqix SHALL read unit frontmatter links such as requirements, stories, ADRs, and refs.

Coverage: uncovered.

REQ-03-01-05-04 — Output Trace Graph as JSON

When arqix trace scan completes, arqix SHALL output a graph of nodes and edges as JSON.

Coverage: verified.

US-03-01-06 — Detect Missing Trace Markers for Quality Gaps

As a QA engineer, I want arqix to detect missing implements and verifies markers for a given requirement, so that structural traceability gaps can be identified objectively before review or audit.

REQ-00-00-00-03 — Machine-Readable Diagnostics

When arqix emits a diagnostic, arqix SHALL provide it in a documented machine-readable format.

Coverage: verified.

REQ-03-01-06-01 — Report Implements Markers per Requirement

When arqix trace check is invoked for a requirement, arqix SHALL report whether implements markers exist for it.

Coverage: uncovered.

REQ-03-01-06-02 — Report Verifies Markers per Requirement

When arqix trace check is invoked for a requirement, arqix SHALL report whether verifies markers exist for it.

Coverage: verified.

REQ-03-01-06-03 — Locate Existing Markers with Context

The trace check report SHALL include the locations of existing markers with path and line context.

Coverage: uncovered.

REQ-03-01-06-04 — Gate Test Functions for Trace Markers

When arqix trace markers runs, arqix SHALL report every test function without a verifies or plans marker or a no-requirement annotation, every marker not resolving to an existing requirement, every ignored test whose reason does not name a known owning story, and every derived-from without its has-requirement backlink.

Coverage: verified.

US-03-01-07 — Filter Traceability Reports for Quality Analysis

As a QA engineer, I want filtered traceability report views, so that I can focus on relevant structural gaps and assign fixes without manually reshaping exports.

REQ-03-01-07-01 — Filter Trace and Coverage Reports

When a trace or coverage report is generated, arqix SHALL support filtering by document kind, status, and missing-link category.

Coverage: uncovered.

Each report finding SHALL link back to the originating document or file location.

Coverage: uncovered.

US-03-01-08 — Make Trace and Coverage Outputs Reproducible

As a QA engineer, I want trace graphs, matrices, and coverage reports to be deterministic, so that repeated runs produce reproducible quality evidence and reviewer-friendly comparisons.

REQ-00-00-00-03 — Machine-Readable Diagnostics

When arqix emits a diagnostic, arqix SHALL provide it in a documented machine-readable format.

Coverage: verified.

REQ-00-00-00-06 — Effective Configuration as Baseline

The arqix CLI SHALL resolve every command against the effective configuration.

Coverage: verified.

US-03-01-09 — Machine-Check the Done Claim

As a QA engineer, I want a story marked done to be provably done, so that lifecycle states are claims the gate checks instead of hopes.

REQ-03-01-09-01 — Check the Done Claim against Active Tests

When a story declares lifecycle-status: done, arqix SHALL report an error for each of its requirements that no active test verifies.

Coverage: verified.

REQ-03-01-09-02 — Validate the Lifecycle Vocabulary

When a document declares a lifecycle-status outside the controlled vocabulary for its document nature, arqix SHALL report a frontmatter error.

Coverage: verified.

US-03-01-10 — Track Planned and Executed Test Evidence

As an assessor, I want planned tests to be claimable in any language and executed test outcomes to join the trace graph, so that "verified" reflects a green test rather than the mere existence of a claim — also in teams that do not work test-driven.

REQ-03-01-10-01 — Claim Planned Tests with a Language-Neutral Marker

When arqix trace scan detects an arqix:plans marker, arqix SHALL record the claimed requirement as planned.

Coverage: verified.

REQ-03-01-10-02 — Join Test Outcomes by Test Name

When arqix trace coverage is invoked with a test-results report, arqix SHALL join the report's test outcomes to the verifying markers by test name.

Coverage: verified.

REQ-03-01-10-03 — Demote Failed or Skipped Claims

Where a joined test outcome is failed or skipped, the corresponding verifying claim SHALL NOT count as verified.

Coverage: verified.

US-03-01-11 — Keep Verified Status Current

As an assessor, I want a marker flagged as possibly stale when the requirement it verifies changed after the verifying test, so that a green "verified" reflects the current requirement and not a historical marker placement.

REQ-03-01-11-01 — Detect Stale Trace Markers

When arqix trace freshness finds an active marker whose target requirement changed in version control after the marker's own file, arqix SHALL report the marker as possibly stale.

Coverage: verified.

REQ-03-01-11-02 — Degrade Gracefully Without Version Control

If arqix trace freshness cannot read version-control history for a marker or its target, then arqix SHALL NOT report the marker as stale.

Coverage: verified.

REQ-03-01-11-03 — Report Freshness in the Verification Loop

Where the verification loop runs the freshness sub-step, arqix verify SHALL report stale markers without failing the loop.

Coverage: verified.