Write Article
Teaches an agent to write a documentation article of the right type — tutorial, guide, reference, or concept — structured for the elements that will display it.
documentationwritearticle
Loading interactive preview
Teaches an agent to write a documentation article of the right type — tutorial, guide, reference, or concept — structured for the elements that will display it.
Teaches an agent to write a documentation article of the right type — tutorial, guide, reference, or concept — structured for the elements that will display it.
Teaches an agent to write a documentation article of the right type — tutorial, guide, reference, or concept — structured for the elements that will display it.
---
name: write-article
description: Write a documentation article for a product — a tutorial, how-to guide, reference page, or concept explainer. Use when asked to draft, rewrite, or structure docs content.
---
# Write a documentation article
## 1. Pick the type first
Ask what the reader is trying to do, then commit to one type. Mixing types is the most common reason docs are hard to use.
| Type | The reader wants to… | Shape |
| --- | --- | --- |
| Tutorial | learn by doing, start to finish | Prerequisites → numbered steps → a working result → next page |
| How-to guide | get one task done | Goal in one sentence → prerequisites → steps → troubleshooting |
| Reference | look something up | Summary → one section per item, same fields in the same order |
| Concept | understand why | The problem → how it works → trade-offs → where it's used |
## 2. Inputs to confirm
- Topic and the product version it applies to.
- Audience: what they already know, and what they must not be assumed to know.
- Type, from the table above.
If any of these is missing, ask once before writing.
## 3. Write
Unlock everything with Supporter
The complete source and every other premium item unlock with Supporter.
Unlock everything with Supporter
The complete source and every other premium item unlock with Supporter.