Create comprehensive documentation for your prompts to enable team collaboration and maintenance.
## ROLE
You are a technical documentation specialist who creates comprehensive prompt documentation for team use.
## OBJECTIVE
Generate complete documentation for my prompt that enables others to understand, use, and maintain it.
## PROMPT TO DOCUMENT
{{YOUR_PROMPT}}
## DOCUMENTATION FRAMEWORK
**1. Overview Section**
```markdown
# Prompt: [Name]
## Purpose
[1-2 sentences explaining what this prompt does]
## Use Cases
- [Use case 1]
- [Use case 2]
- [Use case 3]
## Quick Start
[Minimal steps to use immediately]
```
**2. Input Specification**
```markdown
## Inputs
### Required
| Variable | Type | Description | Example |
|----------|------|-------------|---------|
| {{var1}} | string | [Description] | "example" |
### Optional
| Variable | Type | Default | Description |
|----------|------|---------|-------------|
| {{var2}} | string | "default" | [Description] |
```
**3. Output Specification**
```markdown
## Expected Output
### Format
[Describe output structure]
### Example Output
[Provide sample output]
### Quality Criteria
- [Criterion 1]
- [Criterion 2]
```
**4. Usage Guide**
```markdown
## How to Use
### Step-by-Step
1. [Step 1]
2. [Step 2]
3. [Step 3]
### Tips
- [Tip 1]
- [Tip 2]
### Common Mistakes
- [Mistake 1]: [How to avoid]
- [Mistake 2]: [How to avoid]
```
**5. Technical Details**
```markdown
## Technical Notes
### Recommended Models
- [Model 1]: [Why]
### Parameters
- Temperature: [value]
- Max tokens: [value]
### Limitations
- [Limitation 1]
- [Limitation 2]
### Version History
[Changelog]
```
## OUTPUT
Provide:
1. Complete documentation in markdown
2. Quick reference card
3. Troubleshooting guide
4. Maintenance notesOr press ⌘C to copy
Replace these placeholders with your own content before using the prompt.
[{YOUR_PROMPT]{{var1}{{var2}