AI Prompts for ChatGPT for Code Documentation

Write a docstring for this function: [PASTE FUNCTION]. Include: description, parameters (name, type, description), return value, and one usage example.

Add inline comments to this complex code block to explain what each section does: [PASTE CODE]. Focus on explaining why, not just what.

Write JSDoc / Python docstrings / JavaDoc comments for all functions in this file: [PASTE FILE]. Follow the standard format for [LANGUAGE].

This code has no comments and is hard to follow. Add the minimum necessary comments to make it understandable to a developer who has never seen it: [PASTE CODE].

Write a comment block explaining this algorithm: [PASTE CODE]. Include: what problem it solves, the approach used, time complexity, and any key assumptions.

Write a README for this project: [DESCRIBE PROJECT]. Include: project name, description, installation instructions, usage examples, and a contributing section.

Write a Getting Started guide for [PROJECT/LIBRARY]. Assume the reader is a developer who knows [LANGUAGE] but has never used this project. Cover: installation, configuration, first usage, and a working example.

I have this README: [PASTE README]. Improve it by: clarifying the project purpose, adding better code examples, and organizing it so developers can find what they need in under 60 seconds.

Write a CONTRIBUTING.md for this project. Cover: how to set up the dev environment, coding standards, how to run tests, and the PR process.

Write a CHANGELOG entry for this release: [DESCRIBE CHANGES]. Follow the Keep a Changelog format with sections for Added, Changed, Fixed, and Removed.

Write API documentation for this endpoint: [PASTE ENDPOINT CODE]. Include: endpoint path, method, description, request parameters (name, type, required/optional, description), response schema, and an example request/response.

Generate OpenAPI/Swagger specification for these endpoints: [PASTE CODE]. Include all routes, request/response schemas, and error codes.

Write a developer guide section explaining how to authenticate with this API: [PASTE AUTH CODE]. Include: the authentication method, how to obtain credentials, and a working code example in [LANGUAGE].

Document these error codes for our API: [PASTE ERROR HANDLING CODE]. For each error: code, HTTP status, description, and suggested action for the developer.

Write SDK documentation for this function: [PASTE FUNCTION]. Make it consumer-focused: emphasize how to use it, what it returns, and common use cases rather than implementation details.

Write an architecture overview document for this system: [DESCRIBE SYSTEM COMPONENTS AND HOW THEY INTERACT]. Include: component descriptions, data flow, and the key design decisions made.

Write an Architecture Decision Record (ADR) for this decision: [DESCRIBE THE DECISION]. Include: context, options considered, the decision made, and the tradeoffs accepted.

Document the data model for this schema: [PASTE SCHEMA]. For each entity, describe its purpose, key fields, and how it relates to other entities.

Write a runbook for this operation: [DESCRIBE OPERATION E.G., DEPLOYING TO PRODUCTION / RECOVERING FROM A FAILURE]. Include step-by-step instructions, verification steps, and rollback procedure.

Write a troubleshooting guide for the most common issues with [SYSTEM/SERVICE]. Include: symptoms, root causes, diagnostic steps, and resolution for each issue.