Documentation21 categories
Make the docs honest about what this can't do
Docs that read like marketing and leave users to discover the edges themselves.
Read the documentation below alongside the code or spec, and write the limitations section it is missing. Identify: - Things the docs imply are supported but are not, including anything promised in a feature name - Hard limits: sizes, rates, counts, timeouts, and what happens when each is exceeded - Cases that work but perform badly, with the threshold where it degrades - Known bugs and unimplemented paths, with issue links if available - Assumptions the system makes about its environment or input that it does not validate Write the section in plain language, one bullet per limitation, stating what happens rather than what is not supported. Where a workaround exists, give it. Where none exists, say so without softening. Also flag every sentence in the existing docs that overpromises, quoted, with a corrected version. Docs: Code or spec:
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.
Runbooks and support. What to do at 3am, the failures that keep arriving, and the limits nobody wrote down.
Related prompts
Write a runbook for someone woken at 3amAn alert exists and the only person who knows what to do is on holiday.Build a troubleshooting page from real failuresThe same three problems keep arriving in your support inbox.Turn a support thread into a docs pageYou just answered the same question for the fourth time in a ticket.Write the limitations bulletsDocs that describe the happy path and stop.Structure a README that gets someone runningA project with working code and a README that says only its name.Generate API reference from this codeA module whose public surface needs documenting properly, not just typed.
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