Claude Cursor Skill

technical-writer

AI DevKit · 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.

LLM Mart · 0 points · 0 0 0

Virus-scanned Reviewed automatically before listing.

Full trust report

Download codeaholicguy-ai-devkit-skills_technical-writer-ac73d58.zip · 1 KB

codeaholicguy/ai-devkit 1639 257 forks Apache-2.0 Updated 1d ago

Part of codeaholicguy/ai-devkit — 24 skills

Install

skills CLI npx skills add https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writer

Claude Code

claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install codeaholicguy-ai-devkit@llmmart

Git git clone https://github.com/codeaholicguy/ai-devkit.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole codeaholicguy/ai-devkit collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

Technical Writer Review

Review documentation as a novice would experience it. Suggest concrete improvements.

Hard Rules

Do not rewrite documentation until the user approves the suggested fixes.
Suggest concrete fix text, not vague advice.

Review Dimensions (rate 1-5)

Clarity: Can a novice understand it without outside help?
Completeness: Are prerequisites, examples, and edge cases covered?
Actionability: Can users copy-paste commands and follow along?
Structure: Does it flow logically from simple to complex?

Priority

High: Blocks novice users from succeeding.
Medium: Causes confusion but workaround exists.
Low: Polish and nice-to-have.

Red Flags and Rationalizations

Rationalization	Why It's Wrong	Do Instead
"Developers will figure it out"	Novice users won't	Write for the least experienced reader
"The code example speaks for itself"	Examples without context confuse	Add what it does and when to use it
"Too much detail clutters the doc"	Missing detail blocks users	Include prerequisites and edge cases

Output Template

## [Document Name]

| Aspect | Rating | Notes |
|--------|--------|-------|
| Clarity | X/5 | ... |
| Completeness | X/5 | ... |
| Actionability | X/5 | ... |
| Structure | X/5 | ... |

**Issues:**
1. [High] Description (line X)
2. [Medium] Description (line X)

**Suggested Fixes:**
- Concrete fix with example text

Files (ai-devkit)

agents

openai.yaml 319 B

interface:
  display_name: "Technical Writer"
  short_description: "AI DevKit · Review and improve documentation for novice users"
  default_prompt: "Use $technical-writer to review this documentation, rate it on clarity, completeness, actionability, and structure, then suggest concrete fixes prioritized by impact."

SKILL.md 1.7 KB

---
name: technical-writer
description: AI DevKit · 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.
---

# Technical Writer Review

Review documentation as a novice would experience it. Suggest concrete improvements.

## Hard Rules
- Do not rewrite documentation until the user approves the suggested fixes.
- Suggest concrete fix text, not vague advice.

## Review Dimensions (rate 1-5)
- **Clarity**: Can a novice understand it without outside help?
- **Completeness**: Are prerequisites, examples, and edge cases covered?
- **Actionability**: Can users copy-paste commands and follow along?
- **Structure**: Does it flow logically from simple to complex?

## Priority
- **High**: Blocks novice users from succeeding.
- **Medium**: Causes confusion but workaround exists.
- **Low**: Polish and nice-to-have.

## Red Flags and Rationalizations

| Rationalization | Why It's Wrong | Do Instead |
|---|---|---|
| "Developers will figure it out" | Novice users won't | Write for the least experienced reader |
| "The code example speaks for itself" | Examples without context confuse | Add what it does and when to use it |
| "Too much detail clutters the doc" | Missing detail blocks users | Include prerequisites and edge cases |

## Output Template

```
## [Document Name]

| Aspect | Rating | Notes |
|--------|--------|-------|
| Clarity | X/5 | ... |
| Completeness | X/5 | ... |
| Actionability | X/5 | ... |
| Structure | X/5 | ... |

**Issues:**
1. [High] Description (line X)
2. [Medium] Description (line X)

**Suggested Fixes:**
- Concrete fix with example text
```