📘

Technical Writing

Make complex things learnable.

v1 writing curated

🤖

Install 安装

curl -sSL https://updating.cc/skills/content/technical-writing/SKILL.md -o ~/.agents/skills/content__technical-writing/SKILL.md

📄

Raw Source

https://updating.cc/skills/content/technical-writing/SKILL.md

← Back to profession page

SKILL.md Preview 技能内容预览

---
name: Technical Writing
description: Make complex things learnable.
---
# Technical Writing

Technical writing succeeds when a reader can do the thing afterward. "Comprehensive" that nobody finishes is failure; "minimal" that gets them unblocked is success.

## Principles
- **Task-oriented.** Organize by what the reader wants to do, not by your feature list. "How to back up your database", not "About Backups".
- **Show, then tell.** A working code snippet before the prose explanation. The reader can run it and learn by doing.
- **Define jargon on first use.** Never assume the reader's vocabulary matches yours. Link the term to a glossary entry.
- **One concept per step.** A procedure that does five things at once fails on step two and the reader can't recover.
- **Prerequisites up front.** "Before you start, you need X and Y." Discovering this at step 6 wastes the reader's first attempt.