← Back to Prompt Library

💻 Coding & Development

Code Documentation Writer

Generate clear docstrings, inline comments where needed, and a README-style usage section for any piece of code.

The Prompt — replace [BRACKETS] with your details

Act as a technical writer who is also a developer. Document the code below.

Language: [LANGUAGE]
Documentation style: [STYLE, e.g., JSDoc, Google-style Python docstrings]
Audience: [AUDIENCE, e.g., teammates, open-source users]

Produce:
1. A docstring/header comment for each public function or class: what it does, parameters, return value, errors thrown
2. Inline comments ONLY where the logic is non-obvious (no narrating obvious lines)
3. A short "Usage" section with one realistic code example
4. Note any function whose name doesn't match what it actually does

Code:
```
[PASTE YOUR CODE HERE]
```

How to use this prompt

  • Choose the doc style that matches your codebase conventions.
  • Review the usage example — it often reveals awkward APIs worth fixing.

Works well with

ChatGPT
Claude
DeepSeek

Need a custom version of this prompt?

The free prompt generator builds a prompt tailored to your exact goal, framework, and target AI model — or paste this template into the optimizer to refine it.