customer successintermediate720 tokens
Product Documentation Writer
Write clear, comprehensive product documentation
documentationtechnical-writinguser-guidesproduct-docstutorials
Prompt Template
You are a technical writer. Create clear, user-friendly product documentation.
**Feature:** {feature_name}
**Audience:** {user_level}
**Doc Type:** {doc_type}
Write documentation following best practices:
**Structure:**
**1. Overview**
What: [One-sentence description of what this feature does]
Why: [Why users would use this feature]
Who: [Who should use this feature]
**2. Prerequisites**
Before you begin, ensure you have:
- [ ] {requirement_1}
- [ ] {requirement_2}
- [ ] {requirement_3}
**3. Quick Start (5 minutes)**
```
# Fastest way to get started
{quick_start_code}
```
**Result:** [What they should see after quick start]
**4. Step-by-Step Guide**
**Step 1: {action}**
{detailed_instructions}
š” **Tip:** {helpful_tip}
**Step 2: {action}**
{detailed_instructions}
ā ļø **Common Mistake:** {mistake_to_avoid}
[Continue for all steps]
**5. Configuration Options**
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `{option_1}` | string | "{default}" | {description} |
| `{option_2}` | boolean | true | {description} |
**6. Examples**
**Example 1: Basic Usage**
```{language}
{basic_example_code}
```
**Example 2: Advanced Usage**
```{language}
{advanced_example_code}
```
**Example 3: Common Use Case - {use_case}**
```{language}
{use_case_example_code}
```
**7. Troubleshooting**
**Problem:** {problem_1}
**Solution:** {solution_1}
**Problem:** {problem_2}
**Solution:** {solution_2}
**8. FAQ**
**Q: {question_1}**
A: {answer_1}
**Q: {question_2}**
A: {answer_2}
**9. API Reference (if applicable)**
```
function_name(param1, param2)
```
**Parameters:**
- `param1` (type): Description
- `param2` (type): Description
**Returns:** type - Description
**10. Next Steps**
- [Link to related feature 1]
- [Link to related feature 2]
- [Link to advanced guide]
**Writing Best Practices:**
ā
Use active voice: "Click the button" not "The button should be clicked"
ā
Use present tense: "This feature allows..." not "This feature will allow..."
ā
Be concise: One idea per sentence
ā
Use visuals: Screenshots, diagrams, videos
ā
Test all examples: Ensure code runs
ā
Use consistent terminology
ā
Write for scanning: Headings, bullets, short paragraphs
ā Jargon without explanation
ā Assumptions about user knowledge
ā Outdated examples
ā Missing error handling
ā No visual aids
**Documentation Types:**
**Getting Started Guide:**
- Goal: Get user to "aha moment" in < 10 minutes
- Include: Quick start, basic example, next steps
**Tutorial:**
- Goal: Teach by doing
- Include: Step-by-step, code samples, expected output
**Reference:**
- Goal: Comprehensive details for lookup
- Include: All options, parameters, edge cases
**How-To Guide:**
- Goal: Solve specific problem
- Include: Context, steps, alternatives
Provide: Complete documentation + code examples + troubleshooting.Variables to Replace
{feature_name}{user_level}{doc_type}{requirement_1}{requirement_2}{requirement_3}{quick_start_code}{action}{detailed_instructions}{helpful_tip}{mistake_to_avoid}{option_1}{option_2}{default}{description}{language}{basic_example_code}{advanced_example_code}{use_case}{use_case_example_code}{problem_1}{solution_1}{problem_2}{solution_2}{question_1}{answer_1}{question_2}{answer_2}Pro Tips
Test every code example. Use screenshots. Write for scanning, not reading. Update docs with every release.
Related Prompts
Need More Prompts?
Explore our full library of 60+ professional AI prompt templates
Browse All Prompts ā