Can it fix the documentation errors automatically?

While its primary purpose is validation and reporting, it provides specific fix suggestions that you can ask Claude to apply immediately to your markdown files.

How does it verify code examples?

It cross-references snippets with the actual codebase to ensure that the commands, parameters, and logic described match the current implementation.

Which file formats does it support?

It primarily supports Markdown (.md) and ReStructuredText (.rst) files, which cover the vast majority of modern software project documentation.

Does it check for broken external links?

Yes, it scans for broken links and also verifies that internal file paths mentioned in the documentation actually exist within your repository structure.

Can it check version numbers?

Yes, it compares version strings mentioned in your documentation against the primary version definitions in configuration files like package.json or pyproject.toml.

Documentation Validator

Name: Documentation Validator
Author: poindexter12

bypoindexter12

0•

内容管理

Ensures documentation files are complete, accurate, and perfectly synced with your codebase to prevent stale or misleading information.

The Documentation Validator is a specialized Claude Code skill designed to maintain high-quality project documentation by performing comprehensive audits across READMEs, API references, and CHANGELOGs. It automatically verifies that code examples are runnable, CLI commands are current, and file paths actually exist, preventing the 'stale docs' problem that plagues software projects. By cross-referencing documentation with the underlying source code, it helps developers identify missing sections like installation guides or troubleshooting tips, ensuring a seamless experience for users and contributors alike.

主要功能

010 GitHub stars

02Identifies broken links, missing file paths, and version mismatches

03Generates detailed reports with specific categorized suggestions for fixes

04Cross-references code snippets with actual source code implementation

05Validates installation steps, usage examples, and API references

06Audits documentation for grammar, spelling, and consistent formatting

使用场景

01Verifying documentation accuracy after a major code refactor or API change

02Performing a pre-release audit to ensure READMEs and CHANGELOGs are up to date

03Onboarding new contributors by ensuring setup instructions are functional

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add poindexter12/waypoint doc-validator

For use in Claude.ai and ChatGPT

Download Skill