Skip to content

Commit d7a894c

Browse files
danbarrclaude
andcommitted
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>
1 parent 0b55980 commit d7a894c

3 files changed

Lines changed: 57 additions & 10 deletions

File tree

.claude/skills/docs-review/SKILL.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ Perform critical editorial reviews as a tech writer / copyeditor, focusing on cl
1313
1. **Read the document(s) fully** before making observations
1414
2. **Check related documents** if reviewing changes to existing docs or new docs in a doc set
1515
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
2022

2123
## Primary Review Criteria
2224

@@ -62,6 +64,9 @@ Watch for these telltale signs of AI-generated docs that need human intervention
6264
| Repetitive content | Same info in multiple sections | Deduplicate; single source of truth |
6365
| Over-explaining | Verbose descriptions of obvious things | Trust the reader; cut aggressively |
6466
| 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 |
6570

6671
### Section Structure and Navigation
6772

@@ -82,7 +87,18 @@ The docs follow a product-area-based information architecture under `docs/toolhi
8287
- **Redundant phrasing**: "uses discovered mode to automatically discover" → "automatically discovers"
8388
- **Unexplained design decisions**: If something seems non-obvious (e.g., why a field is named counterintuitively), the doc should explain it
8489
- **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
86102

87103
### Accessibility and Formatting
88104

@@ -125,6 +141,8 @@ Structure your review as:
125141

126142
**Primary issues** (address before merge):
127143

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)
128146
- Information architecture: content in wrong document, cross-document duplication
129147
- Content placed in the wrong section (e.g., product-specific content in Concepts, integration content in a product section)
130148
- Missing "Next steps" section on how-to guides and tutorials
@@ -147,6 +165,9 @@ Structure your review as:
147165

148166
Before finalizing your review, verify:
149167

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?
150171
- [ ] Did you check related documents for duplication or misplaced content?
151172
- [ ] For new pages: did you check for sufficient inbound links from related pages (intros, overviews, feature lists)?
152173
- [ ] Did you verify content belongs in the right document?

AGENTS.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,15 @@ Not every section needs every phase. The Introduction is an explicit first sideb
141141
Every how-to guide and tutorial page must include:
142142

143143
- 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).
145145
- Cross-links to related content in other sections where relevant.
146146

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+
147153
## Review process
148154

149155
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.

STYLE-GUIDE.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,17 +164,37 @@ ensures readers always know what to expect and never hit dead ends.
164164

165165
Every page must have front matter with at least a `title` and `description`.
166166

167-
### Next steps
167+
### Closing sections
168168

169-
Every how-to guide and tutorial page ends with a `## Next steps` section
170-
containing 1-3 links to the next logical pages. These follow the journey phases:
171-
install, use, secure, operate, optimize. Example:
169+
Every how-to guide and tutorial page ends with closing sections in this order:
170+
171+
1. `## Next steps` (required) - 1-3 links to the next logical pages, following
172+
the journey phases: install, use, secure, operate, optimize.
173+
2. `## Related information` (optional) - links to background reading, reference
174+
docs, or external resources that don't represent a next action.
175+
3. `## Troubleshooting` (optional) - common issues and solutions, typically
176+
using collapsible `<details>` blocks.
177+
178+
Example:
172179

173180
```mdx
174181
## Next steps
175182

176183
- [Run MCP servers](./run-mcp-servers.mdx) to deploy your first server.
177184
- [Client configuration](./client-configuration.mdx) to connect your IDE.
185+
186+
## Related information
187+
188+
- [Understanding MCP](../concepts/mcp.mdx) for background on the protocol.
189+
190+
## Troubleshooting
191+
192+
<details>
193+
<summary>Server fails to start</summary>
194+
195+
Check that the container runtime is running...
196+
197+
</details>
178198
```
179199

180200
### Introduction pages

0 commit comments

Comments
 (0)