Customer success & support

Customer Success Knowledge Base Article Architect

An advanced framework for transforming technical specifications and raw notes into user-centric, SEO-optimized help center documentation. Designed for Customer Success teams to reduce support ticket volume and improve user self-service rates.

5 blanks to fill in · Added May 2024 · knowledge-base · technical-writing · customer-support · user-onboarding · self-service

The prompt

5 blanks

You are a Senior Technical Writer and Customer Experience Specialist. Your objective is to create a high-quality, accessible Knowledge Base article for [PRODUCT_OR_FEATURE_NAME] that solves [SPECIFIC_USER_PROBLEM_OR_GOAL]. Using the following raw information: [RAW_NOTES_OR_TECHNICAL_DOCS], please draft a comprehensive article for [TARGET_USER_PERSONA]. 

Follow this structure precisely:
1. SEO-Optimized Title: A clear 'How-to' or 'Guide' title.
2. Article Summary: A 2-3 sentence overview explaining the value and outcome of this guide.
3. Prerequisites: List any tools, permissions, or configurations needed before starting.
4. Step-by-Step Instructions: Use numbered lists with active voice and clear verbs. Break complex processes into sub-headings.
5. Visual Cues: Suggest where [SCREENSHOT_OR_VIDEO_PLACEHOLDERS] should be placed to clarify steps.
6. Troubleshooting: Identify 2-3 common errors or pitfalls users might encounter and how to fix them.
7. Pro-Tips: Include 2 actionable tips for advanced usage or efficiency.
8. Search Keywords: A comma-separated list of potential search terms for internal indexing.

Maintain a [TONE_PREFERENCE - e.g., Professional, Empathetic, or Direct] tone. Use Markdown formatting for headers and bold text for UI elements (e.g., Click the **Settings** button).

Open in ChatGPT

Blanks: Product or feature name · Specific user problem or goal · Raw notes or technical docs · Target user persona · Screenshot or video placeholders

How to use it

Use this prompt to convert internal product updates, Slack discussions, or engineer notes into customer-facing documentation that reduces the need for manual support intervention.

Tips

Provide specific names of buttons and menu items in the raw notes for higher accuracy.
Define the user persona's technical level (Beginner vs. Developer) to adjust the level of jargon used.
If the process is long, ask the AI to break it into 'Part 1' and 'Part 2' within the same article.
Request the AI to include a 'Related Articles' section to improve the user journey.

Information Gathering

Before running the prompt, collect raw data including technical requirements, known bugs, and the specific user persona (e.g., Admin vs. End-user). Identifying the 'happy path' is crucial for the step-by-step section.

Structural Standards

The output follows the 'Inverted Pyramid' style of technical writing, placing the most critical information and the goal at the top, followed by granular execution steps and edge cases.

Context and Tone

Ensure the tone matches your brand voice. For SaaS products, a balance of professional competence and helpful approachability typically performs best in support environments.