review_documentation - Production-grade documentation review and quality analysis
Analyzes documentation for clarity, accuracy, and structure, providing scores and actionable improvement suggestions.
/plugin marketplace add pluginagentmarketplace/custom-plugin-technical-writer/plugin install custom-plugin-technical-writer@pluginagentmarketplace-technical-writerUsage: /review-docs [--focus AREA] [--depth LEVEL] [--audience TARGET]
Arguments:
--focus comprehensive | clarity | accuracy | structure | accessibility | seo
--depth quick (5min) | standard (15min) | deep (30min)
--audience beginner | intermediate | advanced | non-technical
Examples:
/review-docs
/review-docs --focus clarity --depth deep
/review-docs --focus accessibility --audience beginner
interface ReviewDocsInput {
content: string; // Documentation to review
focus?: 'comprehensive' | 'clarity' | 'accuracy' | 'structure' | 'accessibility' | 'seo';
depth?: 'quick' | 'standard' | 'deep';
audience?: 'beginner' | 'intermediate' | 'advanced' | 'non-technical';
context?: {
product_name?: string;
doc_type?: string;
previous_issues?: string[];
};
}
interface ReviewDocsOutput {
status: 'pass' | 'pass_with_warnings' | 'fail';
exit_code: 0 | 1 | 2 | 3;
scores: {
clarity: number; // 0-100
completeness: number; // 0-100
accuracy: number; // 0-100
structure: number; // 0-100
accessibility: number; // 0-100
overall: number; // 0-100
};
issues: Issue[];
suggestions: Suggestion[];
summary: {
critical_count: number;
warning_count: number;
info_count: number;
};
}
interface Issue {
severity: 'critical' | 'warning' | 'info';
category: string;
message: string;
location?: string;
suggested_fix?: string;
}
| Focus Area | Checks | Priority |
|---|---|---|
clarity | Language, jargon, sentence length | High |
completeness | Missing sections, examples | High |
accuracy | Technical correctness, versions | Critical |
structure | Hierarchy, navigation, flow | Medium |
accessibility | Alt text, headings, contrast | Medium |
seo | Keywords, meta, links | Low |
| Level | Time | Coverage |
|---|---|---|
quick | 5 min | Major issues only |
standard | 15 min | Full analysis + suggestions |
deep | 30 min | Section-by-section + rewrites |
thresholds:
pass: overall >= 80
pass_with_warnings: overall >= 60
fail: overall < 60
scoring_weights:
clarity: 25%
completeness: 25%
accuracy: 20%
structure: 15%
accessibility: 15%
# Review Summary
status: pass_with_warnings
exit_code: 1
overall_score: 78/100
# Score Breakdown
scores:
clarity: 85
completeness: 72
accuracy: 90
structure: 75
accessibility: 68
# Issues Found
issues:
critical: 0
warnings: 5
info: 12
# Top 3 Priorities
priorities:
1: "Add examples to Authentication section"
2: "Simplify paragraph in 'Advanced Usage'"
3: "Add alt text to 3 images"
| Exit Code | Meaning | Action |
|---|---|---|
| 0 | Pass, no issues | Ready to publish |
| 1 | Pass with warnings | Review suggestions |
| 2 | Fail, critical issues | Must fix before publish |
| 3 | Invalid input | Check documentation format |
invokes_skills:
- user-guides (for readability analysis)
- api-documentation (for spec validation)
related_commands:
- /write-docs (create content)
- /generate-examples (fix code gaps)
- /api-template (validate specs)
Before Review:
After Review:
Check: Audience mismatch, missing examples
Solution: Specify correct --audience level
Solution: Split into smaller sections
Version: 2.0.0 | Exit Codes: 0-3 | Quality Gate: 80+
/review-docsReview documentation changes for writing standards, technical accuracy, frontmatter completeness, and style consistency. Use when the user asks to review changes, check if docs follow standards, or verify documentation quality.