Coding
Developer Documentation
Developer Documentation turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
The prompt
Developer Documentation guides the model through a defined task while preserving the source prompt's useful structure and constraints. It specifically covers Developer Documentation, Clarifying questions (if needed), Assumptions. Use it when planning, writing, reviewing, or debugging software and you want a response that is easier to evaluate and act on.
text prompt
You are a staff software engineer.
Task:
Write clear developer documentation for this feature: Overview; Setup instructions; Usage examples; Common pitfalls. Feature notes: {{sourceText}}.
Inputs:
- Paste: {{sourceText}}
Additional engineering requirements:
- If you propose code changes, provide them as either a unified diff or complete file contents.
- For multi-file outputs, use this format:
- File: path/to/file.ext
- Then a code block with the full file content
- Include a test plan. If applicable, include unit tests.
- Call out security, performance, and backwards compatibility risks.
- Prefer production-ready output over pseudocode when enough context is provided.
Output format:
# Developer Documentation
## Clarifying questions (if needed)
List up to 6 questions. If you can proceed, write "None".
## Assumptions
List the assumptions you made to proceed.
## README-style documentation
Provide the deliverable in a copy-paste ready format.
## Quality checks
A short checklist verifying the output meets the requirements.
## Next steps
Concrete next actions, ordered.
Tune the prompt, not the plumbing.
Every control comes from this prompt’s content schema. Changes stay in your browser and update instantly.
Customized prompt1164 characters
You are a staff software engineer.
Task:
Write clear developer documentation for this feature: Overview; Setup instructions; Usage examples; Common pitfalls. Feature notes: Paste the relevant source material and context here..
Inputs:
- Paste: Paste the relevant source material and context here.
Additional engineering requirements:
- If you propose code changes, provide them as either a unified diff or complete file contents.
- For multi-file outputs, use this format:
- File: path/to/file.ext
- Then a code block with the full file content
- Include a test plan. If applicable, include unit tests.
- Call out security, performance, and backwards compatibility risks.
- Prefer production-ready output over pseudocode when enough context is provided.
Output format:
# Developer Documentation
## Clarifying questions (if needed)
List up to 6 questions. If you can proceed, write "None".
## Assumptions
List the assumptions you made to proceed.
## README-style documentation
Provide the deliverable in a copy-paste ready format.
## Quality checks
A short checklist verifying the output meets the requirements.
## Next steps
Concrete next actions, ordered.
Useful structure, room to move.
Developer Documentation guides the model through a defined task while preserving the source prompt's useful structure and constraints. It specifically covers Developer Documentation, Clarifying questions (if needed), Assumptions. Use it when planning, writing, reviewing, or debugging software and you want a response that is easier to evaluate and act on.
The prompt establishes the job first, then supplies concrete decisions a model can act on. The variables preserve that structure while letting you change the subject, context, or output.
Related prompts
Minimal Reproducible Example
Minimal Reproducible Example turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini
API Endpoint Specification
API Endpoint Specification turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini
Code Style Guide Creator
Code Style Guide Creator turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini
Codebase Explainer
Codebase Explainer turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini