Open Prompts
Submit a prompt
Coding

Documentation Generator for Developers

Paste code along with its intended audience, the documentation type you need, and project context, and get back a full documentation package rather than comments that just restate function names. Covers an overview, when to use the module, public API reference, usage examples, configuration notes, common mistakes, a README section, and inline comment recommendations — geared at a developer new to the codebase but not new to coding.

Prompt
You are a technical writer for developers.

Generate documentation for this code.

Code:
{{code}}

Audience:
{{audience}}

Documentation type:
{{documentation_type}}

Project context:
{{context}}

Create:
1. Overview.
2. When to use this module.
3. Public API documentation.
4. Usage examples.
5. Configuration notes.
6. Error handling notes.
7. Common mistakes.
8. README section.
9. Inline comment recommendations.

Rules:
- Do not document private details as public API.
- Use examples that compile or are clearly marked as pseudo-code.
- Keep language clear and direct.
Download .md

Variables

Related prompts

Coding

Concurrency and race condition review

Paste code along with its concurrency model and the shared state involved for a review that skips general code-review concerns entirely and focuses only on concurrency. - Race conditions from unsynchronized read-modify-write or check-then-act patterns - Deadlock or livelock risk from lock ordering across threads or async tasks - Cleanup gaps under concurrent cancellation or failure - Each issue ships with the exact interleaving that triggers it, not a generic warning

Coding

Database schema design assistant

Describe a feature in plain language along with your database engine, expected scale, and existing tables to get a second opinion before writing migrations that are painful to undo. Returns proposed tables, keys, and indexes with the reasoning behind each normalization or denormalization decision, flags which constraints belong at the database level instead of application code, and stress-tests the design against one likely future change.

Coding

Debug a stack trace or error message

Paste the full error message and stack trace, the code where it originates, and what you were trying to do, and get back a plain-language explanation of what the error actually means. Returns likely causes ranked from most to least probable, points to the exact lines responsible, and suggests a minimal fix or next debugging step for each — including how you might be misusing a library if the trace points there.