Technical writing
Skill openagentskills/betterskills/skills/documentation/technical-writing
Portable, open catalogue of agent skills for Cursor, Claude Code, Windsurf, Copilot, and other AI coding assistants.
npx -y skills add openagentskills/betterskills --skill technical-writingAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Writes or revises technical documentation for clarity, structure, and audience fit. Use for READMEs, runbooks, API docs, tutorials, or when the user asks to improve technical writing.
SKILL.md
1.4 KB, as published. Nobody here has run it
Technical Writing
Audience first
| Audience | Emphasis |
|---|---|
| New user | Quick start, prerequisites, copy-paste examples |
| Daily user | How-to tasks, troubleshooting |
| Maintainer | Architecture, config, contribution |
Document patterns
README
# Project name
One-line value proposition.
## Quick start
Minimal steps to success.
## Installation
## Usage
## Configuration
## Troubleshooting
## Contributing / License
How-to guide
Goal → Prerequisites → Steps (numbered) → Verify → Next steps
Reference
Tables, parameter lists, defaults, error codes — no narrative fluff
Style rules
- Active voice, present tense
- Second person ("you") for instructions
- One idea per sentence; short paragraphs
- Code blocks complete and runnable where possible
- Headings form a logical outline (no skipped levels)
Revision pass
- Cut redundancy
- Move advanced content lower or to linked page
- Add missing prerequisites and failure modes
- Check all commands and paths against the repo
Output
When editing, show before/after only for changed sections unless full doc requested.