docs-writer
Installation
SKILL.md
Documentation Writer Skill
Create clear, useful documentation for developers.
Core principle — write for the reader's mental model first
Documentation rarely fails because it's incomplete. It fails because the reader can't build a mental model fast enough to care. So before any reference detail, answer the questions the reader is silently asking — in their words, in this order:
| The reader is silently asking… | Answer it with… |
|---|---|
| What is this? | One plain-English sentence — what it does, not how it's built |
| Why should I care? | The problem it solves / the pain it removes |
| Who is it for? | The audience + stack, so a wrong-fit reader can leave early |
| How do I start? | The shortest path to a first win: install → one command → result |
| When / where do I use it? | The situations it fits — and its boundaries (what it's not) |
Rules that follow from this: