Skip to content
New this week26 prompts for Sora, Veo and Runway video workflows.
Explore video prompts→
AIPrompt123Prompt library

Search AIPrompt123

Search prompts, categories, platforms and repositories

Write documentation for a public function

Write documentation for a public function with a prompt built for ChatGPT and Claude. It supplies context, constraints and an output contract, then asks the model to surface assumptions and gaps. Copy it, fill the variables and treat the result as a structured draft, not a final answer.

4.9(61 ratings)435 copies
Updated By Author
40 words · v1.2

Fill in the blanks · 2 variables

ChatGPT promptReplace every highlighted token before sending
Write documentation for this function following {style}. Include a one-line summary, parameters, return value, errors thrown, a minimal example and an edge case. Explain the why, not just the what. Do not restate the implementation line by line.

Code:
{code}

---
Platform note: Work through the task step by step, then give the final answer in the requested format. Ask one clarifying question if a required detail is missing.
Open in ChatGPT

Comments

Share what worked, what broke and which model you used. Comments appear after posting and are moderated for spam.

Saved with an anonymous browser ID. No login needed.

How to use this prompt

  1. 1

    Open ChatGPT and start a new chat. Paste the prompt exactly as written.

  2. 2

    Replace each placeholder ({style}, {code}) with your own details. Leave the instructions and the output format untouched.

  3. 3

    Add one concrete example or data point if the model's first answer is vague. Specific input produces specific output.

  4. 4

    Run it once, then ask for a single revision with a specific critique rather than regenerating from scratch.

  5. 5

    Review the result. Reproduce the bug, review the diff and run the tests in a clean environment.

Worked example

This is the kind of input the prompt expects and the shape of output it produces. Your result will differ with the model and the details you supply.

Example input

Style: your style Code: Paste the function or file here.

Example output

**Diagnosis:** the handler reads `req.body` before the JSON middleware runs, so the body is undefined on POST requests. **Fix:** move the middleware above the route registration and add a guard for missing bodies. No public API changes. **Verification:** added a failing test for an empty JSON body, confirmed it fails, applied the fix, then ran the full suite. The test now passes and the unrelated snapshot tests are unchanged.

Tips for a better result

  • Paste the full error and the smallest relevant code, not a screenshot of the stack trace.
  • Ask for a plan before allowing multi-file edits; it prevents sprawling refactors.
  • Require a failing test first and a verification command at the end.
  • Change one variable at a time and compare the outputs; it is the fastest way to learn what this model responds to.

Common mistakes

  • Accepting a confident fix without reproducing the bug or running tests.
  • Letting the assistant rewrite entire files when a three-line diff would do.
  • Pasting secrets, tokens or customer data into a hosted model.
Verified Knowledge · FAQ

Questions about this prompt

Practical answers about running the write documentation for a public function prompt.

Related prompts

Same job, a different angle — or the next step in the workflow.

Design a rate limiter

Design a rate limiter with a prompt built for Claude and ChatGPT. It supplies context, constraints and an output contract, then asks the model to surface assumptions and gaps. Copy it, fill the variables and treat the result as a structured draft, not a final answer.

ClaudeChatGPTDeepSeek
4.8(66)368 copies
Coding & Developer
Intermediate

Convert a design into accessible components

A coding prompt for convert a design into accessible components. It gives v0 and Cursor a clear role, explicit constraints and a defined output, so the first answer is closer to usable. Fill in the variables, run it once, then use the verification notes on this page to review the result.

v0CursorChatGPT
4.7(65)510 copies

Review a pull request by severity

A coding prompt for review a pull request by severity. It gives Claude and Cursor a clear role, explicit constraints and a defined output, so the first answer is closer to usable. Fill in the variables, run it once, then use the verification notes on this page to review the result.

ClaudeCursorGitHub Copilot
4.7(20)534 copies

Written and reviewed by Author

AIPrompt123 Contributor

Contributing author and prompt engineer at AIPrompt123.

Last reviewed 12 March 2026 · version 1.2 · tested on ChatGPT, Claude, GitHub Copilot