doc-review

To fact-check documentation, identify factual claims and assess them against real-world behavior to ensure accuracy. This process validates examples, diagrams, and links, generating a structured, audit-ready report with prioritized todos for improvement.

Documentation verification is the process of confirming that documented claims align with actual capabilities. You need an audit report when validating READMEs, API docs, or tutorials to reduce the risk of spreading incorrect claims and ensure factual consistency.

Yes, you can verify links and examples in API docs and tutorials by assessing their accuracy and relevance against real-world behavior. This validation ensures that documented instructions and visual aids remain factually correct and consistent.

Generate a todo-based report by reviewing target documentation to identify factual discrepancies and improvement opportunities. The resulting structured report highlights issues with prioritized todos, providing an audit-ready output without suggesting inline code changes.

The best way to audit README files for factual consistency is to review them systematically, checking claims against real capabilities. This approach produces a prioritized todo list of factual discrepancies, ensuring documentation remains accurate and reliable without inline code changes.

Documentation fact-checking does not provide inline code changes. Instead, it produces a structured, todo-based report that highlights factual discrepancies and improvement opportunities, maintaining an audit-ready format for resolving issues.