Documentation21 categories
Check the docs against the code
A page you inherited and have no reason to trust.
Compare this doc against the code and list only what is now false: renamed flags, changed defaults, examples that would no longer run. Quote the sentence and the code that contradicts it. Do not rewrite anything, and do not list things you cannot verify from what I gave you. Docs: Code:
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.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.
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