doc-standards

Validate documentation adequacy by checking technical content against repository-owned contracts, audience requirements, and non-obvious constraints. This ensures accuracy and completeness during pull request assessments, preventing user misunderstanding and reducing maintenance risk.

Auditing a README and public API comments requires validating them against strict criteria including audience, action, and operational requirements. This contextual review ensures high-quality, maintainable documentation that correctly reflects updated code behavior.

Enforce strict documentation standards when stale or superficial documentation threatens operational stability. Apply these standards during pull request assessments and documentation audits to ensure technical content satisfies non-obvious contracts and protects maintainers from operational risks.

Yes, doc-standards provides specialized contextual review for READMEs, public API comments, and code docstrings. It validates all these documentation types against strict adequacy criteria to ensure correct placement and completeness across the repository.

Prevent stale documentation by applying an adequacy gate that validates technical content against repository-owned contracts during code reviews. This ensures new code changes are accompanied by documentation that accurately reflects updated behavior and non-obvious constraints.