Home > User Guide > [Category] > [Feature Name]
[Feature Name]
Status: 🟡 Draft Last Updated: YYYY-MM-DD Audience: 👤 Users Difficulty: ⭐ Beginner
Table of Contents
What It Does
[Clear 2-3 sentence explanation of what this feature does and why it exists]
Key Benefits:
- ✅ Benefit 1
- ✅ Benefit 2
- ✅ Benefit 3
When To Use It
[Describe scenarios when users should use this feature]
Example Scenarios:
- Scenario 1: [Description]
- Scenario 2: [Description]
- Scenario 3: [Description]
How To Use It
Step 1: [Action Title]
[Detailed instructions for this step]
[SCREENSHOT PLACEHOLDER] Description: What should be shown in the screenshot Highlight: What UI elements to emphasize Path:
/assets/images/screenshots/features/[feature-name]/step1.png
Expected Result: [What should happen after this step]
Step 2: [Action Title]
[Detailed instructions for this step]
[SCREENSHOT PLACEHOLDER] Description: What should be shown in the screenshot Highlight: What UI elements to emphasize Path:
/assets/images/screenshots/features/[feature-name]/step2.png
Expected Result: [What should happen after this step]
Step 3: [Action Title]
[Continue with additional steps as needed]
Tips & Tricks
💡 Pro Tips
- Tip 1: [Helpful tip]
- Tip 2: [Helpful tip]
- Tip 3: [Helpful tip]
⚠️ Important Notes
- Note 1: [Important thing to know]
- Note 2: [Important thing to know]
Common Issues
Issue: [Problem Description]
Symptoms:
- Symptom 1
- Symptom 2
Solution: [Step-by-step fix]
Why This Happens: [Brief explanation]
Issue: [Another Problem]
Symptoms:
- Symptom 1
- Symptom 2
Solution: [Step-by-step fix]
Related Documentation
Prerequisites
- Document Title - Brief description of why this is a prerequisite
Next Steps
- Document Title - What to do after mastering this feature
Related Features
- Document Title - How this feature relates to others
Feedback
Found an issue with this documentation? Report it on GitHub
Document Info:
- Version: 1.0
- Last Updated: YYYY-MM-DD
- Maintained By: [Team/Person]