documentation-review

stacklok's avatarfrom stacklok

Reviews documentation for factual accuracy

⭐1.5kstars🔀166forks📁View on GitHub🕐Updated Jan 4, 2026
[Fact Checking]

When & Why to Use This Skill

This Claude skill is designed to enhance the integrity of technical documentation by performing rigorous factual accuracy reviews. It systematically audits claims against actual tool functionality, validates the health of internal and external links, and identifies formatting inconsistencies or typos. By generating a structured report of findings, it streamlines the quality assurance process for technical writers and developers, ensuring that documentation remains a reliable source of truth.

Use Cases

  • Technical Documentation Audit: Automatically verify that software manuals and API guides accurately reflect the current state of the product's features and functionality to prevent user confusion.
  • Link and Reference Validation: Scan complex documentation sets to ensure all internal file paths and external URLs are active and point to the correct, intended content.
  • Pre-release Quality Assurance: Fact-check marketing claims and technical examples against the actual codebase or tool behavior before a major product launch to maintain brand credibility.
  • Knowledge Base Maintenance: Periodically review existing help articles to identify outdated information or broken links as the product evolves.
namedoc-review
descriptionReviews documentation for factual accuracy

Generating Commit Messages

Instructions

  1. Read the documentation you are instructed to review
  2. Make sure that all claims about how toolhive works are accurate
  3. Make sure that all examples are based in how toolhive really works, check for formatting, typos and overall accuracy
  4. Make sure that all links point to existing files and the content of the links matches what it should

Fact-checking claims in the documentation

See CHECKING.md on instructions on how to check claims in the docs.

You have some examples on how to fact-check in EXAMPLES.md

Your report

  • Do not suggest inline changes
  • Present findings and put each into a todo list. The user will then go through them and review manually