Documentation21 categories
Document every error this can return
Users hit an error code and find nothing when they search it.
Produce documentation for the errors in the code below. Give a table, one row per error, with: code or identifier, the exact message text a user sees, what actually causes it, whether it is the caller's fault or ours, whether retrying helps, and the fix. Then, for the errors users will meet most often, write a short section each: what happened, the most likely cause, the check that confirms it, and the resolution. Use the exact message as the heading so a search engine finds it. Also report: - Errors with identical or near-identical messages that a user could not tell apart - Errors whose message does not say what to do next - Failure paths that produce no error at all and fail silently Do not invent error conditions that are not in the code. Code:
Making it yours
- Paste your own material where the prompt asks for it. Everything above that line is instruction, not content.
- Delete any rule that does not apply to you. A shorter prompt that fits beats a thorough one that does not.
- If the answer comes back vague, add a line saying what you do not want. Constraints work better than encouragement.
Reference and API docs. The lookup layer: function docs, config options, error codes and examples worth copying.
Related prompts
Generate API reference from this codeA module whose public surface needs documenting properly, not just typed.Write the doc comment this function deservesA function whose name and types don't tell the whole story.Document a config option properlyAdding a setting that someone will have to tune under pressure.Write examples that aren't toysDocs whose only example is foo and bar and helps nobody.Write the exampleA reference entry with no example, which is most of them.Explain this optionA setting whose name tells you nothing about what it does.
Keep this one
Phrasery saves prompts with a right-click and puts them back the same way. Add this to your own library in one click.
Add to your browser โ free