Create a Step-by-Step Version Upgrade Guide for Customer Support Teams

Build a detailed customer-facing version upgrade guide with pre-checks, step-by-step instructions, and troubleshooting FAQs.

📝 The Prompt

You are a technical writer for [COMPANY_NAME]. Create a comprehensive, customer-facing version upgrade guide to help users migrate from [CURRENT_VERSION] to [NEW_VERSION] of [PRODUCT_NAME]. Upgrade Context: - Product Type: [PRODUCT_TYPE] (e.g., SaaS platform, desktop application, mobile app, self-hosted software) - Key New Features: [NEW_FEATURES_LIST] - Breaking Changes: [BREAKING_CHANGES] - Deprecated Features: [DEPRECATED_FEATURES] - Minimum System Requirements: [SYSTEM_REQUIREMENTS] - Estimated Upgrade Time: [UPGRADE_TIME] - Rollback Option Available: [YES/NO] Structure the guide as follows: 1. **Overview & What's New** — Summarize the upgrade in 3-4 sentences, highlighting the top 3 benefits customers will experience. Make it exciting but factual. 2. **Pre-Upgrade Checklist** — Provide a numbered checklist of 5-7 items customers must complete before upgrading (e.g., backup data, check compatibility, review breaking changes, notify team members). 3. **Step-by-Step Upgrade Instructions** — Write 6-10 clearly numbered steps with specific actions. For each step, include: - The action to take - What the expected result looks like - A troubleshooting note if something goes wrong 4. **Post-Upgrade Verification** — List 3-5 checks customers should perform to confirm the upgrade was successful. 5. **Breaking Changes & Migration Notes** — Detail each breaking change with a before/after comparison and the exact steps to adapt. 6. **FAQ Section** — Write 5 anticipated questions and concise answers. 7. **Support Escalation Path** — Provide clear instructions for reaching [SUPPORT_CHANNEL] if issues arise, including what information to include in their support request. Tone: Clear, encouraging, and technically precise. Use simple language suitable for [TARGET_AUDIENCE_SKILL_LEVEL] users.

💡 Tips for Better Results

Always include a rollback procedure even if you don't expect issues — it gives customers confidence to proceed. Test every step in the guide yourself before publishing to catch gaps. Use screenshots or describe expected UI states at each step so customers can verify they're on track.

🎯 Use Cases

Product managers, technical writers, and customer support teams use this when releasing a major version update to guide customers through a smooth upgrade process and reduce support tickets.

🔗 Related Prompts

🤝 Customer Support beginner

Customer Support Response Templates

Get 8 professional customer support templates covering complaints, refunds, bugs, and more.

👁️ 2 📋 0
🤝 Customer Support beginner

Create a Comprehensive FAQ Document for Customer Support

Generate a structured, brand-aligned FAQ document with categorized questions and clear answers for your customer support team.

👁️ 1 📋 0
🤝 Customer Support intermediate

Write a Professional Knowledge Base Article for Customer Self-Service

Craft a structured, searchable knowledge base article with step-by-step instructions to empower customer self-service.

👁️ 1 📋 0
🤝 Customer Support advanced

Build a Step-by-Step Troubleshooting Guide for Customer Issues

Create a detailed troubleshooting guide with diagnostic decision trees and escalation paths to resolve customer issues faster.

👁️ 1 📋 0
🤝 Customer Support beginner

Write a Warm Customer Onboarding Welcome Email

Generate a professional onboarding welcome email that guides new customers through first steps and builds brand loyalty.

👁️ 1 📋 0
🤝 Customer Support intermediate

Create a Persuasive Subscription Renewal Reminder Email

Craft a compelling subscription renewal reminder email that highlights customer value and reduces churn effectively.

👁️ 1 📋 0