Load manual verification results (review, inspection, analysis, demonstration) recorded as markdown with a user-supplied schema.
What’s in this folder#
12-review-documentation/
schema.yaml # schema for manual results
design-review-results.md # VR-001: design review for TEST-002 (pass)Manual results format#
Manual results are markdown files with attr blocks, just like requirements — but the schema declares result-specific attributes:
# schema.yaml
x-reqmd:
level: verify-results
required: [x-reqmd.outcome, x-reqmd.verifier, x-reqmd.verified-at]
properties:
x-reqmd.outcome:
type: string
enum: [pass, fail, skipped, inconclusive]
x-reqmd.verifier:
type: string
x-reqmd.evidence:
type: string
x-reqmd.verified-at:
type: stringEach result is a heading with an attr block. Result attributes are
tool-owned and namespaced under x-reqmd.*:
## VR-001: Boot Sequence Design Review Result
```attr
status: approved
x-reqmd.outcome: pass
x-reqmd.verifier: "A. Reviewer"
x-reqmd.evidence: minutes/2026-07-15-boot-review.md
x-reqmd.verified-at: "2026-07-15"
trace: [TEST-002]
```The trace attribute links the result to the measure it verifies. It may
also target a synthesized test case (TC:<case>) from a CTRF report loaded
in the same run, so a manual review result joins that case’s evidence.
Scaffold a results directory#
Use the built-in results preset:
reqmd init my-reviews/ --preset results --id-prefix VRThis creates schema.yaml + results.md with one example result.
Run checks with manual results#
reqmd check 02-trace-your-spec/ --results 12-review-documentation/Combine automated + manual results#
reqmd check 02-trace-your-spec/ \
--results 11-verification-results-ctrf/ \
--results 12-review-documentation/Both result sources are merged — if a measure has results from both CTRF and manual sources, the latest x-reqmd.verified-at wins per (measure, case).
Export with manual verdicts#
reqmd export html 02-trace-your-spec/ \
--results 12-review-documentation/ -o html-out/That’s it#
You’ve worked through the full reqmd workflow:
- Scaffold a project
- Build a traced V-model spec tree
- Export, preview, and diff it
- Run it in CI with version pins
- Load automated test results (CTRF)
- Load manual review results
For the full spec, see the README and AGENTS.md.
Where to look things up#
- The
resultspreset and--resultsflag:reqmd initandreqmd checkin the cheat sheet
What’s next#
The V-model is fully verified. Now extend reqmd to your own document types — go to Step 13.