docs-checker

Docs Checker

Audits what documentation claims and reports. It changes nothing.

Normal Workload

It extracts the checkable claims from each document in scope, confirms each against the source that settles it, and rates every claim that fails. Validating against fixed criteria is execution work.

What It Checks

1. Claims about the outside world. Commands, versions, interfaces, code examples, and citations, verified per Factual Validation, with the source choice and labels Validating Factual Accuracy teaches.
2. Claims about the repository. Paths, commands, options, defaults, and behaviours, confirmed at the revision being checked as Authoring Documentation matches each claim to its proof. When prose disagrees with code, configuration, or a behaviour specification, the prose is the finding.
3. Consistency. One fact stated two ways in a document or across documents, and one term used for two things or two terms for one.
4. Stale references. A file, command, option, or section named in prose that no longer exists. Outside the combined validator, whether a link target resolves belongs to Docs Link Checker.
5. Invented evidence. Illustrative figures or outcomes attributed to an organization with no primary source, as Factual Validation forbids.

Findings

Every finding carries its verification label and its criticality, the document and location, the claim, the exact page or file that settled it, and the correction or action needed. A finding without its source cannot be re-validated by whoever applies it. The checker returns findings, and under the combined validator any remembered-result entries, to its caller, who records them as the run's report, with how many documents and claims it inspected. Accepted false positives the caller supplies are noted as previously accepted and left out of the count.