Connect requirements to documentation

What the check reads

The document-stage check counts documented_by targets. Missing links produce warnings, while missing documentation for assurance A or B requirements produces a failed result. Citations outside configured documentation.roots also fail unless an applicable per-citation override allows them. With no roots configured, any documented_by target counts. A workflow baseline with requirement fingerprints narrows the check to new or changed authored requirements; a full audit covers the wider inventory.

proof audit --check documentation_coverage

An illustrative case

Illustrative case: a requirement changes retry behavior, but the user guide still describes the previous retry policy. A missing documentation link makes the omission visible. Adding a link to the existing guide can satisfy coverage while leaving the explanation wrong. The reviewer must inspect and update the content as part of the change rather than treating the link itself as the repair.

Resolve the finding

1. Identify the reader who needs the requirement explained and the documentation that should carry that explanation. Update the real content, including relevant conditions and limits.
2. Add or refresh the documentation trace. If a citation falls outside documentation.roots, move the document, deliberately extend the configured roots, or record a justified per-citation override.
3. Rerun coverage in the intended scope. Inspect referenced content and path validity separately; check the full inventory when reviewing accumulated documentation debt.

What a clear result means

A clear result measures accepted trace links, not semantic agreement between prose and behavior. The coverage predicate can count stored citations without establishing that their content is accurate. A baseline-scoped pass also says less than a full audit. Do not infer regulatory compliance or complete user guidance from a coverage percentage.

Continue with one real issue

Documented claim verified · Acceptance criteria

Bring one finding, its requirement and the current evidence to scope a walkthrough of what your reviewer can establish and what still needs work.