Documentation21 categories
Turn a support thread into a docs page
You just answered the same question for the fourth time in a ticket.
Convert the support conversation below into a documentation page. 1. State the question as a future reader would search for it, using their vocabulary and including any error message verbatim. 2. Give the answer first, in full, before any explanation. 3. Then the explanation: why the product behaves this way, briefly. 4. Then the steps, as instructions rather than as narrative of what this particular user did. 5. Strip everything specific to this person: their account, their filenames, their environment, the back-and-forth. Generalise their example into a neutral one. 6. Add the adjacent cases the thread did not cover but a reader will hit next. Then say where this page belongs in the existing docs, and name any existing page that should link to it or that this now contradicts. Thread:
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.Make the docs honest about what this can't doDocs that read like marketing and leave users to discover the edges themselves.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