AI Prompts for Claude for Code Documentation

Write a docstring for this function: [PASTE FUNCTION]. Include: what it does, parameters (name, type, description), return value, and one usage example. Follow [PYTHON/JAVASCRIPT/JAVA] conventions.

Add inline comments to this complex code block to explain the non-obvious logic: [PASTE CODE]. Focus on explaining why decisions were made, not restating what the code does.

Generate docstrings for all public functions in this file: [PASTE FILE]. Use [JSDOC / GOOGLE-STYLE / NUMPY-STYLE] format consistently throughout.

This code has no documentation and is difficult to follow. Add the minimum documentation needed to make it approachable to a developer seeing it for the first time: [PASTE CODE].

Write a comment block explaining this algorithm: [PASTE CODE]. Cover: the problem it solves, the approach, time and space complexity, and any important edge cases or assumptions.

Write a README for this project: [DESCRIBE PROJECT AND TECH STACK]. Include: description, prerequisites, installation, configuration, usage examples, and a contributing section.

Write a Getting Started guide for [PROJECT]. Assume the reader knows [LANGUAGE] but has never used this project. Cover setup, first working example, and the 3 most common operations.

Improve this README: [PASTE CURRENT README]. Make the project purpose immediately clear, improve the code examples to be runnable, and reorganize so the most-needed information is easiest to find.

Write a CONTRIBUTING.md for [PROJECT]. Include: dev environment setup, coding standards, test requirements, branch naming conventions, and PR process.

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

Document this API endpoint: [PASTE HANDLER CODE]. Include: path, method, description, request parameters (name, type, required/optional, validation), response schema, and example request/response.

Generate an OpenAPI 3.0 YAML specification for these endpoints: [PASTE ROUTES AND SCHEMAS]. Include all paths, methods, request bodies, response schemas, and auth requirements.

Write developer-facing documentation for this SDK function: [PASTE FUNCTION]. Focus on: how to use it, what it returns, common use cases, and error handling. Avoid implementation details.

Document the error codes returned by this API: [PASTE ERROR HANDLING CODE]. For each error: code, HTTP status, description, and what a developer should do when they receive it.

Write an authentication guide for this API: [PASTE AUTH CODE]. Explain the auth method, how to obtain credentials, the token lifecycle, and a working example in [LANGUAGE].

Write an architecture overview for this system: [DESCRIBE COMPONENTS AND INTERACTIONS]. Include: component descriptions, data flow diagram in text format, and key design decisions made.

Write an Architecture Decision Record for this decision: [DESCRIBE DECISION]. Include: context and problem, options considered, decision, rationale, and consequences.

Document the data model for this schema: [PASTE SCHEMA]. For each entity: purpose, key fields, relationships to other entities, and any important constraints.

Write a runbook for this operation: [DESCRIBE OPERATION]. Include: prerequisites, step-by-step instructions, verification steps, common errors, and rollback procedure.

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