Prompt lesson · 22 prompts
API Documentation Assistance prompts for Website Developers
22 ready-to-use prompts from our AI for Website Developers course. Copy one, fill in the {{placeholders}}, and paste it into ChatGPT, Claude, Gemini or any other AI.
API Change Management Framework
Use this when you need to establish a systematic process for tracking, documenting, and communicating API changes to minimize disruption.
Role You are an API change management specialist who helps teams design and implement robust processes for managing API evolution with minimal disruption.
Context you provide
- {{specific API}} — the API or API family you need to manage.
- {{current process}} — any existing change management practices or tools (optional).
- {{stakeholders}} — who needs to be informed of changes (e.g., internal developers, external partners).
Instructions
- If any required context is missing, ask for it before proceeding.
- Design a comprehensive change management framework that includes: versioning strategy, change categorization (major/minor/patch), impact assessment, approval workflow, and communication plan.
- Provide a template for a centralized change log or repository, including fields for change description, version, date, impact, and status.
- Outline a process for gathering and incorporating user feedback on changes.
- Include a checklist for managing change communications, covering pre-change, during, and post-change phases.
- Anticipate common challenges (e.g., backward compatibility, deprecation, coordination) and suggest mitigations.
Output format A structured framework document with clear sections, bullet points, and a sample change log entry. Use professional, concise language.
Guardrails
- Do not invent specific tools or APIs; recommend categories and best practices.
- Flag any assumptions about the existing infrastructure.
- Stay focused on change management, not general API design.
Example Specific API: "Payment Gateway API", current process: "ad-hoc emails", stakeholders: "internal dev team, external partners".
Open this prompt Planning · Advanced
API Integration Documentation
Use this when you need clear, step-by-step documentation for integrating an API with a specific platform or system.
Role You are a technical writer and API integration specialist. Your goal is to produce clear, accurate, and actionable integration documentation that enables developers to successfully connect an API to a target platform.
Context you provide
- {{api_name}}: The name of the API you are integrating.
- {{target_platform}}: The platform or system you are integrating with (e.g., Shopify, Salesforce, mobile app).
- {{technology_stack}}: The relevant technologies or frameworks involved (e.g., Node.js, Python, REST).
- {{specific_requirements}}: Any specific configurations or constraints (e.g., authentication method, data mapping).
Instructions
- If any inputs are missing, ask for them before starting.
- Outline the integration process step by step, including prerequisites, configuration, and code examples where applicable.
- Highlight best practices for security, error handling, and performance.
- Anticipate common challenges and provide troubleshooting tips.
- Include a testing checklist to verify the integration works correctly.
Output format Provide a structured document with sections: Overview, Prerequisites, Step-by-Step Integration, Configuration Details, Code Examples, Best Practices, Troubleshooting, and Testing Checklist. Use clear headings and code blocks. Keep the tone technical and precise.
Guardrails
- Do not invent API endpoints or parameters; use only the provided information or clearly mark placeholders.
- Stay within the scope of the specified API and platform.
- Flag any assumptions about the API's capabilities.
Example API name: Stripe Payment API; target platform: Shopify; technology stack: Node.js; specific requirements: use Stripe Connect for marketplace payments.
Open this prompt Writing · Intermediate
API Usage Guidelines
Use this when you need to establish best practices for API authentication, performance, rate limits, and error handling.
Open this prompt Research · Intermediate
API Versioning Strategy
Use this when you need to design and document a versioning strategy for your API to ensure compatibility and smooth transitions.
Open this prompt Planning · Intermediate
Authentication Documentation
Use this when you need to create detailed, step-by-step authentication documentation for an API integration.
Open this prompt Writing · Intermediate
Automated API Testing System
Use this when you need to design and implement an automated testing system for your API that generates detailed documentation of results.
Open this prompt Automation · Advanced
Comprehensive API Error Handling Guide
Use this when you need to create a detailed guide for handling and documenting API errors, including best practices and code examples.
Open this prompt Creating · Intermediate
Create API Troubleshooting Guide
Use this when you need a comprehensive guide to diagnose and resolve common API issues.
Open this prompt Creating · Intermediate
Create Interactive API Docs
Use this when you want to design or improve interactive API documentation that lets developers test endpoints and explore functionality directly.
Open this prompt Creating · Advanced
Customizable API Documentation Templates
Use this when you need to create consistent, well-structured API documentation templates that can be easily customized for different projects.
Open this prompt Creating · Intermediate
Data Format Documentation
Use this when you need to document the expected data formats for API request and response payloads, including fields, types, and error responses.
Open this prompt Writing · Intermediate
Detailed API Endpoint Descriptions
Use this when you need comprehensive descriptions of API endpoints, including parameters, response formats, and error handling.
Open this prompt Writing · Intermediate
Develop API Usage Analytics
Use this when you need to track and analyze API usage to gain insights for developers.
Open this prompt Analysis · Advanced
Document API Error Handling
Use this when you need to create or improve documentation for API error responses and how to handle them.
Open this prompt Writing · Intermediate
Document API Parameters
Use this when you need to create or refine documentation for the parameters required by API endpoints.
Open this prompt Writing · Intermediate
Generate API Code Examples
Use this when you need code examples for using API endpoints in various programming languages.
Open this prompt Coding · Intermediate
Implement API Security Best Practices
Use this when you need to secure your APIs and document security measures effectively.
Open this prompt Creating · Intermediate
Manage API Versioning Docs
Use this when you need to document API version changes and manage versioning documentation effectively.
Open this prompt Planning · Advanced
Optimize API Performance
Use this when you need to improve API response times and user experience through performance optimization.
Open this prompt Analysis · Intermediate
Provide API Usage Examples
Use this when you need practical, real-world examples of how to use an API in different scenarios.
Open this prompt Creating · Beginner
Step-by-Step API Integration Tutorials
Use this when you need to create detailed tutorials for integrating APIs into web applications, covering authentication, data fetching, and other tasks.
Open this prompt Creating · Intermediate
Write API Testing Docs
Use this when you need to create instructions and test cases for verifying API endpoint functionality.
Open this prompt Writing · Intermediate