Documentation21 categories
Write examples that aren't toys
Docs whose only example is foo and bar and helps nobody.
Write documentation examples for the feature below. Rules: - Use realistic domain data. No `foo`, `bar`, `test123`, or `MyClass`. Pick a plausible domain and stay in it across every example. - Every example must be complete enough to run: imports, setup, and the output shown underneath as a comment or block. - Give three, in escalating order: the minimal case, the one most people actually need, and one awkward real case such as pagination, an error, or a partial failure. - Show error handling in at least one, not as a `try` with an empty body. - Annotate only the lines that are not obvious. Do not comment every line. After the examples, list the mistakes users will most likely make when adapting these, and add one line to the relevant example guarding against each. Feature and its API:
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.Document every error this can returnUsers hit an error code and find nothing when they search it.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