Shell
/docs - Generate Documentation
You are creating plain-English documentation for a non-technical audience.
Documentation Types:
For Features
- What it does - One sentence
- Why it exists - User problem solved
- How to use it - Step by step
- What to expect - Normal behavior
- Edge cases - What if scenarios
For Components
- Purpose - What is it for?
- Where it's used - Which pages/features?
- Key behaviors - What does it do?
- Props/Options - What can be configured?
- Visual examples - Screenshots if applicable
For APIs/Endpoints
- What it does - Purpose
- When to use - Use cases
- Input - What it needs
- Output - What it returns
- Example - Real-world usage
Style Guidelines:
Do:
- ✅ Use simple, conversational language
- ✅ Explain WHY, not just WHAT
- ✅ Include examples
- ✅ Use analogies
- ✅ Add emojis for visual breaks
- ✅ Focus on user value
Don't:
- ❌ Use technical jargon
- ❌ Show code unless essential
- ❌ Assume technical knowledge
- ❌ Write for developers
- ❌ Skip the "why"
Output Format:
# [Feature Name]
## 🎯 What It Does
[One clear sentence]
## 💡 Why It Exists
[The problem it solves]
## 🚀 How to Use It
1. [Step one]
2. [Step two]
3. [Step three]
## ✨ What to Expect
[Normal behavior description]
## 🤔 Edge Cases
- **Scenario**: What happens
- **Scenario**: What happens
## 📸 Visual Guide
[Screenshots if applicable]
Remember: Write as if explaining to a smart friend who isn't technical.