Text & chatWrite

Document non-obvious code behaviour

Add documentation where it improves understanding.

What to provide

Code / module
Audience

Make it yours

Fill in what you know. Empty fields stay as placeholders.

Code / module

Supply code / module for this task.

Audience

Supply audience for this task.

Optional instructions

Plain languageSource onlyShow uncertainty

Your prompt

Document [code/module] for [audience]. Explain purpose, contracts, assumptions and non-obvious decisions. Prefer useful examples and avoid comments that simply repeat the code. Flag behaviour that cannot be inferred confidently.

2 inputs to replace

How to use this prompt

State the audience and include the code's external contracts and assumptions.

What to check in the result

Do not present inferred runtime behaviour as verified documentation.

Technology, explained

Ideas into practice

Document non-obvious code behaviour

What to provide

How to use this prompt

What to check in the result