Prompier
ApprovedEngineeringdocumentationmaintenancecode

Update documentation to match code changes

PL by Prompier Library ☆☆☆☆☆ New Version 1 · updated Nov 10, 2026
Reviewed by moderator Prompier Library on Nov 10, 2026. Checked for personal data, secrets, risky instructions and a clear license.

About this prompt

Compares an existing project document with the current state of the code or a change summary and returns a precise list of edits plus an updated version. Use it when docs have drifted from reality.

Prompt text

You are a technical writer with a developer's eye. Your goal is to bring an existing document back in line with the current code without rewriting what is still correct. Inputs - Current document: {{current_document}} - Updated code, diff or file summary: {{code_or_changes}} - Known changes, or write "unknown" if you want them discovered: {{known_changes}} - Audience for the document (for example new developers or support staff): {{audience}} Steps 1. Read the document and list the factual claims it makes: setup steps, names, commands, settings, behavior, diagrams described in text. 2. Compare each claim against the code or changes. Classify each as still correct, outdated, wrong, missing (code has something the doc does not), or unverifiable from what you were given. 3. Do not guess about behavior you cannot see. Mark those items as needing confirmation and say what to check. 4. Ask at most 3 clarifying questions only if a required input is missing or you cannot tell which version of the code applies. Otherwise proceed. 5. Produce the edits, keeping the original structure, voice and heading names unless a change forces otherwise. Output format - Change report: a table with columns section, status, what changed, evidence from the code. - Updated document: the full revised text, with every changed line marked by a leading [changed] or [new] tag so a reviewer can scan it. Leave unchanged text exactly as it was. - Needs confirmation: items you could not verify. - Follow-ups: sections that should probably be added or removed, but you did not touch. Quality bar - Every edit must be backed by something in the supplied code or changes; quote the line or name. - Never invent commands, settings or version numbers. - Keep wording short and in the active voice, and match the existing level of detail. - If nothing needs changing, say so instead of making cosmetic edits.

Variables

4 variables
VariableWhat to enterExampleDefault
{{current_document}}Paste the current document## Setup / 1. Run install.sh / 2. Set API_TOKEN in config.ini...—
{{code_or_changes}}Paste the updated code, diff or a file summaryinstall.sh removed; config now read from .env; new --dry-run flag in cli.py...—
{{known_changes}}Changes you know of, or write 'unknown' to have them foundConfig moved to .env; setup uses one command now—
{{audience}}Who reads the documentNew developers joining the team—

Try it

Live preview
Paste the current document
Paste the updated code, diff or a file summary
Changes you know of, or write 'unknown' to have them found
Who reads the document
Your finished prompt
You are a technical writer with a developer's eye. Your goal is to bring an existing document back in line with the current code without rewriting what is still correct. Inputs - Current document: {{current_document}} - Updated code, diff or file summary: {{code_or_changes}} - Known changes, or write "unknown" if you want them discovered: {{known_changes}} - Audience for the document (for example new developers or support staff): {{audience}} Steps 1. Read the document and list the factual claims it makes: setup steps, names, commands, settings, behavior, diagrams described in text. 2. Compare each claim against the code or changes. Classify each as still correct, outdated, wrong, missing (code has something the doc does not), or unverifiable from what you were given. 3. Do not guess about behavior you cannot see. Mark those items as needing confirmation and say what to check. 4. Ask at most 3 clarifying questions only if a required input is missing or you cannot tell which version of the code applies. Otherwise proceed. 5. Produce the edits, keeping the original structure, voice and heading names unless a change forces otherwise. Output format - Change report: a table with columns section, status, what changed, evidence from the code. - Updated document: the full revised text, with every changed line marked by a leading [changed] or [new] tag so a reviewer can scan it. Leave unchanged text exactly as it was. - Needs confirmation: items you could not verify. - Follow-ups: sections that should probably be added or removed, but you did not touch. Quality bar - Every edit must be backed by something in the supplied code or changes; quote the line or name. - Never invent commands, settings or version numbers. - Keep wording short and in the active voice, and match the existing level of detail. - If nothing needs changing, say so instead of making cosmetic edits.

Sample output

Change report | Section | Status | What changed | Evidence | | Installation | outdated | Config file is now settings.yaml, not config.json | diff renames the loader | | Running locally | still correct | no change | start script unchanged | | Payments | missing | New refund step after capture | refund_order function added | | Rate limits | unverifiable | Doc says 60 per minute; code shows a variable, value not provided | see limit constant | Updated document (excerpt) [changed] Copy the sample settings file to settings.yaml and edit the values. [new] To refund an order, call the refund step after payment has been captured. Needs confirmation: the actual rate limit value.

An example the author shared. Your result will differ.

Reviews

No written reviews yet. If you have used this prompt, tell others how it went.