Stats
Actions
Tags
Help us improve
Share bugs, ideas, or general feedback.
From deepwiki
Quality validation checklist for generated documentation pages. Covers content completeness, evidence backing, markdown syntax, diagram validation, and cross-reference consistency. Use before finalizing any documentation page.
npx claudepluginhub gravity9-tech/claude_code_marketplace_demo --plugin deepwikiHow this skill is triggered — by the user, by Claude, or both
Slash command
/deepwiki:documentation-quality-checklistThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Validation criteria for generated documentation pages. Run through this checklist before writing any page to disk.
Provides checklists, metrics, scoring, and grep-based detection patterns for auditing README, API, and architecture documentation quality.
Validates project documentation: lints formatting and naming, checks broken/orphan links, verifies glossary terms and synonyms, detects contradictions/gaps, audits completeness via /doc:lint, /doc:links, etc.
Validates documentation with type-specific checklists for tutorials/how-tos/references/explanations, six quality traits, and thresholds like Flesch 70-80 readability.
Share bugs, ideas, or general feedback.
Validation criteria for generated documentation pages. Run through this checklist before writing any page to disk.
[text](../../path/to/page.md)| Page Type | Target Range | Notes |
|---|---|---|
| Overview pages | 500-1000 | Concise, high-level |
| Architecture pages | 1000-2000 | Detailed with diagrams |
| Component/service pages | 800-1500 | Focused on single topic |
| Workflow pages | 600-1200 | Step-by-step with diagrams |
| Reference pages | 300-800 | Tables and lists |
For rapid checks, verify these critical items:
A page should NOT be written if:
Version: 1.0 Last Updated: 2026-01-22