PhraseryPhrasery homeGet Phrasery
Documentation21 categories

Document a config option properly

Adding a setting that someone will have to tune under pressure.

Longconfigurationreferencewriting
Document the configuration option below.

Cover, in this order:
- **Name**, type, and the exact place it is set: file, environment variable, flag, or all three, with precedence stated
- **Default**, and why that default was chosen
- **What it controls**, described so a reader knows what will observably change
- **Valid range or values**, and what happens at the extremes
- **When you would change it**: at least two concrete situations, with the direction to move it
- **Interactions**: other options this affects or depends on
- **When it takes effect**: startup only, hot reload, per request
- **Failure mode**: what a wrong value does, whether it fails loudly at startup or misbehaves silently later

If the honest answer is "most people should never change this", write that as the first line.

Option:

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.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.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