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.
📝 The Prompt
Act as a technical writer specializing in customer-facing documentation. Write a detailed knowledge base article for [COMPANY NAME] on the following topic: [ARTICLE TOPIC/TITLE].
The article should help customers understand and resolve issues related to [SPECIFIC FEATURE, PROCESS, OR PRODUCT AREA] without needing to contact support.
Follow this structure and set of requirements:
1. **Title**: Create a clear, searchable title that begins with an action verb or addresses a specific question (e.g., 'How to...', 'Setting Up...', 'Why Does...').
2. **Summary/Overview** (2-3 sentences): Provide a brief description of what this article covers and who it's for. Include the primary keyword [PRIMARY KEYWORD] naturally.
3. **Prerequisites** (if applicable): List any requirements the customer needs before following the instructions, such as:
- Account type: [ACCOUNT TYPE e.g., Free, Pro, Enterprise]
- Software version: [VERSION]
- Required permissions or access levels
4. **Step-by-Step Instructions**: Write [NUMBER e.g., 5-10] clearly numbered steps that:
- Start each step with an action verb
- Include specific UI element names in bold (e.g., click **Settings**)
- Note where screenshots would be inserted using [SCREENSHOT: description of what to capture]
- Call out warnings or important notes in a distinct format
5. **Expected Outcome**: Describe what the customer should see or experience after completing the steps successfully.
6. **Common Issues & Solutions**: Include 2-3 potential problems a customer might encounter during this process, each with a brief solution.
7. **Related Articles**: Suggest 3 related topics that could be linked, formatted as placeholder titles.
8. **Metadata**: At the end, provide suggested values for:
- Category: [CATEGORY]
- Tags/keywords: 5 relevant search terms
- Difficulty level: Beginner / Intermediate / Advanced
- Last reviewed date placeholder
Write in a [TONE e.g., helpful and concise] tone. Avoid jargon unless defined. Target article length: 600-1000 words.
💡 Tips for Better Results
Include the exact names of buttons, menus, and UI elements your product uses to make instructions precise and easy to follow.
Write the 'Common Issues & Solutions' section based on real escalation patterns from your support team for maximum relevance.
Optimize for search by including variations of how customers phrase the problem in the summary and title.
🎯 Use Cases
Support teams, product managers, and technical writers who need to create or expand a help center or knowledge base to deflect common support tickets.