AI Prompts for ChatGPT for Documentation

Write a README for this project: [DESCRIBE PROJECT, ITS PURPOSE, AND TECH STACK]. Include a one-paragraph overview, installation steps, a quick start example, configuration reference, and contribution guidelines.

My README is too long and developers skip it. Here is the current version: [PASTE README]. Rewrite it to be scannable, lead with value, move detailed reference content to separate docs pages, and add clear section headers.

Write a CONTRIBUTING.md for [DESCRIBE PROJECT]. Cover the development setup, branch naming, commit message format, PR process, and code review expectations.

Create a CHANGELOG template and write the first three entries for these releases: [DESCRIBE CHANGES PER VERSION]. Follow Keep a Changelog format and clearly separate breaking changes from improvements.

Write a troubleshooting guide for [DESCRIBE COMMON ISSUES USERS FACE]. For each issue, explain the symptom, the likely cause, and the fix in a clear step-by-step format.

Write JSDoc or TSDoc comments for these functions: [PASTE FUNCTIONS]. Include param descriptions, return type descriptions, thrown errors, and a usage example for each function.

Document this API endpoint: [PASTE ENDPOINT DEFINITION]. Write the full reference entry with method, URL, authentication, request parameters, response schema, error codes, and a curl example.

I need to write an SDK quickstart guide for [DESCRIBE SDK]. Cover installation, authentication, the first API call, handling errors, and three common use cases with complete code examples.

Convert these inline code comments into a proper reference document: [PASTE COMMENTED CODE]. Organize by component, write clear descriptions, and add an overview section that explains how the pieces work together.

Write the reference documentation for this configuration schema: [PASTE SCHEMA OR TYPE]. Document every field with its type, default value, whether it is required, valid options, and an example.

Write a getting started tutorial for [DESCRIBE PRODUCT OR FEATURE]. Assume the reader is a developer who has never used it. Lead them from installation to their first working result in under 10 minutes.

I need a how-to guide for [DESCRIBE TASK, E.G. "SETTING UP AUTHENTICATION WITH THIS LIBRARY"]. Write it as a numbered walkthrough with code snippets, expected outputs, and notes for common variations.

Convert this technical specification into a user-facing guide: [PASTE SPEC]. Remove internal jargon, focus on what users need to do rather than how it works internally, and add examples for each step.

Write a migration guide from [VERSION A] to [VERSION B] of [DESCRIBE LIBRARY OR API]. List every breaking change, show the before and after code for each change, and give an estimated migration effort.

Create a conceptual explainer for [DESCRIBE TECHNICAL CONCEPT] aimed at developers who are new to [TOPIC]. Use analogies, avoid unnecessary jargon, and build understanding progressively with examples.

Audit this documentation site structure: [PASTE NAV OR PAGE LIST]. Identify gaps, overlapping content, and pages that belong in a different section. Suggest a reorganized structure based on user goals.

I need to choose a documentation tool for [DESCRIBE PROJECT: TEAM SIZE, CONTENT TYPE, HOSTING NEEDS]. Compare [DOCUSAURUS, MINTLIFY, GITBOOK, OR OTHERS] for my case and recommend the best fit.

Create a documentation style guide for my team. Cover voice and tone, code example standards, heading hierarchy, when to use notes vs warnings, and how to handle versioned content.

Write a plan to improve docs for [DESCRIBE AREA]. Prioritize by user impact, identify who owns each page, and define what "good" looks like so the team has a consistent target.

I need to set up a docs-as-code workflow. Write the GitHub Actions workflow that lints markdown, validates internal links, checks for broken code examples, and deploys to [DESCRIBE PLATFORM] on merge.