Document how code works
Explain contracts and examples without inventing behavior.
What this starting point does
Document the supplied code for a developer taking ownership. This is an editable instruction template, not a claim of tested performance on a particular model.
Make the inputs yours
- Code to document — fill
{{CODE}}with your own material, preserving line breaks where useful. This input is required for a filled prompt.
Reusable template
## Task
Document the supplied code for a developer taking ownership.
## Constraints
- Base claims on the supplied implementation.
- Identify unclear behavior rather than guessing.
- Keep examples consistent with the API.
## Output format
Purpose, inputs, outputs, side effects, examples, and limitations
## Reference material
<source_material>
{{CODE}}
</source_material>A filled example
This example uses fictional demonstration material. It is an example prompt, not a generated answer or image.
## Task
Document the supplied code for a developer taking ownership.
## Constraints
- Base claims on the supplied implementation.
- Identify unclear behavior rather than guessing.
- Keep examples consistent with the API.
## Output format
Purpose, inputs, outputs, side effects, examples, and limitations
## Reference material
<source_material>
function total(prices) {
return prices.reduce((sum, value) => sum + value, 0);
}
</source_material>Before using it
Review every instruction and replace the example material. Check that its constraints fit your task. The structural Analyzer can flag specific issues, but cannot verify facts or guarantee the quality of a model’s response.
Customize this template