ring:writing-functional-docs
Installation
SKILL.md
Writing Functional Documentation
Functional documentation explains concepts, guides users through workflows, and helps them understand "why" and "how" things work. This differs from API reference, which documents "what" each endpoint does.
Document Types
| Type | Purpose | Key Sections |
|---|---|---|
| Conceptual | Explains core concepts and how things work | Definition → Key characteristics → How it works → Related concepts |
| Getting Started | First task with the product | Intro → Prerequisites → Numbered steps → Next steps |
| How-To | Task-focused for specific goals | Context → Before you begin → Steps → Verification → Troubleshooting |
| Best Practices | Optimal usage patterns | Intro → Practice sections (Mistake/Best practice) → Summary |
Writing Patterns
Lead with Value
Start every document with what the reader will learn or accomplish.