AI Prompts for Gemini for Documentation

Write API documentation for this endpoint: [PASTE CODE OR DESCRIBE]. Include: description, request parameters, response schema, authentication, error codes, and a working example.

Generate docstrings for these functions: [PASTE CODE]. Make them accurate, include parameter types, return types, and any non-obvious behavior. Use [GOOGLE STYLE / NUMPY STYLE / STANDARD].

Write a README for this project: [DESCRIBE PROJECT OR PASTE KEY FILES]. Include: what it does, installation, quick start, configuration, and where to get help. Audience: [DEVELOPER TYPE].

Document this configuration file: [PASTE CONFIG]. Explain what each setting does, valid values, defaults, and the impact of each option.

Write an OpenAPI spec for this API: [DESCRIBE OR PASTE ROUTES]. Include all endpoints, request and response schemas, authentication, and example requests.

Write a getting started guide for [PRODUCT OR API]. Audience: [DESCRIBE USER]. Goal: get from zero to [FIRST SUCCESS] in under [TIME]. Assume they have [TECHNICAL LEVEL].

Write a how-to guide for [SPECIFIC TASK] using [PRODUCT OR TOOL]. Cover: prerequisites, step-by-step instructions, common mistakes, and how to verify it worked.

Write a migration guide from [OLD VERSION OR APPROACH] to [NEW VERSION]. List what changed, what breaks, step-by-step migration instructions, and how to test.

Turn this technical spec into a user-facing guide: [PASTE SPEC]. Audience: [DESCRIBE]. Rewrite for clarity without losing accuracy.

Write an integration guide for connecting [SYSTEM A] to [SYSTEM B]. Cover: prerequisites, setup steps, authentication, testing the connection, and troubleshooting.

Write a conceptual overview of [TECHNICAL CONCEPT] for developers new to [DOMAIN]. Explain: what it is, why it matters, how it works, and when to use it vs. alternatives.

Write an architecture doc for [SYSTEM] that a new developer joining the team can actually understand. Cover: key components, how they interact, data flows, and where to find different types of logic.

Write a decision guide for [TECHNICAL CHOICE]. Cover: the options, when to choose each, trade-offs, and the questions to ask to make the right choice.

Turn this dense technical document into something a mid-level developer can understand: [PASTE SOURCE]. Add examples, analogies, and plain-language explanations without changing accuracy.

Write a troubleshooting guide for [PRODUCT OR FEATURE]. Include: the 10 most common issues, what causes each, how to diagnose, and how to fix.

Format this technical documentation for Google Docs. Add: a table of contents, proper heading hierarchy (H1/H2/H3), and callout formatting for warnings and notes: [PASTE CONTENT].

Review this existing documentation and flag anything outdated, incomplete, or unclear: [PASTE DOCS]. Prioritize the fixes by user impact.

Write a documentation template for our team in Google Docs. We document [TYPE OF SYSTEM OR API]. Include: standard sections, placeholder instructions, and style guidelines.

Edit this documentation to be more concise: [PASTE]. Remove repetition, unnecessary preamble, and verbose explanations. Keep all the information, just fewer words.

Write an index page for this documentation set. Sections: [LIST SECTIONS AND BRIEF DESCRIPTIONS]. Format it as a navigable overview with one-line descriptions of each section.