You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Strengthen docs-review skill with accuracy and discoverability checks
Add accuracy verification (cross-check against CLI refs, API specs),
reader walkthrough guidance, inbound link coverage for new pages,
and LLM-specific patterns (hedged lists, placeholder examples, features
without context). Codify the closing section order (Next steps >
Related information > Troubleshooting) in AGENTS.md and STYLE-GUIDE.md.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: .claude/skills/docs-review/SKILL.md
+26-5Lines changed: 26 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,10 +13,12 @@ Perform critical editorial reviews as a tech writer / copyeditor, focusing on cl
13
13
1.**Read the document(s) fully** before making observations
14
14
2.**Check related documents** if reviewing changes to existing docs or new docs in a doc set
15
15
3.**Check for a project style guide** (STYLE-GUIDE.md, CLAUDE.md, or similar)
16
-
4.**Assess information architecture** - document placement, scope, cross-document duplication
17
-
5.**Assess overall structure** - TOC length, information flow, Diataxis alignment
18
-
6.**Identify specific issues** with concrete examples and line numbers
19
-
7.**Provide actionable recommendations** - not just problems, but solutions
16
+
4.**Verify claims against authoritative sources** - cross-check documented behavior against CLI reference docs, API specs, auto-generated references, and upstream specifications. Note: docs may be drafted ahead of a release, so auto-generated references may lag behind - flag contradictions, not just absences
17
+
5.**Walk through as the reader** - mentally follow the page as a user doing the task for the first time. Are prerequisites complete? Can you follow each step in order? Would you have the knowledge needed at each point, or does the page assume something it hasn't established?
18
+
6.**Assess information architecture** - document placement, scope, cross-document duplication
19
+
7.**Assess overall structure** - TOC length, information flow, Diataxis alignment
20
+
8.**Identify specific issues** with concrete examples and line numbers
21
+
9.**Provide actionable recommendations** - not just problems, but solutions
20
22
21
23
## Primary Review Criteria
22
24
@@ -62,6 +64,9 @@ Watch for these telltale signs of AI-generated docs that need human intervention
62
64
| Repetitive content | Same info in multiple sections | Deduplicate; single source of truth |
63
65
| Over-explaining | Verbose descriptions of obvious things | Trust the reader; cut aggressively |
64
66
| Hedging language | "may," "might," "could potentially" | Be direct or remove |
67
+
| Hedged lists | "such as," "including," "clients include" when listing supported items | Be definitive: state the full list, or link to a canonical reference |
68
+
| Placeholder examples |`my-skill`, `example-org`, `my-app` instead of real values | Use real, working examples from the actual product |
69
+
| Features without context | Introduces a flag/option without explaining why a reader would use it | Explain the user benefit and how it connects to concepts the reader already knows |
65
70
66
71
### Section Structure and Navigation
67
72
@@ -82,7 +87,18 @@ The docs follow a product-area-based information architecture under `docs/toolhi
-**Unexplained design decisions**: If something seems non-obvious (e.g., why a field is named counterintuitively), the doc should explain it
84
89
-**Inconsistent terminology**: Pick one term and use it consistently throughout
85
-
-**Missing cross-references**: Related docs should link to each other
90
+
-**Ambiguous product terms**: When a product has components with overlapping names (e.g., "Registry" could mean a built-in registry or a Registry Server instance), docs must disambiguate. Readers at different points in their journey have different mental models
91
+
-**Prerequisites lacking operational context**: Don't just say "X must be running" - explain practical implications (is it a blocking command that needs a separate terminal? does it need to stay running persistently, or only during specific operations?)
92
+
-**Missing cross-references**: Related docs should link to each other. When a how-to page lists supported items (clients, platforms, etc.), link to the canonical reference rather than maintaining an inline list that can drift
93
+
94
+
### Accuracy and Trustworthiness
95
+
96
+
Docs that readers can't trust are worse than no docs. Actively verify:
97
+
98
+
-**Cross-check against reference material**: Does the prose contradict the auto-generated CLI reference, the API spec, or the upstream project's docs? Flag contradictions. Note: docs are often drafted before a release, so auto-generated references may not yet include new features - absence from the reference is not the same as a contradiction. But if an existing reference explicitly describes different behavior (e.g., "by name or OCI reference" when the prose also claims Git support), that's a real conflict to flag
99
+
-**Code examples must work**: Could a reader copy-paste this and get the described result? Check for correct syntax, realistic flag combinations, and valid argument values. Placeholder examples (`my-skill`, `example.com`) should be replaced with real, working values wherever possible
100
+
-**Feature coverage completeness**: When documenting a new feature, check that the full surface area is covered. Are all subcommands/endpoints mentioned? Are common error states addressed? A how-to that covers the happy path but ignores the most likely failure mode will generate support questions
101
+
-**Consistency across the doc set**: Do the same terms, flag names, and behaviors described here match how they're described in related pages? Cross-document inconsistencies (e.g., one page says "space-delimited," another uses comma-separated) erode trust
86
102
87
103
### Accessibility and Formatting
88
104
@@ -125,6 +141,8 @@ Structure your review as:
125
141
126
142
**Primary issues** (address before merge):
127
143
144
+
- Accuracy: documented behavior contradicts CLI reference, API spec, or upstream source
145
+
- Accuracy: code examples that won't work if copy-pasted (wrong syntax, nonexistent flags, invalid arguments)
128
146
- Information architecture: content in wrong document, cross-document duplication
129
147
- Content placed in the wrong section (e.g., product-specific content in Concepts, integration content in a product section)
130
148
- Missing "Next steps" section on how-to guides and tutorials
@@ -147,6 +165,9 @@ Structure your review as:
147
165
148
166
Before finalizing your review, verify:
149
167
168
+
-[ ] Did you cross-check documented behavior against CLI references, API specs, and upstream sources?
169
+
-[ ] Did you walk through the page as a first-time user - can you follow every step in order?
170
+
-[ ] Did you verify code examples use correct syntax, valid flags, and real values?
150
171
-[ ] Did you check related documents for duplication or misplaced content?
151
172
-[ ] For new pages: did you check for sufficient inbound links from related pages (intros, overviews, feature lists)?
152
173
-[ ] Did you verify content belongs in the right document?
Copy file name to clipboardExpand all lines: AGENTS.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -141,9 +141,15 @@ Not every section needs every phase. The Introduction is an explicit first sideb
141
141
Every how-to guide and tutorial page must include:
142
142
143
143
- Front matter with `title` and `description`.
144
-
- A "Next steps" section at the end with 1-3 links to the next logical pages, following the journey phases (install, use, secure, operate, optimize).
144
+
- A "Next steps" section with 1-3 links to the next logical pages, following the journey phases (install, use, secure, operate, optimize).
145
145
- Cross-links to related content in other sections where relevant.
146
146
147
+
Pages that include closing sections must use this ordering:
148
+
149
+
1.**Next steps** (required for how-to guides and tutorials)
150
+
2.**Related information** (if applicable)
151
+
3.**Troubleshooting** (if applicable)
152
+
147
153
## Review process
148
154
149
155
When you are asked to review documentation changes, you are a subject matter expert (SME) for the content and a technical writer. Your role is to ensure that the content is accurate, clear, and consistent with the project's goals and standards.
0 commit comments