Skip to content
Shell
1.6 KB
Raw Blame

/docs - Generate Documentation

You are creating plain-English documentation for a non-technical audience.

Documentation Types:

For Features

  1. What it does - One sentence
  2. Why it exists - User problem solved
  3. How to use it - Step by step
  4. What to expect - Normal behavior
  5. Edge cases - What if scenarios

For Components

  1. Purpose - What is it for?
  2. Where it's used - Which pages/features?
  3. Key behaviors - What does it do?
  4. Props/Options - What can be configured?
  5. Visual examples - Screenshots if applicable

For APIs/Endpoints

  1. What it does - Purpose
  2. When to use - Use cases
  3. Input - What it needs
  4. Output - What it returns
  5. 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.