Skip to content

Functional Requirement Traceability Report

Auto-generated by hwledger-traceability. To refresh, run:

bash
cargo run -p hwledger-traceability -- --markdown-out docs-site/quality/traceability.md

Summary

  • Total FRs/NFRs: 43
  • Fully Traced (test + impl + docs): 0 (0.0%)
  • Traced (test + partial): 43 (100.0%)
  • Doc-Only (docs but no test): 0 (0.0%)
  • Zero Coverage: 0 (0.0%)
  • Total Tests: 3270

Cross-Dimensional Traceability Matrix

FRTestsSourceADRsDocsJourneysLevel
FR-PLAN-00131800120PART
FR-PLAN-00218606120PART
FR-PLAN-00331806120PART
FR-PLAN-0044200120PART
FR-PLAN-0056000120PART
FR-PLAN-0061200120PART
FR-PLAN-0074800120PART
FR-TEL-001540660PART
FR-TEL-0021620060PART
FR-TEL-00360060PART
FR-TEL-004180060PART
FR-INF-001180660PART
FR-INF-002360660PART
FR-INF-0034320660PART
FR-INF-004900660PART
FR-INF-00560060PART
FR-FLEET-0011740660PART
FR-FLEET-002420660PART
FR-FLEET-003600660PART
FR-FLEET-004180660PART
FR-FLEET-005720660PART
FR-FLEET-006720660PART
FR-FLEET-007660060PART
FR-FLEET-008360060PART
FR-UI-001420660PART
FR-UI-002840660PART
FR-UI-003180660PART
FR-UI-00460060PART
FR-UX-VERIFY-001960060PART
FR-UX-VERIFY-002360060PART
FR-UX-VERIFY-003360060PART
FR-TRACE-00120010PART
FR-TRACE-00210010PART
FR-TRACE-00340010PART
FR-TRACE-00410010PART
NFR-00160060PART
NFR-00260060PART
NFR-00360060PART
NFR-004180060PART
NFR-00560060PART
NFR-0061560060PART
NFR-00760060PART
NFR-VERIFY-001180060PART

Best Covered (Top 5)

  • FR-INF-003 (tests: 432, impl: 0, docs: 6): Reuse oMlx's SSD-paged KV cache for agent-loop TTFT wins.
  • FR-PLAN-001 (tests: 318, impl: 0, docs: 12): Ingest model metadata from HF Hub, local GGUF, local safetensors, local MLX (.npz + config), Ollama, LM Studio catalog.
  • FR-PLAN-003 (tests: 318, impl: 0, docs: 12): Compute VRAM ≈ W + O + KV(seq, users) + Prefill(batch, seq) per §5 of PLAN.md. Formulas per architecture.
  • FR-PLAN-002 (tests: 186, impl: 0, docs: 12): Classify architecture into an AttentionKind variant: Mha, Gqa, Mqa, Mla, SlidingWindow, Ssm, Hybrid(Vec<Kind>), AttentionSink.
  • FR-FLEET-001 (tests: 174, impl: 0, docs: 6): Central hwledger-server daemon with mTLS, SQLite-backed ledger, axum routes.

Worst Covered (Bottom 5)

  • FR-TRACE-002 [PART] (tests: 1, impl: 0, docs: 1): Journey manifest scanner must walk docs-site/public/{cli,gui,streamlit}-journeys/**/manifest.verified.json, skipping missing directories with a warning rather than panicking.
  • FR-TRACE-004 [PART] (tests: 1, impl: 0, docs: 1): Traceability markdown report must emit a ## Journey coverage section with a table FR | kind | journey id | score | passed.
  • FR-TRACE-001 [PART] (tests: 2, impl: 0, docs: 1): PRD parser must accept inline [journey_kind: cli|gui|web] tags (comma-separated) on FR header lines and expose the parsed kinds on the FR record.
  • FR-TRACE-003 [PART] (tests: 4, impl: 0, docs: 1): Traceability gate must FAIL (non-zero exit) when an FR tagged with a journey_kind has no verified journey whose traces_to cites it, or when a journey cites a non-existent FR (orphan), or when a journey's verification.passed == false / overall_score < 0.7.
  • FR-TEL-003 [PART] (tests: 6, impl: 0, docs: 6): Predicted-vs-actual reconciliation panel on the Planner screen.

