# technical-writing

A skill that makes the agent write in Simplified Technical English: short sentences, active voice, one word per meaning. Meant for docs, READMEs and commits.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 514 installs · ★ 158
- Author: frappe
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/frappe/skills/tree/HEAD/skills/technical-writing/SKILL.md
- Updated: 2026-10-24
- HTML: https://affpapa.org/en/nevibecode/skills/frappe-technical-writing

## What it does

The skill hands the agent a set of writing rules and makes it revise, not just produce a first draft. After writing, the agent goes sentence by sentence and cuts whatever does not carry new information.

The rules sit in blocks. Words: one item gets one name, and the short common word wins (`start` over `commence`, `use` over `utilize`). Verbs: active voice, and no hiding an action inside a noun — `analyze the log`, not `perform an analysis`. Sentences: 20 words for an instruction, 25 for a description, no contractions, never three nouns in a row. A separate block covers structure: one topic per paragraph, six sentences at most, steps as a numbered list.

It is not a fit for everything. Marketing copy, essays and code stay out of scope — those need a voice, not a rulebook. The rules also ask for American spelling, so a project written in British English will get edits in the other direction. Semicolons are banned outright; the em dash is left to your judgement.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add frappe/skills --skill technical-writing -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/technical-writing/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/technical-writing/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add frappe/skills --skill technical-writing -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/technical-writing/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add frappe/skills --skill technical-writing -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/technical-writing/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install frappe/skills technical-writing
```

2. **Manually: put the files in place**
- File: `.github/skills/technical-writing/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add frappe/skills --skill technical-writing -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/frappe/skills --path skills/technical-writing
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/technical-writing/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add frappe/skills --skill technical-writing -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/frappe/skills/tree/HEAD/skills/technical-writing/SKILL.md

## When to use it
- make a README follow one style with short sentences
- rewrite a commit message so the action is visible
- strip marketing adjectives out of the docs
- split a setup guide into steps with one action each
- clean bureaucratic phrasing from a plan or release notes

## Example prompts
- Rewrite `README.md` in Simplified Technical English
- Trim this pull request description: active voice, no sentence over 20 words
- Go through `docs/setup.md` and cut the extra words without changing the meaning

## Similar
- [grill-with-docs](https://affpapa.org/en/nevibecode/skills/grill-with-docs.md) — skill · 1219756 installs
- [skill-creator](https://affpapa.org/en/nevibecode/skills/skill-creator.md) — skill · 414180 installs
- [setup-matt-pocock-skills](https://affpapa.org/en/nevibecode/skills/setup-matt-pocock-skills.md) — skill · 1052851 installs
- [handoff](https://affpapa.org/en/nevibecode/skills/handoff.md) — skill · 1038491 installs
- [triage](https://affpapa.org/en/nevibecode/skills/triage.md) — skill · 990453 installs
- [domain-modeling](https://affpapa.org/en/nevibecode/skills/domain-modeling.md) — skill · 876391 installs

## Other versions with the same name
- [technical-writing · backnotprop](https://affpapa.org/en/nevibecode/skills/backnotprop-technical-writing.md) — 5500 installs
- [technical-writing · mindrally](https://affpapa.org/en/nevibecode/skills/mindrally-technical-writing.md) — 1200 installs
- [technical-writing · akillness](https://affpapa.org/en/nevibecode/skills/akillness-technical-writing.md) — 544 installs

From the same set: [frappe/skills](https://affpapa.org/en/nevibecode/by/frappe/skills.md) — 6 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md