documentation-verification
CommunityEnsure docs meet quality standards.
Content & Communication#quality assurance#documentation#verification#code examples#link checking#pre-merge review
AuthorPracticalSwan
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the risk of merging documentation that is incomplete, contains broken links, has inaccurate code examples, or is factually incorrect, ensuring a higher quality of published content.
Core Features & Use Cases
- Link Validation: Automatically checks for broken internal and external links within Markdown files.
- Code Snippet Accuracy: Verifies that code examples are still relevant and functional.
- Completeness Check: Ensures that documentation changes align with user-facing behavior changes.
- Use Case: Before merging a pull request that updates API documentation, use this skill to automatically verify that all code examples still compile and all internal links point to existing pages.
Quick Start
Run the documentation verification skill to check all markdown links in the current directory.
Dependency Matrix
Required Modules
markdown-link-checklycheelinkchecker
Components
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: documentation-verification Download link: https://github.com/PracticalSwan/agent-skills/archive/main.zip#documentation-verification Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.