Coverage by Section

2.5 Desktop GUI (macOS MVP) (0/4)

  • [PART] FR-UI-001 (T:42, I:0, D:6)
  • [PART] FR-UI-002 (T:84, I:0, D:6)
  • [PART] FR-UI-003 (T:18, I:0, D:6)
  • [PART] FR-UI-004 (T:6, I:0, D:6)

2.1 Capacity planner (0/7)

  • [PART] FR-PLAN-001 (T:318, I:0, D:12)
  • [PART] FR-PLAN-002 (T:186, I:0, D:12)
  • [PART] FR-PLAN-003 (T:318, I:0, D:12)
  • [PART] FR-PLAN-004 (T:42, I:0, D:12)
  • [PART] FR-PLAN-005 (T:60, I:0, D:12)
  • [PART] FR-PLAN-006 (T:12, I:0, D:12)
  • [PART] FR-PLAN-007 (T:48, I:0, D:12)

2.4 Fleet ledger (0/8)

  • [PART] FR-FLEET-001 (T:174, I:0, D:6)
  • [PART] FR-FLEET-002 (T:42, I:0, D:6)
  • [PART] FR-FLEET-003 (T:60, I:0, D:6)
  • [PART] FR-FLEET-004 (T:18, I:0, D:6)
  • [PART] FR-FLEET-005 (T:72, I:0, D:6)
  • [PART] FR-FLEET-006 (T:72, I:0, D:6)
  • [PART] FR-FLEET-007 (T:66, I:0, D:6)
  • [PART] FR-FLEET-008 (T:36, I:0, D:6)

2.3 Inference runtime (MVP: macOS only) (0/5)

  • [PART] FR-INF-001 (T:18, I:0, D:6)
  • [PART] FR-INF-002 (T:36, I:0, D:6)
  • [PART] FR-INF-003 (T:432, I:0, D:6)
  • [PART] FR-INF-004 (T:90, I:0, D:6)
  • [PART] FR-INF-005 (T:6, I:0, D:6)

2.6 User-journey verification (WP27: Blackbox screenshot verification) (0/3)

  • [PART] FR-UX-VERIFY-001 (T:96, I:0, D:6)
  • [PART] FR-UX-VERIFY-002 (T:36, I:0, D:6)
  • [PART] FR-UX-VERIFY-003 (T:36, I:0, D:6)

2.2 Live telemetry (0/4)

  • [PART] FR-TEL-001 (T:54, I:0, D:6)
  • [PART] FR-TEL-002 (T:162, I:0, D:6)
  • [PART] FR-TEL-003 (T:6, I:0, D:6)
  • [PART] FR-TEL-004 (T:18, I:0, D:6)

2.7 Traceability extensions (journey coverage) (0/4)

  • [PART] FR-TRACE-001 (T:2, I:0, D:1)
  • [PART] FR-TRACE-002 (T:1, I:0, D:1)
  • [PART] FR-TRACE-003 (T:4, I:0, D:1)
  • [PART] FR-TRACE-004 (T:1, I:0, D:1)

3. Non-functional requirements (0/8)

  • [PART] NFR-001 (T:6, I:0, D:6)
  • [PART] NFR-002 (T:6, I:0, D:6)
  • [PART] NFR-003 (T:6, I:0, D:6)
  • [PART] NFR-004 (T:18, I:0, D:6)
  • [PART] NFR-005 (T:6, I:0, D:6)
  • [PART] NFR-006 (T:156, I:0, D:6)
  • [PART] NFR-007 (T:6, I:0, D:6)
  • [PART] NFR-VERIFY-001 (T:18, I:0, D:6)

Journey coverage

FRkindjourney idscorepassedstatus
FR-PLAN-001clicli-ingest-error0.92yesOK
FR-PLAN-003clicli-plan-help0.92yesOK
FR-TEL-001clicli-probe-list0.92yesOK
FR-TEL-002clicli-probe-list0.92yesOK
FR-UI-001guiplanner-gui-launch0.90yesOK

Released under the Apache 2.0 License.