Skip to content

Commit 116c236

Browse files
danbarrclaude
andauthored
Tighten docs-review skill severity to reduce review churn (#680)
Co-authored-by: Dan Barr <6922515+danbarr@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3d596b1 commit 116c236

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -141,14 +141,12 @@ Structure your review as:
141141
| Issue | Recommendation |
142142
| ----- | -------------- |
143143
| ... | ... |
144-
145-
## Inline Suggestions
146-
147-
[Note any specific line-level edits to suggest]
148144
```
149145

150146
## Severity Guidelines
151147

148+
Before including any finding, apply the **independent reviewer test**: would a different competent tech writer independently flag the same issue? If two phrasings are equally clear and correct, don't flag one as better. The goal is a stable review - running the skill twice on the same document should produce essentially the same findings.
149+
152150
**Primary issues** (address before merge):
153151

154152
- Accuracy: documented behavior contradicts CLI reference, API spec, or upstream source
@@ -159,17 +157,20 @@ Structure your review as:
159157
- Structure problems that harm navigation
160158
- Missing explanations for confusing design decisions
161159
- Significantly buried or redundant content
160+
- Grammatical errors (sentence fragments, missing articles, subject-verb disagreement)
162161

163-
**Secondary issues** (nice to have):
162+
**Secondary issues** (worth fixing but not blocking):
164163

165-
- Minor wording improvements
166-
- Small redundancies within a document
167-
- Style guide adherence
164+
- Wording that is genuinely confusing, ambiguous, or likely to mislead - not merely "could be rephrased"
165+
- Style guide violations (terminology, capitalization, voice)
166+
- Missing context that forces the reader to leave the page to understand a step
168167

169168
**Skip entirely**:
170169

171170
- Formatting/syntax (let linters handle this)
172-
- Subjective preferences without clear benefit
171+
- Style-neutral alternatives where the current version is clear (e.g., "this sentence could be split in two," "this transition could be cut," imperative vs. declarative phrasing)
172+
- Thin but useful sections - a short section that orients the reader is better than no section; don't flag brevity alone
173+
- Cosmetic rewording that doesn't change clarity or correctness
173174

174175
## Review Checklist
175176

0 commit comments

Comments
 (0)