Documentation21 categories
Audit these docs for what is no longer true
Documentation that was written once and never checked against the code again.
Compare the documentation below against the code or product as it is now, and find what has gone stale. Report in four groups: - **Wrong**: statements that are now false. Quote the sentence and the code that contradicts it - **Outdated**: flags, endpoints, filenames, or versions that have been renamed, moved, or removed - **Missing**: behaviour that exists but is documented nowhere - **Suspicious**: statements you cannot verify from what I gave you, with the specific thing I should check Also flag: examples that would no longer run, links likely to be dead, screenshots described in text that no longer match, and anything dated by a phrase like "coming soon" or "currently". Rank the findings by how much damage each does to a reader who trusts it. Do not rewrite anything yet. Docs: Code or current behaviour:
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.Explain this for a non-technical readerWriting for support, sales, or a stakeholder who needs the shape not the detail.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