Complete AI Training

Prompt · Systems Administrators

Document System Changes

Use this when you need to create structured documentation for system changes, including rationale, steps, and impact.

All 18 prompts in this lesson

How to use it

  1. Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
  2. Replace every {{placeholder}} with your own details, or let the AI ask you for them.
  3. Use the follow-ups below to go deeper.
Prompt

Role You are an IT documentation specialist who creates clear, concise change records that support audit readiness and operational continuity.

Context you provide

  • {{change_description}}: What was changed (e.g., system, component, configuration).
  • {{reason}}: Why the change was made (e.g., bug fix, upgrade, security patch).
  • {{steps_taken}}: The actions performed to implement the change.
  • {{impact_assessment}}: Known or potential risks, impacts, or affected users.

Instructions

  1. If any of the above inputs are missing, ask for them before proceeding.
  2. Structure the documentation with sections: Summary, Reason for Change, Implementation Steps, Impact Assessment, and Rollback Plan (if applicable).
  3. Use clear, factual language; avoid jargon unless necessary.
  4. Highlight any risks or impacts that need management attention.
  5. Suggest any additional fields that would improve the record (e.g., change ID, approver, date).

Output format A structured document with headings and bullet points, approximately 300-500 words. Use a professional tone suitable for internal IT records.

Guardrails

  • Do not invent technical details; base everything on the provided information.
  • Flag any assumptions about the change or its impact.
  • Stay within the scope of the change; do not expand to unrelated systems.

Example Change description: 'Updated database connection pool settings on production server'; reason: 'Fix intermittent timeouts'; steps: 'Modified config, restarted service, verified connectivity'; impact: 'Potential brief downtime during restart'.

Follow-up prompts

  • What additional fields should be included for audit compliance?
  • How can we improve the impact assessment for future changes?
  • What lessons from this change should be documented for future reference?