documentation-structure-validator
Validate documentation structure, check for missing sections, verify markdown syntax, ensure consistency with templates. Use when user mentions docs validation, structure check, README review, documentation quality, or wants to verify documentation completeness.
Best use case
documentation-structure-validator is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Validate documentation structure, check for missing sections, verify markdown syntax, ensure consistency with templates. Use when user mentions docs validation, structure check, README review, documentation quality, or wants to verify documentation completeness.
Teams using documentation-structure-validator should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/documentation-structure-validator/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How documentation-structure-validator Compares
| Feature / Agent | documentation-structure-validator | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Validate documentation structure, check for missing sections, verify markdown syntax, ensure consistency with templates. Use when user mentions docs validation, structure check, README review, documentation quality, or wants to verify documentation completeness.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Documentation Structure Validator Validate documentation files for completeness, structure, and consistency. ## Instructions 1. Identify the documentation type (README, ADR, API docs, guide) 2. Load the appropriate template from [templates.md](templates.md) 3. Check for required sections and common issues 4. Review markdown syntax and formatting 5. Generate a validation report with: - ✅ Passed checks - ⚠️ Warnings - ❌ Critical issues - 💡 Recommendations ## Validation Checklist ### README Files - [ ] Title/project name present - [ ] Description/purpose clear - [ ] Installation instructions - [ ] Usage examples - [ ] Configuration section (if applicable) - [ ] Contributing guidelines link - [ ] License information - [ ] Table of contents (for long READMEs) - [ ] Badges (optional but recommended) ### Architecture Decision Records (ADR) - [ ] Title with number (ADR-###) - [ ] Status (proposed/accepted/deprecated/superseded) - [ ] Context section - [ ] Decision section - [ ] Consequences section - [ ] Date - [ ] References/links ### API Documentation - [ ] Endpoint descriptions - [ ] Request/response examples - [ ] Authentication details - [ ] Error codes documentation - [ ] Rate limiting info - [ ] Versioning strategy ## Common Issues Refer to [validation-rules.md](validation-rules.md) for detailed rules and examples. ## Usage Examples ### Example 1: Validate README ``` User: "Check if the README is complete" Claude: *reads README.md, compares against template, generates report* ``` ### Example 2: Validate ADR ``` User: "Validate the architecture decision docs in /docs/decisions/" Claude: *validates each ADR file against ADR template* ``` ### Example 3: Batch validation ``` User: "Check all markdown files in /docs/" Claude: *scans all .md files, validates each based on type* ``` ## Output Format ```markdown # Documentation Validation Report **File**: path/to/file.md **Type**: README **Date**: YYYY-MM-DD ## Summary - Total checks: 15 - Passed: 12 ✅ - Warnings: 2 ⚠️ - Critical: 1 ❌ ## Critical Issues ❌ 1. Missing installation instructions ## Warnings ⚠️ 1. No contributing guidelines link 2. Code examples not syntax-highlighted ## Passed ✅ - Title present - Description clear - Usage examples included ... ## Recommendations 💡 1. Add badges for build status and license 2. Include table of contents for easier navigation 3. Add troubleshooting section ``` ## Tips - For templates, see [templates.md](templates.md) - For validation rules, see [validation-rules.md](validation-rules.md) - Always provide actionable feedback - Prioritize critical issues over style preferences - Link to examples when suggesting improvements
Related Skills
reviewing-documentation
Use when reviewing documentation quality, auditing README or CLAUDE.md files, or standardizing AI instruction files.
research-documentation
Searches across your Notion workspace, synthesizes findings from multiple pages, and creates comprehensive research documentation saved as new Notion pages. Trigger on "노션 검색", "조사해줘", "리서치 정리". For meeting prep use meeting-intelligence; for saving knowledge use knowledge-capture; for spec breakdown use spec-to-implementation.
quality-documentation-manager
Document control system management for medical device QMS. Covers document numbering, version control, change management, and 21 CFR Part 11 compliance. Use for document control procedures, change control workflow, document numbering, version management, electronic signature compliance, or regulatory documentation review.
documentation-templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
documentation-standards
Clear technical documentation with JSDoc, READMEs, Mermaid diagrams, ISMS policy references, and comprehensive code examples
documentation-specialist
文档专家。专注于技术文档编写、API 文档生成、README 优化和文档维护。提供清晰的文档结构、规范的格式和用户友好的内容。
documentation-research
Enforces documentation research before implementation. Auto-loads when implementing features to ensure current best practices are followed. Researches official docs first.
documentation
Technical writing, API docs, and documentation best practices
Documentation Hygiene
This skill should be used when the user asks to perform "documentation hygiene", "update docs for change", "mark historical docs", "add deprecation headers", "documentation migration", or when making significant changes that affect multiple documentation files (like license migrations, tier changes, or API changes).
documentation-guidelines
Write or update backend feature documentation that follows a repo's DOCUMENTATION_GUIDELINES.md (or equivalent) across any project. Use when asked to create/update module docs, API contracts, or backend documentation that must include architecture, endpoints, payloads, Mermaid diagrams, and seeding instructions.
documentation-generation-doc-generate
You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI...
doc-validator
Validate documentation files for completeness, accuracy, and consistency with the codebase. Use when user mentions "check documentation", "validate docs", "is the README up to date?", requests documentation review, says "docs are wrong" or "fix the docs", or is working on documentation improvements. Covers README files, API docs, CHANGELOG, and any markdown documentation.