Documentation21 categories
Explain this option
A setting whose name tells you nothing about what it does.
Shortconfigurationreference
Explain what this setting actually changes, what the default does, and when I would move it. Three short paragraphs.
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.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.
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