Product Documentation Strategy

J

Jordan Reyes

@jordan-reyes

·

Design comprehensive product documentation strategies

12 copies0 forks
Create a product documentation strategy for {{product_name}}.

Current state: {{current_state}}
User types: {{user_types}}
Product complexity: {{complexity}}

**Documentation Framework:**

**1. Documentation Types Needed**

*Getting Started*
- Quick start guides
- Onboarding tutorials
- First success path

*How-To Guides*
- Task-oriented instructions
- Use case walkthroughs
- Best practices

*Reference*
- API documentation
- Feature specifications
- Configuration options

*Conceptual*
- Architecture overviews
- Concept explanations
- Background context

*Troubleshooting*
- Common issues
- FAQs
- Error messages

**2. User-Specific Needs**
For each user type:
- Primary documentation needs
- Learning preferences
- Entry points

**3. Content Standards**
- Writing style guide
- Template standards
- Screenshot requirements
- Code example formats

**4. Maintenance Plan**
- Update triggers
- Review cadence
- Ownership model
- Deprecation process

**5. Discovery and Search**
- Information architecture
- Search optimization
- Cross-linking strategy

**6. Success Metrics**
- Usage analytics
- Satisfaction surveys
- Support deflection

Details

Category

Productivity

Use Cases

Docs planningContent strategyUser enablement

Works Best With

gpt-4claude-3
Created Updated Shared

Create your own prompt vault and start sharing