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
Copy file name to clipboardExpand all lines: .claude/skills/docs-review/SKILL.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -141,14 +141,12 @@ Structure your review as:
141
141
| Issue | Recommendation |
142
142
| ----- | -------------- |
143
143
| ... | ... |
144
-
145
-
## Inline Suggestions
146
-
147
-
[Note any specific line-level edits to suggest]
148
144
```
149
145
150
146
## Severity Guidelines
151
147
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
+
152
150
**Primary issues** (address before merge):
153
151
154
152
- Accuracy: documented behavior contradicts CLI reference, API spec, or upstream source
@@ -159,17 +157,20 @@ Structure your review as:
159
157
- Structure problems that harm navigation
160
158
- Missing explanations for confusing design decisions
-Missing context that forces the reader to leave the page to understand a step
168
167
169
168
**Skip entirely**:
170
169
171
170
- 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
0 commit comments