AI Prompts for Writing & Documentation: 40+ Ready-to-Use Templates

TL;DR - Best AI Prompts for Writing & Documentation

Looking for ready-to-use AI prompts for writing and documentation? This guide contains 40+ copy-paste prompts that work with ChatGPT, Claude, and Gemini. Each prompt is completely self-contained in a code block—just copy, customize the placeholder comments, and paste. For foundational prompting skills, see the Prompt Engineering Fundamentals guide.

What’s included:

• Technical Documentation — User guides, API docs, README files, and tutorials
• Editing & Proofreading — Grammar, style, clarity, and structure improvements
• Content Creation — Articles, how-to guides, and knowledge base content
• Summarization — Executive summaries, TL;DRs, and key point extraction
• Style & Consistency — Style guide application and terminology management
• Release Communication — Release notes, changelogs, and announcements

💡 Pro tip: Every line starting with # REPLACE: is a placeholder. Replace these with your actual content before pasting into your AI assistant. For building comprehensive AI writing assistants, see the Mega-Prompt Engineering guide.

How to Use These Writing Prompts

Each prompt below is ready to copy and paste. Here’s how they work:

1. Copy the entire prompt from the code block
2. Replace the placeholder comments (lines starting with # REPLACE:) with your actual content
3. Paste into ChatGPT, Claude, or your preferred AI
4. Get your result and iterate if needed

Example of customization:

# Before (placeholder):
# REPLACE: Your product name - e.g., "CloudSync Dashboard"

# After (customized):
CloudSync Dashboard - a real-time data synchronization interface

Technical Documentation Prompts

Write Software User Guide

You are a senior technical writer. Write a comprehensive user guide for a software product. For AI-powered coding assistance, see the [AI-Powered IDEs Comparison guide](/tech-articles/ai-powered-ides/).

=== PRODUCT INFORMATION ===
Product Name: 
# REPLACE: Your product name (e.g., "Acme Project Manager")

Product Description: 
# REPLACE: One paragraph describing what the product does

Version: 
# REPLACE: Version number (e.g., "3.2.1")

=== TARGET AUDIENCE ===
User Type: 
# REPLACE: Who will read this? (e.g., "Non-technical business users who manage projects")

Technical Level: 
# REPLACE: Beginner / Intermediate / Advanced

Prior Knowledge: 
# REPLACE: What do they already know? (e.g., "Familiar with basic project management concepts")

=== KEY FEATURES TO DOCUMENT ===
# REPLACE: List the main features (add or remove as needed)
# 1. Dashboard overview - shows project status at a glance
# 2. Task creation - create and assign tasks to team members
# 3. Timeline view - visualize project milestones
# 4. Reporting - generate progress reports
# 5. Integrations - connect with Slack and Google Calendar

=== PREREQUISITES ===
# REPLACE: What users need before starting
# - Active account with admin or user role
# - Chrome, Firefox, or Safari browser
# - Internet connection

=== GENERATE THE USER GUIDE ===
Create a complete user guide with these sections:
1. Introduction and Overview
2. Getting Started (login, first-time setup)
3. Feature-by-feature documentation with step-by-step instructions
4. Common tasks and workflows
5. Troubleshooting section with 5+ common issues
6. FAQ section with 8-10 questions
7. Glossary of terms

For each feature, include:
- What it does and why it's useful
- Step-by-step instructions with specific UI elements
- Screenshots descriptions (describe what should be shown)
- Pro tips and best practices
- Common mistakes to avoid

Write Hardware/Device User Manual

You are a technical writer specializing in consumer electronics documentation. Write a user manual for a hardware device.

=== DEVICE INFORMATION ===
Device Name: 
# REPLACE: Device name (e.g., "SmartHome Hub Pro")

Device Type: 
# REPLACE: Category (e.g., "Smart home controller")

Model Number: 
# REPLACE: Model number (e.g., "SH-2000")

=== TARGET AUDIENCE ===
User Type: 
# REPLACE: (e.g., "Homeowners setting up smart home for the first time")

Technical Comfort: 
# REPLACE: Low / Medium / High

=== PHYSICAL SPECIFICATIONS ===
# REPLACE: List physical details
# - Dimensions: 4" x 4" x 1.5"
# - Weight: 8 oz
# - Power: USB-C, 5V/2A adapter included
# - Connectivity: Wi-Fi 6, Bluetooth 5.0, Zigbee

=== WHAT'S IN THE BOX ===
# REPLACE: List all included items
# - SmartHome Hub Pro device
# - USB-C power adapter
# - Quick start guide
# - Mounting bracket
# - Wall anchors and screws

=== KEY FEATURES ===
# REPLACE: List device features
# 1. Voice control via Alexa and Google Assistant
# 2. Controls up to 100 smart devices
# 3. Scene automation
# 4. Energy monitoring
# 5. Mobile app control

=== SAFETY WARNINGS ===
# REPLACE: List safety considerations
# - Indoor use only
# - Keep away from water
# - Do not open the device casing

=== GENERATE USER MANUAL ===
Create a complete user manual including:
1. Safety information and warnings (IMPORTANT - format prominently)
2. Package contents checklist
3. Device overview with labeled diagram description
4. Initial setup (step-by-step with estimated times)
5. Connecting to Wi-Fi and mobile app
6. Adding and managing smart devices
7. Creating automations and scenes
8. LED indicator meanings (table format)
9. Maintenance and care
10. Troubleshooting guide (10+ common issues)
11. Technical specifications table
12. Warranty information placeholder
13. Regulatory compliance placeholder (FCC, CE)
14. Support contact information placeholder

Use clear, simple language. Include callouts for warnings, tips, and notes.

Write API Documentation

You are a developer advocate writing API documentation. Create comprehensive API reference documentation.

=== API OVERVIEW ===
API Name: 
# REPLACE: API name (e.g., "Payments API")

Base URL: 
# REPLACE: Base URL (e.g., "https://api.acmepay.com/v2")

Purpose: 
# REPLACE: What does this API do? (e.g., "Process credit card payments and manage transactions")

=== AUTHENTICATION ===
Auth Type: 
# REPLACE: Bearer token / API Key / OAuth 2.0 / etc.

Auth Details: 
# REPLACE: How to authenticate (e.g., "API key in X-API-Key header")

=== ENDPOINTS TO DOCUMENT ===
# REPLACE: List endpoints with details
# 
# Endpoint 1:
# - Method: POST
# - Path: /payments
# - Purpose: Create a new payment
# - Request body: { amount, currency, source, description }
# - Response: Payment object with id, status, created_at
#
# Endpoint 2:
# - Method: GET
# - Path: /payments/{id}
# - Purpose: Retrieve a payment by ID
# - Path params: id (string, required)
# - Response: Payment object
#
# Endpoint 3:
# - Method: POST
# - Path: /refunds
# - Purpose: Refund a payment
# - Request body: { payment_id, amount, reason }
# - Response: Refund object

=== ERROR CODES ===
# REPLACE: Common error codes
# - 400: Bad request - invalid parameters
# - 401: Unauthorized - invalid API key
# - 404: Not found - resource doesn't exist
# - 422: Unprocessable - validation failed
# - 429: Rate limited - too many requests
# - 500: Server error - internal error

=== RATE LIMITS ===
# REPLACE: Rate limiting details
# - 100 requests per minute for standard tier
# - 1000 requests per minute for enterprise

=== GENERATE API DOCUMENTATION ===
Create complete API documentation including:

1. Overview and getting started
2. Authentication section with examples
3. For each endpoint:
   - HTTP method and path
   - Description
   - Request headers table
   - Path/query parameters table
   - Request body schema with field descriptions
   - Response schema with field descriptions
   - Example request (cURL, JavaScript, Python)
   - Example response JSON
   - Possible error responses
4. Error handling guide with all error codes
5. Rate limiting explanation
6. Pagination explanation (if applicable)
7. Webhooks section (if applicable)
8. SDKs and libraries placeholder
9. Changelog placeholder

Use standard API documentation conventions. Include tables for parameters.

Write Project README

You are an open-source developer writing a README for a GitHub project. Create a comprehensive and welcoming README.

=== PROJECT INFORMATION ===
Project Name: 
# REPLACE: Project name (e.g., "FastCache")

One-Line Description: 
# REPLACE: Brief description (e.g., "Lightning-fast in-memory caching for Node.js")

Detailed Description: 
# REPLACE: 2-3 sentences about what it does and why
# e.g., "FastCache provides sub-millisecond caching for Node.js applications. 
# It supports TTL, LRU eviction, and cluster mode for distributed caching."

=== TECHNICAL DETAILS ===
Primary Language: 
# REPLACE: Main language (e.g., "TypeScript")

Package Manager: 
# REPLACE: npm / yarn / pip / etc.

Package Name: 
# REPLACE: Install name (e.g., "@acme/fastcache")

=== PREREQUISITES ===
# REPLACE: What's needed to use this project
# - Node.js 18 or higher
# - npm 8+ or yarn 1.22+

=== KEY FEATURES ===
# REPLACE: Main features (4-6 bullet points)
# - Sub-millisecond read/write operations
# - Automatic TTL expiration
# - LRU eviction when memory limit reached
# - Cluster mode for distributed deployments
# - TypeScript support with full type definitions
# - Zero dependencies

=== BASIC USAGE EXAMPLE ===
# REPLACE: Simple code example showing basic usage
# const cache = new FastCache({ maxSize: 1000 });
# cache.set('user:123', { name: 'John' }, { ttl: 3600 });
# const user = cache.get('user:123');

=== CONFIGURATION OPTIONS ===
# REPLACE: Key configuration options
# - maxSize: Maximum number of items (default: 10000)
# - ttl: Default TTL in seconds (default: 3600)
# - evictionPolicy: 'lru' or 'fifo' (default: 'lru')

=== GENERATE README ===
Create a complete README.md including:

1. Project title with badges (build status, npm version, license, downloads)
2. One-line description and key value proposition
3. Table of contents
4. Features list with emojis
5. Installation instructions (multiple methods)
6. Quick start with minimal example
7. Detailed usage examples (3-4 use cases)
8. Configuration reference table
9. API reference for main methods
10. Performance benchmarks placeholder
11. Contributing guidelines summary
12. License information
13. Acknowledgments placeholder

Use markdown formatting, include code blocks with syntax highlighting.
Format for maximum GitHub readability.

Write Step-by-Step Tutorial

You are a technical educator creating a hands-on tutorial. Write a step-by-step tutorial that readers can follow along with.

=== TUTORIAL TOPIC ===
Title: 
# REPLACE: What will they learn? (e.g., "Build a REST API with Node.js and Express")

Learning Outcome: 
# REPLACE: What can they do after? (e.g., "Create a fully functional CRUD API with authentication")

=== AUDIENCE ===
Experience Level: 
# REPLACE: Beginner / Intermediate / Advanced

Prerequisites: 
# REPLACE: What should they know already?
# - Basic JavaScript knowledge
# - Familiarity with command line
# - Node.js installed (v18+)
# - Code editor (VS Code recommended)

=== WHAT THEY'LL BUILD/ACHIEVE ===
# REPLACE: End result description
# A REST API for a todo app with:
# - CRUD endpoints for todos
# - User authentication with JWT
# - MongoDB database integration
# - Input validation
# - Error handling

=== KEY STEPS ===
# REPLACE: High-level steps (the tutorial will expand these)
# 1. Set up the project and install dependencies
# 2. Create the Express server
# 3. Set up MongoDB connection
# 4. Create the Todo model
# 5. Build CRUD routes
# 6. Add authentication
# 7. Add validation and error handling
# 8. Test the API

=== TOOLS AND TECHNOLOGIES ===
# REPLACE: What tools/tech will be used?
# - Node.js and npm
# - Express.js framework
# - MongoDB with Mongoose
# - JWT for authentication
# - Postman for testing

=== GENERATE TUTORIAL ===
Create a comprehensive tutorial including:

1. Introduction
   - What we're building and why
   - What you'll learn
   - Estimated time to complete

2. Prerequisites checklist with verification steps

3. Each major step as a section with:
   - Clear heading with step number
   - Brief explanation of what this step accomplishes
   - Detailed sub-steps with exact commands/code
   - Code snippets with comments explaining key lines
   - Expected output or result after each major action
   - "Checkpoint" confirming successful completion
   - Common mistakes and how to avoid them
   - Pro tips in callout boxes

4. Testing and verification section

5. Troubleshooting section with 5+ common issues

6. Summary of what was accomplished

7. Next steps and further learning resources

8. Complete code reference (or link placeholder)

Make instructions extremely specific. Instead of "create a file", say "create a file called server.js in the project root folder".

Editing & Proofreading Prompts

Edit for Clarity and Readability

You are a professional editor improving content for clarity and readability.

=== CONTENT TO EDIT ===
# REPLACE: Paste your content below this line (keep it all in this prompt)
# Example content:
# The implementation of the new system was facilitated by the IT department 
# in order to achieve the optimization of workflow processes that had been 
# identified as being in need of improvement by multiple stakeholders who 
# had been consulted during the planning phase of the project.

=== AUDIENCE ===
Who will read this: 
# REPLACE: (e.g., "Busy executives who skim content" or "Technical developers")

Reading level target: 
# REPLACE: (e.g., "8th grade" or "College level" or "Expert technical")

=== EDITING GOALS ===
# REPLACE: What matters most? (Select priorities)
# - Shorter sentences (aim for under 20 words average)
# - Active voice instead of passive
# - Remove jargon and buzzwords
# - Improve scannability with better structure
# - Tighten wordiness
# - Improve flow between paragraphs

=== STYLE PREFERENCES ===
Tone: 
# REPLACE: Formal / Conversational / Professional-friendly / Technical

Specific requirements:
# REPLACE: Any specific rules
# - Use "we" not "one"
# - Contractions OK
# - Avoid starting sentences with "There is/are"

=== INSTRUCTIONS ===
Edit the content for maximum clarity and readability. Provide:

1. The edited version of the full content

2. A summary of changes made (bulleted list)

3. A comparison table showing 3-5 major before/after changes with explanations

4. Readability improvements:
   - Original word count vs. new word count
   - Estimated reading level change
   - Passive voice reduction

5. Additional suggestions for further improvement (optional changes)

Proofread and Correct Errors

You are a meticulous proofreader checking content for errors. Find and correct all issues.

=== CONTENT TO PROOFREAD ===
# REPLACE: Paste your content below this line
# Example:
# Their going to need to login to there accounts before they can access 
# the new features. The team have decided that the launch will be on Dec 15th, 
# and we should of been ready by now. However, alot of issues have came up 
# that effects our timeline.

=== STYLE GUIDE ===
Primary style guide: 
# REPLACE: AP Style / Chicago / Microsoft / APA / Company-specific / General

=== FOCUS AREAS ===
Check for these issues:
# REPLACE: Mark with YES/NO what to check
# - Grammar errors: YES
# - Spelling mistakes: YES  
# - Punctuation issues: YES
# - Subject-verb agreement: YES
# - Homophone confusion (their/there/they're): YES
# - Tense consistency: YES
# - Capitalization: YES
# - Number formatting (spell out vs numerals): YES
# - Comma usage: YES
# - Hyphenation: YES

=== INSTRUCTIONS ===
Proofread the content carefully. Provide:

1. CORRECTED VERSION
   The full content with all corrections applied.

2. ERROR LOG TABLE
   | Line/Location | Error Found | Correction | Rule/Explanation |
   Include every error found, even minor ones.

3. ERROR SUMMARY
   - Total grammatical errors: X
   - Total spelling errors: X
   - Total punctuation errors: X
   - Total style issues: X

4. PATTERNS NOTICED
   If you see recurring errors (e.g., consistent misuse of apostrophes), 
   note these patterns so the writer can improve.

5. CLEAN COPY
   A final version with no markup, ready to use.

Check Style Guide Compliance

You are an editorial style expert checking content against a style guide.

=== CONTENT TO CHECK ===
# REPLACE: Paste your content below
# Example:
# The Company announced it's new product on December 15th. The user-interface 
# has been redesigned and all employees have to re-login to access the 
# up-to-date features. Contact the Help Desk at 555-1234 or email 
# support@company.com.

=== STYLE GUIDE RULES ===
Primary guide: 
# REPLACE: AP / Chicago / Microsoft / MLA / Custom

Key rules to enforce:
# REPLACE: List the specific rules to check
# - Numbers: Spell out one through nine, use numerals for 10+
# - Dates: Use Month D, YYYY format (December 15, 2024)
# - Titles: Capitalize only first word and proper nouns
# - Company name: Always "Acme Corp" (not "the Company")
# - Oxford comma: Required
# - Hyphenation: "user interface" (no hyphen as noun), "up-to-date" (hyphen as adjective)
# - Times: Use a.m./p.m. with periods
# - Phone: Use (555) 123-4567 format
# - It's vs its: it's = it is only
# - Login vs log in: "login" noun, "log in" verb
# - Email: one word, no hyphen

=== EXCEPTIONS ===
# REPLACE: Any approved exceptions to standard rules
# - Product names keep original capitalization
# - Technical terms may use camelCase

=== INSTRUCTIONS ===
Check the content against the style guide. Provide:

1. STYLE COMPLIANCE REPORT
   For each rule, indicate: ✅ Compliant or ❌ Violation found

2. VIOLATIONS TABLE
   | Rule | Violation Found | Location | Correct Form |
   
3. CORRECTED VERSION
   Content with all style corrections applied.

4. TERMINOLOGY CONSISTENCY
   List terms that appear in multiple forms and recommend which to standardize.

5. ADDITIONAL STYLE RECOMMENDATIONS
   Suggestions for improved consistency even if not explicit violations.

Simplify Technical Content

You are a technical communication specialist who excels at making complex topics accessible.

=== COMPLEX CONTENT ===
# REPLACE: Paste the technical content to simplify
# Example:
# The microservices architecture utilizes containerized deployment via 
# Kubernetes orchestration, implementing eventual consistency through 
# message queue-based asynchronous communication patterns. The system 
# leverages a CQRS pattern with event sourcing for maintaining audit 
# trails and enabling temporal queries against the aggregate state.

=== AUDIENCE ===
Who needs to understand this: 
# REPLACE: (e.g., "Business stakeholders with no technical background")

What they need from it: 
# REPLACE: (e.g., "Understand what the system does, not how it works technically")

=== SIMPLIFICATION LEVEL ===
Target reading level: 
# REPLACE: 6th grade / 8th grade / High school / General audience

=== TERMS TO KEEP ===
# REPLACE: Technical terms that MUST stay (proper nouns, product names, etc.)
# - Keep: Kubernetes (but explain it)
# - Keep: CQRS (but explain briefly)

=== TERMS TO REPLACE ===
# REPLACE: Suggest simpler alternatives if possible
# - "containerized deployment" → simpler explanation
# - "eventual consistency" → simpler explanation
# - "aggregate state" → simpler explanation

=== INSTRUCTIONS ===
Simplify this content while maintaining accuracy. Provide:

1. SIMPLIFIED VERSION
   The full content rewritten for the target audience.

2. JARGON TRANSLATIONS
   | Technical Term | Plain English Explanation |
   | --- | --- |
   For every technical term, provide a simple definition.

3. ANALOGIES USED
   List any analogies you created to explain complex concepts.

4. READING LEVEL COMPARISON
   - Original estimated reading level: X
   - Simplified reading level: X

5. EXECUTIVE SUMMARY
   A 2-3 sentence summary suitable for someone who will only skim.

6. ACCURACY CHECK
   Confirm that simplification hasn't changed the meaning.

Rewrite for Different Audience

You are a versatile writer who adapts content for different audiences.

=== ORIGINAL CONTENT ===
# REPLACE: Paste the original content
# Example:
# Our Q4 earnings exceeded analyst expectations with revenue of $4.2B, 
# representing 23% YoY growth. EBITDA margins expanded 340bps to 28.5%, 
# driven by OpEx leverage and improved unit economics in our core segments.

=== ORIGINAL AUDIENCE ===
Written for: 
# REPLACE: (e.g., "Financial analysts and investors")

=== NEW AUDIENCE ===
Rewrite for: 
# REPLACE: (e.g., "All-hands company meeting with all employees")

Their characteristics:
# REPLACE: 
# - Many non-financial backgrounds
# - Want to know "are we doing well?"
# - Care about job security and company direction
# - Prefer celebration over data

=== TONE SHIFT ===
Current tone: 
# REPLACE: Formal / Technical / Academic

Target tone: 
# REPLACE: Celebratory / Conversational / Motivational

=== INSTRUCTIONS ===
Rewrite the content for the new audience. Provide:

1. REWRITTEN VERSION
   Full content adapted for the new audience.

2. KEY CHANGES MADE
   - Tone adjustments
   - Terminology simplifications
   - Added context or removed details
   - Structural changes

3. TRANSLATION TABLE
   | Original Term/Phrase | Rewritten As | Why |
   
4. WHAT WAS ADDED
   What context or explanation was added for the new audience?

5. WHAT WAS REMOVED
   What details were removed as too technical or unnecessary?

6. ALTERNATIVE VERSIONS (if helpful)
   - Email version (2-3 paragraphs)
   - Slack announcement (3-4 sentences)
   - One-liner for social media

Content Creation Prompts

Write Knowledge Base Article

You are a technical support writer creating self-service help content.

=== ARTICLE TOPIC ===
Problem/Question: 
# REPLACE: What issue does this article solve?
# Example: "Users can't reset their password"

Product/Feature: 
# REPLACE: Which product or feature does this relate to?
# Example: "Account Management - Password Reset"

=== AUDIENCE ===
User type: 
# REPLACE: (e.g., "End users with no technical background")

Their situation: 
# REPLACE: (e.g., "Frustrated, locked out of account, may be in a hurry")

What they've likely tried: 
# REPLACE: (e.g., "Clicked 'Forgot Password' but didn't receive email")

=== SOLUTION ===
# REPLACE: Describe the solution steps
# 1. Check spam/junk folder for reset email
# 2. Verify email address is correct (common typos)
# 3. Request new reset link and wait 5 minutes
# 4. Check if account uses SSO instead
# 5. If still not working, contact support with user ID

=== ROOT CAUSES ===
# REPLACE: Why does this problem happen?
# - Reset email going to spam folder
# - Wrong email address entered
# - SSO-only account (no password)
# - Email delivery delays
# - Account locked after too many attempts

=== RELATED INFORMATION ===
# REPLACE: Related articles or features
# - "How to change your password" (for users who are logged in)
# - "Understanding SSO login" (for enterprise users)
# - "Account security settings" (for admins)

=== INSTRUCTIONS ===
Create a comprehensive knowledge base article including:

1. CLEAR TITLE
   Match how users actually search (e.g., "Password reset email not received")

2. SUMMARY (TL;DR)
   One-sentence answer to the problem.

3. SYMPTOMS SECTION
   "You may be experiencing this if..." with bullet points.

4. STEP-BY-STEP SOLUTION
   Numbered steps with:
   - Specific UI element names (buttons, menus)
   - What they should see after each step
   - Time estimates where relevant

5. ALTERNATIVE SOLUTIONS
   If the main solution doesn't work.

6. WHY THIS HAPPENS
   Brief explanation of common causes.

7. PREVENTION TIPS
   How to avoid this issue in the future.

8. RELATED ARTICLES
   Links (placeholders) to related help content.

9. STILL NEED HELP?
   Escalation path with what info to provide to support.

Format for scannability: short paragraphs, bullet points, clear headings.

Write Release Notes

You are a product communications writer announcing a software release.

=== RELEASE INFORMATION ===
Version: 
# REPLACE: Version number (e.g., "4.5.0")

Release Date: 
# REPLACE: Date (e.g., "January 15, 2025")

Release Type: 
# REPLACE: Major / Minor / Patch / Hotfix

=== AUDIENCE ===
Primary readers: 
# REPLACE: (e.g., "Technical admins who manage the product" or "End users")

Their needs: 
# REPLACE: What do they need to know? What do they need to do?

=== NEW FEATURES ===
# REPLACE: List new features with details
# Feature 1: 
#   Name: Dark Mode
#   Description: New dark theme option for reduced eye strain
#   How to access: Settings > Appearance > Theme
#   Who benefits: All users
#
# Feature 2:
#   Name: Bulk Export
#   Description: Export up to 10,000 records at once as CSV
#   How to access: Reports > Export > Bulk Export
#   Who benefits: Admin users

=== IMPROVEMENTS ===
# REPLACE: List improvements
# - Dashboard loads 40% faster
# - Search now includes partial matching
# - Mobile navigation redesigned for easier access

=== BUG FIXES ===
# REPLACE: List bug fixes
# - Fixed: Calendar events not showing in correct timezone
# - Fixed: PDF export cutting off wide tables
# - Fixed: Occasional logout when switching pages

=== BREAKING CHANGES ===
# REPLACE: Any breaking changes (or "None" if not applicable)
# - API v1 deprecated, migrate to v2 by March 2025
# - Minimum browser version now Chrome 90+

=== DEPRECATIONS ===
# REPLACE: Features being deprecated (or "None")
# - Legacy import tool will be removed in v5.0

=== KNOWN ISSUES ===
# REPLACE: Known issues in this release (or "None")
# - Dark mode does not yet apply to PDF exports

=== INSTRUCTIONS ===
Write professional release notes including:

1. RELEASE HEADER
   Version, date, and one-line release summary.

2. HIGHLIGHTS SECTION
   Top 3 most impactful changes with brief explanations.

3. NEW FEATURES (detailed)
   For each feature:
   - Feature name with emoji icon
   - What it does and why it matters
   - How to access/use it
   - Screenshot description placeholder

4. IMPROVEMENTS
   Bulleted list with brief impact statements.

5. BUG FIXES
   Bulleted list with "Fixed:" prefix.

6. BREAKING CHANGES (if any)
   Clear warning formatting, migration steps.

7. DEPRECATION NOTICES (if any)
   Timeline and alternatives.

8. KNOWN ISSUES (if any)
   Workarounds if available.

9. UPGRADE NOTES
   Any special instructions for upgrading.

10. FEEDBACK INVITATION
    How to report issues or provide feedback.

Make it scannable. Use consistent formatting throughout.

Write Blog Post / Article

You are a content writer creating an engaging blog post.

=== ARTICLE DETAILS ===
Topic: 
# REPLACE: What is the article about?
# Example: "How to improve team productivity with async communication"

Target Keyword (for SEO): 
# REPLACE: Primary keyword to optimize for
# Example: "async communication tips"

Article Type: 
# REPLACE: How-to / List / Guide / Opinion / Case Study / Comparison

=== AUDIENCE ===
Target reader: 
# REPLACE: Who is this for?
# Example: "Remote team managers at mid-size tech companies"

Their pain point: 
# REPLACE: What problem are they trying to solve?
# Example: "Too many meetings, team members in different time zones"

What they need: 
# REPLACE: What will make this article valuable?
# Example: "Practical tips they can implement immediately"

=== ARTICLE PARAMETERS ===
Word count target: 
# REPLACE: (e.g., "1500-2000 words")

Tone: 
# REPLACE: Professional / Conversational / Authoritative / Friendly

Key points to cover:
# REPLACE: Main points the article must include
# 1. Why async communication matters for remote teams
# 2. Common mistakes teams make
# 3. 7-10 practical tips with examples
# 4. Tools that help
# 5. How to measure if it's working

=== UNIQUE ANGLE ===
# REPLACE: What makes this article different from others on this topic?
# Example: "Focus on cultural/mindset shift, not just tools"

=== CALL TO ACTION ===
# REPLACE: What should readers do after reading?
# Example: "Download our async communication template pack"

=== INSTRUCTIONS ===
Write a complete blog post including:

1. SEO-OPTIMIZED TITLE
   Compelling, includes keyword, under 60 characters.

2. META DESCRIPTION
   Enticing summary, includes keyword, 150-160 characters.

3. INTRODUCTION
   Hook that addresses the reader's pain point directly.
   End with what they'll learn.

4. BODY CONTENT
   - Use H2 and H3 headings for structure
   - Include specific examples and actionable tips
   - Add statistics or data points where relevant
   - Include quotes from experts (placeholder if needed)
   - Use bullet points and numbered lists for scannability

5. CONCLUSION
   Summary of key points and clear call to action.

6. SOCIAL MEDIA SNIPPETS
   - LinkedIn post version (150-200 words)
   - Twitter/X thread (5 tweets)

Format in clean markdown. Make paragraphs short (3-4 sentences max).

Generate FAQ Section

You are a content strategist creating an FAQ section that actually answers user questions.

=== TOPIC/PRODUCT ===
What is this FAQ for: 
# REPLACE: (e.g., "SaaS project management tool - Pricing page FAQ")

=== AUDIENCE ===
Who asks these questions: 
# REPLACE: (e.g., "Potential customers comparing pricing options")

=== KNOWN QUESTIONS ===
# REPLACE: Questions you know users ask (from support, sales, etc.)
# - How much does it cost?
# - Is there a free trial?
# - Can I cancel anytime?
# - Do you offer discounts for nonprofits?
# - What payment methods do you accept?

=== COMMON OBJECTIONS ===
# REPLACE: Concerns that block purchase/signup
# - "It seems expensive compared to Competitor X"
# - "I'm worried about data security"
# - "What if it doesn't work for my use case?"

=== INFORMATION TO INCLUDE ===
# REPLACE: Key facts/policies to communicate
# - Pricing: $15/user/month billed annually, $20/month monthly
# - Free trial: 14 days, no credit card required
# - Cancellation: Cancel anytime, no penalties
# - Nonprofit discount: 30% off with verification
# - Payment: All major credit cards, PayPal, wire transfer for enterprise

=== INSTRUCTIONS ===
Create a comprehensive FAQ section with:

1. 15-20 QUESTIONS organized by category such as:
   - Pricing & Billing
   - Getting Started
   - Features & Functionality
   - Account & Security
   - Technical Requirements

2. For each question:
   - Write the question exactly as a user would ask it
   - Provide a clear, direct answer (first sentence answers the question)
   - Add helpful context or next steps
   - Link placeholders to relevant pages

3. FORMATTING
   - Use actual question format ("How do I..." not "Information about...")
   - Keep answers concise (2-4 sentences typically)
   - Bold key information
   - Include specific numbers/facts, not vague language

4. SEO OPTIMIZATION
   - Questions should match natural search queries
   - Include FAQ schema-friendly formatting

5. OBJECTION HANDLING
   Turn common objections into questions with reassuring answers.

Summarization Prompts

Create Executive Summary

You are an executive communication specialist creating a summary for senior leadership.

=== DOCUMENT TO SUMMARIZE ===
# REPLACE: Paste the full document or key sections
# Note: If the document is very long, paste the most important sections
# and describe what the full document covers

=== DOCUMENT TYPE ===
What is this document: 
# REPLACE: (e.g., "Q3 Marketing Performance Report" or "Technical Architecture Proposal")

=== AUDIENCE ===
Who will read the summary: 
# REPLACE: (e.g., "C-suite executives with 5 minutes to decide on budget approval")

What they care about: 
# REPLACE: (e.g., "Bottom-line results, required investment, risk level")

=== DECISIONS NEEDED ===
# REPLACE: What decisions/actions should this summary drive?
# Example: "Approve additional $500K budget for Q4 marketing expansion"

=== LENGTH ===
Target length: 
# REPLACE: (e.g., "One page" or "300 words" or "5 bullet points")

=== INSTRUCTIONS ===
Create an executive summary that a busy executive can read in under 2 minutes:

1. ONE-SENTENCE OVERVIEW
   The bottom line in one sentence.

2. KEY METRICS/RESULTS (if applicable)
   3-5 most important numbers in a quick-scan format.

3. KEY FINDINGS
   - Top 3 findings (one sentence each with impact)

4. RECOMMENDATIONS
   Prioritized recommendations with expected impact.

5. DECISION/ACTION REQUESTED
   Clear statement of what's needed from the reader.

6. RISKS/CONSIDERATIONS
   Key risks or trade-offs to consider (brief).

7. TIMELINE
   Key dates or deadlines.

Use bullet points. Put most important information first.
Avoid jargon. Be specific with numbers and outcomes.

Extract Key Points

You are a research analyst extracting and organizing key information from a document.

=== CONTENT TO PROCESS ===
# REPLACE: Paste the content to extract key points from
# This could be: meeting notes, research paper, article, report, etc.

=== CONTEXT ===
Document type: 
# REPLACE: (e.g., "Industry analyst report on AI trends")

What it's about: 
# REPLACE: Brief description of the content

=== EXTRACTION GOALS ===
What do you need to extract:
# REPLACE: Mark what you need
# - Main arguments/points: YES
# - Data/statistics: YES
# - Quotes: YES
# - Action items: YES/NO
# - Decisions made: YES/NO
# - Questions raised: YES/NO
# - Names/people mentioned: YES/NO
# - Dates/deadlines: YES/NO

=== OUTPUT FORMAT ===
How will you use this:
# REPLACE: (e.g., "Create a one-page summary for my team" or "Prepare talking points for a meeting")

=== INSTRUCTIONS ===
Extract and organize key information:

1. MAIN POINTS
   - The 5-7 most important points, ranked by importance
   - One sentence each with context

2. KEY FACTS & FIGURES
   | Category | Data Point | Context |
   Extract all specific numbers, statistics, and quantifiable claims.

3. NOTABLE QUOTES (if applicable)
   Extract 3-5 most important quotes with attribution.

4. ACTION ITEMS / NEXT STEPS (if applicable)
   - Who | Action | Deadline (if mentioned)

5. DECISIONS (if applicable)
   What decisions were made or need to be made?

6. OPEN QUESTIONS
   What questions were raised but not answered?

7. CONNECTIONS & THEMES
   Identify 2-3 recurring themes or connections between points.

8. ONE-PARAGRAPH SUMMARY
   Synthesize all key points into a single paragraph.

Create TL;DR

You are a concise writer who excels at distilling information to its essence.

=== CONTENT ===
# REPLACE: Paste the content to summarize
# Can be: article, report, email thread, documentation, etc.

=== CONTEXT ===
What is this: 
# REPLACE: (e.g., "Company-wide announcement about new policy")

Audience: 
# REPLACE: (e.g., "All employees who receive too many emails")

=== TL;DR REQUIREMENTS ===
Max length: 
# REPLACE: (e.g., "2 sentences" or "Under 50 words" or "3 bullets max")

Must include: 
# REPLACE: What MUST be captured?
# Example: "The key date, what's changing, and who's affected"

=== INSTRUCTIONS ===
Create multiple TL;DR versions:

1. ONE SENTENCE
   The absolute essence in one clear sentence.

2. THREE BULLET POINTS
   The three things readers must know.

3. ONE PARAGRAPH (50 words)
   Slightly expanded summary for context.

4. SLACK/TEAMS MESSAGE FORMAT
   Ready to paste into team chat with appropriate emoji.

5. EMAIL SUBJECT LINE
   If this content were an email, what would the subject line be?

Each version should be standalone and complete. 
Prioritize: What changed? Who's affected? What action is needed?

Quick Reference

Tips for Better Writing Prompts

1. Be Specific About Audience

❌ "Write documentation for this API"
✅ "Write API documentation for backend developers integrating our 
    payment API. They're experienced with REST APIs but new to our platform."

2. Include Examples

# Instead of just describing, show an example:
# Example content that matches our style:
# "Click **Save** to update your profile. You'll see a confirmation 
# message at the top of the screen."

3. Specify Length Constraints

# Keep each step to one sentence
# Target word count: 1500-2000
# Summary should fit in a single Slack message

4. Define Technical Level

# Assume readers know: Basic JavaScript, npm
# Don't assume they know: TypeScript, our specific architecture

5. Set the Tone

# Tone: Professional but approachable, like explaining to a smart colleague
# Avoid: Marketing speak, buzzwords, overly casual language

6. Provide Context

# This documentation is for our enterprise product (not consumer)
# Users access this through a web browser, not mobile app
# We use American English spelling

7. State What Success Looks Like

# Success: A new developer can follow these docs and make their 
# first API call within 15 minutes without asking for help.

Workflow: Documentation from Scratch

Here’s how to combine prompts for a complete documentation project:

Step 1: Create the user guide Use: Write Software User Guide

Step 2: Create quick-reference materials Use: Create TL;DR (for quick start card)

Step 3: Develop FAQ from user questions Use: Generate FAQ Section

Step 4: Edit for your audience Use: Simplify Technical Content (if needed)

Step 5: Check quality Use: Check Style Guide Compliance + Proofread and Correct Errors

Step 6: Create release communication Use: Write Release Notes

What’s Next

• 📚 AI Prompts for Software Developers — Documentation for technical teams
• 📚 AI Prompts for Marketing — Content creation prompts
• 📚 Prompt Engineering Fundamentals — Master prompt techniques
• 🛠️ PRD Generator Tool — Generate requirements docs with AI

Found these prompts helpful? Share them with your writing team!