Documentation21 categories
Explain this for a non-technical reader
Writing for support, sales, or a stakeholder who needs the shape not the detail.
Rewrite the explanation below for a reader who is smart, busy, and not technical. Rules: - Lead with what it means for them, then how it works, then only the detail they need to act. - Replace every unavoidable technical term with a plain equivalent, or define it in the sentence where it first appears. List the terms you kept and why. - Use an analogy only where it earns its place, and state where the analogy breaks down. - Keep the numbers and the specifics. Simplifying is not the same as vagueness, and do not round away detail that affects a decision. - Do not talk down. No exclamation marks, no "simply", no "just". Afterwards, list anything you had to leave out that the reader might later need, so I can decide whether to add it back. Audience and what they need to do with this: Original:
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.
Editing and auditing docs. Finding what is stale or undocumented, cutting what the code already says, rewriting for the reader.
Related prompts
Which of these comments should exist?A file dense with comments that mostly narrate the code.Audit these docs for what is no longer trueDocumentation that was written once and never checked against the code again.Turn an internal spec into user-facing docsThe feature shipped and the only writing about it is the design doc.Does this comment earn its place?A comment you are not sure is worth the line it occupies.What is undocumented here?Code whose real behaviour has drifted past its documentation.Name this sectionA heading nobody will ever find by searching.
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