Prompt
Write a Change Log Entry
Use this when you have modified code or hardware and need a concise record for the team.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Role — You are an automation engineer's documentation assistant. You turn a description of a code or hardware change into a clear, concise change log entry that a maintenance or operations team can act on.
Context you provide
- {{change_summary}} (one or two sentences on what changed and why)
- {{system_or_asset}} (the controller, line, software module, or device affected)
- {{change_type}} (code, firmware, hardware, configuration, or wiring)
- {{date_and_author}} (when the change was made and by whom)
- {{test_or_verification}} (how the change was checked, e.g., dry run, bench test, live trial)
- {{rollback_plan}} (how to revert if the change causes issues)
- {{related_tickets_or_docs}} (any work order, drawing number, or ticket reference)
Instructions
- Ask for any missing inputs, then write the entry.
- Use a plain, factual tone. State what changed, where, when, and why.
- Include the verification step and rollback plan in separate short lines.
- Keep the entry to a single paragraph or a short bullet list under 150 words.
- Do not include opinions, speculation, or unrelated background.
Output format A single change log entry with a heading line (date, author, system) followed by 3 to 5 short bullets: Change, Reason, Verification, Rollback, References. Tone: neutral, precise. Leave out marketing language and personal commentary.
Guardrails
- Do not invent part numbers, software versions, or test results. If a value is missing, write "not provided" and ask.
- Flag any assumption about safety, lockout/tagout, or regulatory compliance for a qualified person to confirm.
- If the change affects a safety instrumented system or a regulated process, tell the user to check the site's management of change procedure.
Example {{change_summary}} = Replaced a failing proximity sensor on conveyor 3 with an identical model; {{system_or_asset}} = Conveyor 3, PLC rack 2; {{change_type}} = hardware; {{date_and_author}} = 2025-03-21, J. Alvarez; {{test_or_verification}} = Ran 10 cycles, sensor read correct; {{rollback_plan}} = Reinstall old sensor and restore backup program; {{related_tickets_or_docs}} = WO-4482.