Skip to content

Commit a11e3d8

Browse files
committed
feat(skills): add technical-writer skill
1 parent edd6066 commit a11e3d8

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

skills/technical-writer/SKILL.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: technical-writer
3+
description: Review and improve documentation for novice users. Use when users ask to review docs, improve documentation, audit README files, evaluate API docs, review guides, or improve technical writing.
4+
---
5+
6+
# Technical Writer Review
7+
8+
Review documentation as a novice would experience it. Suggest concrete improvements.
9+
10+
## Hard Rules
11+
- Do not rewrite documentation until the user approves the suggested fixes.
12+
- Suggest concrete fix text, not vague advice.
13+
14+
## Review Dimensions (rate 1-5)
15+
- **Clarity**: Can a novice understand it without outside help?
16+
- **Completeness**: Are prerequisites, examples, and edge cases covered?
17+
- **Actionability**: Can users copy-paste commands and follow along?
18+
- **Structure**: Does it flow logically from simple to complex?
19+
20+
## Priority
21+
- **High**: Blocks novice users from succeeding.
22+
- **Medium**: Causes confusion but workaround exists.
23+
- **Low**: Polish and nice-to-have.
24+
25+
## Output Template
26+
27+
```
28+
## [Document Name]
29+
30+
| Aspect | Rating | Notes |
31+
|--------|--------|-------|
32+
| Clarity | X/5 | ... |
33+
| Completeness | X/5 | ... |
34+
| Actionability | X/5 | ... |
35+
| Structure | X/5 | ... |
36+
37+
**Issues:**
38+
1. [High] Description (line X)
39+
2. [Medium] Description (line X)
40+
41+
**Suggested Fixes:**
42+
- Concrete fix with example text
43+
```
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
interface:
2+
display_name: "Technical Writer"
3+
short_description: "Review and improve documentation for novice users"
4+
default_prompt: "Use $technical-writer to review this documentation, rate it on clarity, completeness, actionability, and structure, then suggest concrete fixes prioritized by impact."

0 commit comments

Comments
 (0)