Specification — wf-06-01¶
US-06-01-02 — Trace Document Assembly Structure¶
As an architect, I want a machine-readable log during assembly, so that I can trace how modular documents are composed from includes and outputs.
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-04-01-01-02 — Write JSONL Log during Assembly¶
When arqix assemble build runs, arqix SHALL write a JSONL log during assembly.
Coverage: verified.
REQ-04-01-01-03 — Configure Assembly Log Path¶
The assembly log path SHALL be configurable.
Coverage: uncovered.
REQ-04-01-01-04 — Emit One Record per Assembly Step¶
When an assembly step executes, arqix SHALL emit exactly one stable JSONL record for it.
Coverage: uncovered.
REQ-04-01-01-05 — Carry Required Fields in Log Records¶
Each assembly log record SHALL contain at least doc, chapter_id, out, include, sha256, bytes, and at_line.
Coverage: uncovered.
REQ-06-01-02-01 — Make Assembly Reviewable from the Log¶
The assembly log SHOULD allow document composition to be reviewed without inferring hidden assembly steps.
Coverage: verified.
US-06-01-04 — Compose Modular Documents with Chapter and Include Directives¶
As an architect, I want to use chapter and include directives in Markdown, so that architecture documentation can be composed modularly and assembled into coherent larger documents.
REQ-00-00-00-06 — Effective Configuration as Baseline¶
The arqix CLI SHALL resolve every command against the effective configuration.
Coverage: verified.
US-06-01-06 — Create Linked Translation Documents for Architecture Content¶
As an architect, I want to create a translation document by referencing its source document ID, so that ADRs and other architecture artefacts can be translated with correct structure and linkage from the start.
REQ-00-00-00-09 — Dry-Run Support¶
Where a command creates or modifies files, the command SHALL support a dry-run mode that reports planned changes without writing.
Coverage: verified.
US-06-01-08 — Assemble Modular Document Packages into Pages¶
As an architect, I want to assemble a doc package into pages, so that publishable chapters are produced from units.
REQ-00-00-00-06 — Effective Configuration as Baseline¶
The arqix CLI SHALL resolve every command against the effective configuration.
Coverage: verified.
US-06-01-09 — Retrieve Architecture Documentation Quickly¶
As an architect, I want to search and read documentation, so that I can quickly retrieve architecture decisions, glossary terms, and handbook content while maintaining the documentation narrative.
REQ-00-00-00-11 — Fast Documentation Retrieval¶
Search and read commands SHOULD return results within one second on a repository of one thousand documents.
Coverage: verified.