Topic · documented claim verified

Documented claim verified

Gist

A documented claim is a named promise in a man page, godoc, or docstring, bound to a symbol and a verify_by cell. Proof runs proof audit --check documented_claim_verified. A Sphinx percent is not that cell. Jama still authors.

proof audit --check documented_claim_verified

Keep Sphinx if you already score docstring coverage. Keep Compodoc if you already score Angular. Keep Jama if you author shalls. None of them ask whether the comma-parse sentence in the man page still has a path, a symbol, and evidence.

Request demo Last Sphinx percent vs this cell

01 · The sentence nobody bound

The man page promised left-to-right. The inventory never named that sentence.

You can keep a green docstring bar and still have no cell that says which function enforces the claim, or which file the auditor should open.

Documentation coverage asks whether a requirement has a documented_by path at all. This hop is one step later. Authors name each claim under documented_behaviors: on the requirement YAML: the sentence from the docs, the repo path, the implementing symbol, and a verify_by kind (signal_present, test_reference, or manual_review). Proof does not scrape godoc. The check WARNs when a declared cell is incomplete or its evidence path is missing.

No documented_behaviors on any active requirement, and the check skips. Once any claim is declared, every cell has to pass the evidence-presence bar. The hop does not yet fire the signal rule against the symbol. Completing the cell still makes the promise auditable. The inventory hop stays on documentation coverage.

documented_behaviors:
  - id: auth_users_comma_parsing
    claim: "comma-separated values are parsed left-to-right"
    documented_in: docs/man/auth-users.5
    implementing_symbol: ParseAuthUsers
    verify_by: signal_present
    signal_id: go.parsing.comma-split

Fill the missing fields. Create or fix the path for documented_in / test_ref. Lengthen review_note when using manual_review (sixteen characters). Then re-run the check. Do not delete the list to skip the stamp. An empty list is not verified. It is a skipped hop.

02 · The exhibit

Same man page. A percent, or this cell.

ParseAuthUsers still exists. Click the tabs.

Docstring bar

Ask did Sphinx report 100%
File docs/man/auth-users.5 exists
Why the percent counts symbols, not named claims

Stamp green

This hop

No documented_behaviors JSON. Claim, path, symbol, and verify_by never ran.

No stamp

Docstring bar

Keep Sphinx. Keep the man page. That is not this hop.

Keep the percent

Proof

Ask is the named claim complete and grounded
Out auth_users_comma_parsing: documented_in missing, no verify_by

Cell incomplete

Same man page. A percent, or this cell. Click the tabs.

Surface	What they do	What Proof does	What we lose
Sphinx / Compodoc	A percent of documented symbols.	A named claim cell on a requirement, with a path and a symbol.	We do not score comments. We do not extract free-text promises from godoc.
Documentation coverage	Does the requirement have a `documented_by` path.	Once a claim is declared, every cell has evidence on disk.	Not that hop. See documentation coverage.
Signal / test	The rule or the test exists somewhere.	The cell names `signal_id` or `test_ref` and the path exists.	The check does not yet execute the signal against the symbol.
Jama	The authoring programme. Reviews if you put them there.	Warn the merge when a declared claim cell is incomplete.	Not Jama's V&V. Jama still authors. We have not run a frozen Jama pack.

The teaching graph is still one requirement next to one man-page sentence. Name the claim. Bind the path and the symbol. Fill verify_by. Re-run the check. Do not empty the list to clear the stamp.

proof audit --check documented_claim_verified --verbose
proof help documentation_coverage
proof req edit SYS-REQ-001

The inventory hop stays on documentation coverage. Jama still authors. Proof vs Jama.

03 · The honest loss

Proof names a missing cell. It does not extract the man page.

A green documented_claim_verified is evidence presence on declared cells. It is not a proof of the Go. Jama still authors.

The check skips when no active requirement declares documented_behaviors. That skip is not clean. It is out of this hop. Default severity is warning; under fail-level warn a warning still blocks advancement. The hop does not rewrite the shall. It does not fire the signal against ParseAuthUsers. A sixteen-character review note is not a proof of the function. We have not scored this graph against a frozen Jama pack or a second human's V&V judgment. The loss is named, not scored.

The inventory hop stays on documentation coverage. The engagement stays on software correctness audit. Jama still authors.

Request demo How the install is bought

04 · Nearby questions

What people type next.

What is documented claim verified? Same question. Same URL.

Claim verified and found correct? Same hop. The cell is complete and grounded, or the audit warns. It is not a certificate stamp.

Is this documentation coverage? No. That hop is whether a requirement has a documented_by path. This hop is whether each named claim has a path, a symbol, and evidence. See documentation coverage.

Is this Sphinx or Compodoc? No. Those still own the docstring percent. Proof does not extract free-text promises from godoc.

Is Proof a Jama alternative for the shall? No. Jama still authors. Proof vs Jama.