How does this skill detect documentation hallucinations?

The skill uses specialized subagents to cross-reference specific claims in your docs—such as component counts, file paths, or service names—against the actual repository structure to find mismatches.

Does the Docs Check skill modify my documentation files?

No, this skill is non-destructive. It only reads your documentation and codebase to generate a health report and provide actionable recommendations.

Can it validate technical diagrams?

Yes, it validates Mermaid diagram syntax and verifies that the entities and relationships depicted in the diagrams actually exist within the current codebase.

How does the freshness check work?

It uses git history to compare the last modification date of a documentation file against the modification dates of the code it describes, flagging documents that have fallen behind.

Documentation Health Check

Name: Documentation Health Check
Author: mgiovani

bymgiovani

•

Learning & Documentation

Validates documentation accuracy, freshness, and quality by cross-referencing markdown files with the live codebase to eliminate hallucinations.

The Documentation Health Check skill provides an automated audit system for your project's documentation, ensuring that technical guides, ADRs, and diagrams remain perfectly synchronized with the source code. By deploying parallel subagents to cross-reference claims against the source of truth, it detects outdated instructions, broken links, and 'documentation hallucinations' where described features or components do not actually exist. It is an essential utility for maintaining high-quality onboarding materials and architectural records throughout rapid development cycles and major refactors.

Key Features

01Parallel document processing using subagents for deep, section-level verification

02Anti-hallucination detection that verifies documentation claims against actual code reality

03Actionable remediation reports providing specific commands to fix identified documentation gaps

04Git-aware freshness analysis that identifies stale docs updated less recently than related code

05Automated health scoring based on freshness, completeness, and formatting quality

062 GitHub stars

Use Cases

01Running a pre-release documentation sync to verify that new features are correctly reflected in guides

02Auditing technical documentation before onboarding new developers to ensure 100% accuracy

03Automating the detection of broken Mermaid diagram syntax and internal cross-references

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add mgiovani/cc-arsenal docs-check

For use in Claude.ai and ChatGPT

Download Skill