Help Documentation Writer
Write clear, user-friendly help articles and documentation that reduce support tickets and improve self-service.
Prompt Template
You are a technical writer specializing in customer-facing documentation. Write a help article for: Product: [product name] Feature/topic: [what the article covers] Audience: [e.g., non-technical users, developers, admins] User goal: [what the user is trying to accomplish] Common mistakes: [errors users make, if known] Format: [step-by-step guide / FAQ / reference / troubleshooting] Tone: [clear and friendly / formal / technical] Include: 1. Article title (verb-first, e.g., 'How to connect your first integration') 2. Brief intro (what this article covers and when to use it) 3. Prerequisites (what the user needs before starting) 4. Numbered steps with clear action verbs 5. Screenshots / image prompts (describe what to show) 6. Troubleshooting section (3-5 common issues + fixes) 7. Related articles
Example Output
How to Connect Slack to Flowdesk
This article explains how to connect your Slack workspace to Flowdesk so your team gets real-time alerts when users complete onboarding milestones.
**Before you start:** You'll need Admin access in both Flowdesk and Slack.
Steps
1. Go to **Settings → Integrations** in your Flowdesk dashboard
2. Click **Connect** next to the Slack logo
3. In the popup, click **Allow** to authorize Flowdesk to post to Slack
4. Choose which Slack channel should receive notifications (e.g., #onboarding-alerts)
5. Select which events trigger a notification (user activated, milestone reached, etc.)
6. Click **Save** — you'll see a test notification in Slack immediately
📸 *[Screenshot: Settings → Integrations page with Slack highlighted]*
Troubleshooting
**'Connect' button is greyed out** → You need Admin role in Flowdesk. Ask your account owner to upgrade your permissions.
**No test notification appeared** → Check that the Flowdesk bot was added to the selected channel. Type `/invite @flowdesk` in Slack.
**Notifications are delayed** → Check your Slack workspace's notification settings — quiet hours may be blocking them.
**Related:** Connecting Zapier | Managing notification settings | Slack bot permissions
Tips for Best Results
- 💡Write steps starting with action verbs: 'Click', 'Select', 'Enter' — not 'You should click' or 'The user needs to click'
- 💡Add a 'Before you start' section — missing prerequisites are the #1 cause of confused support tickets
- 💡Ask the AI to write the troubleshooting section first — it forces you to think about what breaks before writing the happy path
Frequently Asked Questions
What is the Help Documentation Writer prompt?
Write clear, user-friendly help articles and documentation that reduce support tickets and improve self-service. It's a free ChatGPT prompt template from our Customer Support collection — copy it, fill in the bracketed variables, and paste it into your AI tool.
Which AI tools work with this prompt?
It's written and tested for ChatGPT, Claude and Gemini. Any AI assistant that accepts free-form text prompts will handle it well.
How do I customize this ChatGPT prompt?
Replace the bracketed variables — such as [product name], [what the article covers], [what the user is trying to accomplish] — with your own details before running it. Write steps starting with action verbs: 'Click', 'Select', 'Enter' — not 'You should click' or 'The user needs to click'
Is this prompt free to use?
Yes. Every prompt on PromptAtlas is free to copy, customize, and use — no signup required.
Related Prompts
Support Ticket Triage and Response
Triage incoming support tickets by priority and generate initial responses for common issue types.
Chatbot Script and Flow Builder
Design a complete customer support chatbot conversation flow with decision trees, fallback responses, and handoff triggers.
Knowledge Base Article Optimizer
Transform rough support notes or FAQs into polished, searchable knowledge base articles with clear structure, troubleshooting steps, and SEO-friendly formatting.