Skip to main content
customer-support intermediate

Create Comprehensive User Manual Sections

Generate clear, structured user manual sections with step-by-step instructions, screenshots, and troubleshooting tips using this AI prompt.

Works with: chatgptclaudegemini

Prompt Template

You are a technical writing specialist creating user manual sections. Generate a comprehensive manual section for [PRODUCT_NAME] covering the topic of [SECTION_TOPIC]. Target audience: [TARGET_AUDIENCE] Technical complexity level: [COMPLEXITY_LEVEL] Preferred format: [FORMAT_PREFERENCE] Structure your manual section with the following components: 1. **Section Overview**: Brief introduction explaining what users will learn and why it's important 2. **Prerequisites**: List any prior knowledge, account requirements, or setup needed 3. **Step-by-Step Instructions**: Break down the process into numbered, actionable steps. For each step: - Use clear, concise language - Include specific button names, menu locations, and interface elements - Note where screenshots would be helpful with [SCREENSHOT: description] - Highlight important warnings or tips in callout boxes 4. **Common Issues & Troubleshooting**: Address 3-5 most likely problems users might encounter with solutions 5. **Advanced Options**: Include optional settings or advanced features for power users 6. **Related Tasks**: Link to 2-3 related manual sections users might need next Writing guidelines: - Use active voice and imperative mood - Write at an appropriate reading level for the target audience - Include specific examples and realistic scenarios - Use consistent terminology throughout - Add transition phrases between major steps - Include expected outcomes for key actions

Variables to Customize

[PRODUCT_NAME]

The name of the software, app, or product being documented

Example: ProjectFlow CRM Software

[SECTION_TOPIC]

The specific feature or process to document

Example: Setting up automated email campaigns

[TARGET_AUDIENCE]

The primary users who will read this manual

Example: Small business owners with basic computer skills

[COMPLEXITY_LEVEL]

Technical difficulty level appropriate for the audience

Example: Beginner-friendly with some intermediate concepts

[FORMAT_PREFERENCE]

Preferred structure and presentation style

Example: Web-based with expandable sections and visual callouts

Example Output

# Setting Up Automated Email Campaigns ## Section Overview Learn how to create and schedule automated email campaigns in ProjectFlow CRM to nurture leads and engage customers without manual intervention. This feature saves time and ensures consistent communication with your contacts. ## Prerequisites - Active ProjectFlow CRM account with email permissions enabled - At least one contact list with 5+ contacts - Basic familiarity with the ProjectFlow dashboard ## Step-by-Step Instructions 1. **Access the Campaign Builder** Navigate to Marketing > Email Campaigns > "Create New Campaign" [SCREENSHOT: Campaign builder main interface] 2. **Choose Campaign Type** Select "Automated Campaign" from the campaign type dropdown Click "Continue" to proceed to the setup wizard 3. **Configure Trigger Conditions** Choose when emails should send automatically: - New contact added to list - Contact completes a form - Specific date/anniversary Select your preferred trigger and click "Next" ## Common Issues & Troubleshooting **Issue**: Campaign not sending emails **Solution**: Verify your sender email is authenticated under Settings > Email Authentication **Issue**: Low open rates **Solution**: Test different subject lines using A/B testing feature in campaign settings ## Advanced Options Set up behavioral triggers based on website activity or purchase history for more targeted campaigns. ## Related Tasks - Creating Contact Segments - Analyzing Campaign Performance - Setting Up Email Templates

Pro Tips for Best Results

  • Include realistic examples and scenarios that match your target audience's actual use cases
  • Use consistent terminology throughout - create a glossary for complex products
  • Specify exact button names, menu paths, and interface elements to reduce confusion
  • Add estimated time requirements for multi-step processes to set proper expectations
  • Test your instructions with someone from your target audience before publishing

Tags

Want 500+ Expert Prompts?

Get the Premium Prompt Pack — organized, tested, and ready to use.

Get it for $29

Related Prompts You Might Like