Can it automatically fix the documentation?

The skill identifies mismatches and provides the 'Actual Code' reference, allowing Claude to suggest and apply documentation updates based on the findings.

Does this skill support languages other than PHP?

While the current patterns are optimized for PHP architectures (DDD, Clean Architecture), the verification logic can be adapted to other languages by adjusting the search patterns.

How does it handle complex method signatures?

It analyzes parameter types and counts, including specialized types like Value Objects, to ensure doc examples match the functional reality of the code.

What kind of documentation files can it scan?

It is designed to scan any Markdown (.md) files, including READMEs, API guides, and project wikis stored within the repository.

Documentation Example Verifier

Name: Documentation Example Verifier
Author: dykyi-roman

bydykyi-roman

•

Learning & Documentation

Audits and synchronizes documentation code blocks with actual source code to prevent outdated or broken examples.

The Documentation Example Verifier is a specialized Claude Code skill designed to maintain the integrity of project documentation by ensuring code snippets remain accurate as the codebase evolves. It automatically scans Markdown files for PHP code blocks and inline references, cross-referencing them with the actual implementation to detect mismatched class names, incorrect method signatures, outdated namespaces, and missing required parameters. By identifying deprecated APIs and providing severity-based reports, this skill helps teams eliminate the technical debt of 'broken' documentation, ensuring that tutorials and API references are always reliable for developers.

Key Features

01Severity-based reporting for critical vs. minor mismatches

0245 GitHub stars

03Automated class name and namespace verification

04Support for both Markdown code blocks and inline code references

05Detection of deprecated API usage in documentation

06Method signature and parameter count validation

Use Cases

01Verifying 'Quick Start' guides and tutorials during major architectural refactors

02Maintaining consistency between DDD domain entities and their documented usage

03Auditing API documentation accuracy before a new version release

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add dykyi-roman/awesome-claude-code check-doc-examples

For use in Claude.ai and ChatGPT

Download Skill