Skip to main content

Change History and Version Management

Learn how to track prompt changes, view edit history, compare versions, and rollback to previous prompts when needed.

What Is Change History?​

Definition​

Change History is a log of all edits made to system prompts, including:

  • Who made the change (admin user)
  • When it was made (timestamp)
  • What changed (description)
  • The full prompt text at that point in time

Analogy: Like "Track Changes" in Microsoft Word or version history in Google Docs - you can see every edit and who made it.

Why Change History Matters​

Benefits:

  1. Accountability - Know who made what changes
  2. Transparency - Understand why changes were made
  3. Rollback capability - Undo problematic changes
  4. Learning - See what worked and what didn't
  5. Collaboration - Multiple admins can coordinate edits
  6. Compliance - Maintain audit trail for institutional requirements

Accessing Change History​

Location​

Path: Prompt Configuration → System Prompt → Change History

Steps:

  1. Log in to Admin Panel
  2. Click ⚙️ Prompt Configuration in sidebar
  3. Click System Prompt tab
  4. Click "View Change History" button (usually near top or bottom of editor)

What You'll See​

Change History View displays:

ColumnDescriptionExample
VersionSequential version numberv1, v2, v3, v42
Date/TimeWhen change was made1/15/2026, 2:45 PM
EditorWho made the changejane.smith@uga.edu
DescriptionWhat changed and why"Added internship coverage rules"
ActionsView, Compare, RestoreButtons for each version

Most recent version appears at the top (descending chronological order).

Understanding Versions​

Version Numbers​

Format: Sequential integers starting at 1

  • v1: Original prompt (initial setup)
  • v2: First edit
  • v3: Second edit
  • v42: Forty-second edit

Current version: Highlighted or marked as "Active" or "Current"

Version Metadata​

Each version includes:

  1. Version Number - Unique identifier
  2. Timestamp - Exact date and time of save
  3. Author - Email or username of editor
  4. Description - Change description (from "Describe what changed" modal)
  5. Full Prompt Text - Complete prompt as it existed at that version

Viewing Version Details​

How to View a Specific Version​

Steps:

  1. Open Change History
  2. Find the version you want to view
  3. Click "View" or "Details"
  4. Modal or panel opens showing full prompt text

What you'll see:

  • Complete prompt as it existed in that version
  • Metadata (date, editor, description)
  • Option to compare with other versions
  • Option to restore this version

Reading Version Descriptions​

Good descriptions tell you:

  • What was changed (specific section or rule)
  • Why it was changed (evidence, feedback, requirement)
  • Expected impact (how responses should change)

Example descriptions:

Helpful:

Added explicit rule to cite page numbers in source citations.
Reason: 12 users in last 2 weeks asked for more specific sources.
Expected: Responses will now say "HFIM Handbook, page 45" instead of
just "HFIM Handbook".
Editor: jane.smith@uga.edu

Not helpful:

Updated prompt
Editor: john@uga.edu
tip

If you find unhelpful descriptions from past edits, you can't change them. But you can use Admin Notes in your own future edits to be more detailed!

Comparing Versions​

Why Compare Versions​

Use cases:

  • Understand what changed between two versions
  • Debug issues ("responses were good in v15, bad in v16 - what changed?")
  • Learn from successful changes
  • Review teammate's edits

How to Compare Versions​

Steps:

  1. Open Change History
  2. Select two versions to compare (usually checkboxes or dropdown)
  3. Click "Compare" or "Diff"
  4. View side-by-side or unified diff

Diff display formats:

Side-by-Side:

Version 15                     | Version 16
------------------------------|-------------------------------
Always cite sources.          | Always cite sources with page
                              | numbers.

Unified Diff (like Git):

- Always cite sources.
+ Always cite sources with page numbers.

Color coding:

  • 🟢 Green/Plus: Text added in newer version
  • 🔴 Red/Minus: Text removed in newer version
  • ⚪ Gray/White: Text unchanged

Common Comparison Scenarios​

Scenario 1: Current vs. Previous​

Goal: See what changed in the most recent edit

Steps:

  1. Compare Current (v42) with v41
  2. Review differences
  3. Verify changes match the description

Why: Confirms your most recent edit did what you intended.

Scenario 2: Current vs. Last Known Good​

Goal: Find what broke responses since they were working well

Example:

  • v30: Responses were excellent
  • v31-v35: Multiple edits made
  • v36 (current): Responses are problematic

Steps:

  1. Compare v36 (current) with v30 (last known good)
  2. Identify ALL changes made between versions
  3. Determine which change likely caused the problem
  4. Restore v30 or manually undo the problematic change

Scenario 3: Reviewing Teammate's Edit​

Goal: Understand what a colleague changed

Steps:

  1. Check Change History for their edit (e.g., v38 by john@uga.edu)
  2. Compare v38 with v37
  3. Review the differences and description
  4. Test the changes if needed
  5. Approve or discuss with teammate

Restoring Previous Versions (Rollback)​

When to Restore​

Restore a previous version when:

  • ❌ Recent edit caused incorrect responses
  • ❌ Negative feedback spiked after change
  • ❌ Unintended behavior appeared
  • ❌ Change didn't achieve desired effect
  • ❌ Accidental deletion of important sections

Don't restore just because:

  • ⚠️ One or two responses seem off (test more first)
  • ⚠️ Change is recent (give it 24-48 hours to assess)
  • ⚠️ You personally prefer the old version (check data first)

How to Restore a Version​

Steps:

  1. Open Change History

    • Navigate to Prompt Configuration → System Prompt → Change History

  2. Find the Version to Restore

    • Scroll to the version you want to revert to
    • Example: Restore v30 (before problems started)

  3. Click "Restore" or "Rollback"

    • Button may say "Restore This Version" or similar

  4. Confirm Restoration

    • Modal appears: "Are you sure you want to restore v30?"
    • Warning: "This will replace the current prompt (v36) with v30"
    • Add description: "Reverting to v30 due to response quality issues in v31-v36"

  5. Click "Yes, Restore"

    • System creates a NEW version (v37) containing the v30 prompt
    • Current version is now v37 (which is identical to v30)
Important

Restoring doesn't delete versions. It creates a NEW version that's a copy of the old one. Version history is preserved.

After Restoring​

Immediate actions:

  1. Test the chatbot

    • Ask 5-10 test questions
    • Verify responses are back to normal
    • Check for any issues

  2. Monitor conversations

    • Watch for 24-48 hours
    • Ensure responses are satisfactory
    • Check negative feedback rate

  3. Document the issue

    • Add notes about what went wrong
    • Share with team (if applicable)
    • Plan how to avoid similar issues

  4. Consider root cause

    • Why did v31-v36 cause problems?
    • Was the change itself bad, or was it poorly tested?
    • What would you do differently next time?

Restoring Example​

Scenario: You edited the prompt to change the tone (v42), but users report responses are now too casual and unprofessional.

Steps:

  1. Open Change History
  2. Find v41 (version before your tone change)
  3. Click "Restore v41"
  4. Description: "Restoring v41 due to user feedback that v42 tone is too casual. Will revise tone change approach and test more thoroughly before redeploying."
  5. Confirm
  6. Test chatbot - Verify tone is back to acceptable level
  7. Plan new approach - Draft tone change with more restraint, test extensively before saving

Version Management Best Practices​

Practice 1: Write Detailed Descriptions​

Every time you save, write a clear description:

Template:

What: [Specific section or rule changed]
Why: [Evidence, feedback, or requirement driving the change]
Expected result: [How responses should change]

Example:

What: Modified source citation rule to require page numbers
Why: 15 conversations in last month asked "which page is that on?"
Expected: All responses will cite sources as "Document Name, page X"

Why this helps:

  • Future you can understand past decisions
  • Teammates can see your reasoning
  • Easier to debug issues
  • Better audit trail

Practice 2: Review Change History Regularly​

Weekly routine (5 minutes):

  1. Open Change History
  2. Review last week's changes (yours and teammates')
  3. Compare current version with last week's version
  4. Note any patterns or trends

Why:

  • Stay aware of prompt evolution
  • Catch issues early
  • Learn from successful changes
  • Coordinate with team

Practice 3: Keep a Separate Change Log​

In addition to built-in history, maintain a summary document:

Example log:

DateVersionChange SummaryOutcome
1/5/26v30Added career info rules✅ Positive: career questions improved
1/12/26v35Changed tone to casual❌ Negative: too informal, reverted v37
1/18/26v38Modified tone (moderate)✅ Positive: balanced, well-received

Why:

  • Easier to review trends over time
  • Summarizes outcomes (not just changes)
  • Can be shared in reports or meetings
  • Institutional knowledge preservation

Practice 4: Tag Major Changes​

If your system supports tags or labels, mark significant changes:

  • 🏷️ "Major Edit" - Significant restructure or policy change
  • 🏷️ "Minor Edit" - Small tweaks, typo fixes
  • 🏷️ "Emergency Rollback" - Reverting due to issues
  • 🏷️ "Tested" - Change was thoroughly tested before deployment

Benefits:

  • Quickly filter history for important changes
  • Identify high-risk vs. low-risk edits
  • Easier for teammates to navigate history

Collaboration with Change History​

Multiple Admins Scenario​

Challenge: Jane and John both edit prompts. How to coordinate?

Solution using Change History:

  1. Check before editing

    • Jane opens Change History
    • Sees John made edit yesterday (v41)
    • Reviews his change before making her own

  2. Announce edits

    • Jane emails: "Editing system prompt today at 2 PM (adding FAQ section)"
    • John sees email, waits until Jane is done

  3. Review each other's work

    • After Jane's edit (v42), John reviews via Change History
    • John compares v42 with v41
    • If he has concerns, discusses with Jane

  4. Resolve conflicts

    • If both edit simultaneously (rare), resolve by:
      • Compare versions
      • Merge changes manually
      • Communicate to prevent future conflicts

Troubleshooting Change History​

Issue 1: Change History Won't Load​

Symptom: Clicking "Change History" shows error or blank screen

Possible causes:

  • Network issue
  • Browser cache problem
  • Session expired
  • Server issue

Solutions:

  1. Refresh page (F5)
  2. Log out and log in again
  3. Clear browser cache
  4. Try different browser
  5. Contact support if persists

Issue 2: Can't Restore a Version​

Symptom: "Restore" button is grayed out or doesn't work

Possible causes:

  • Insufficient permissions (need admin or editor role)
  • Version is already current (can't restore current version to itself)
  • System restriction (some systems may limit rollback to certain timeframes)

Solutions:

  1. Verify you have restoration permissions
  2. Ensure you're not trying to restore the current version
  3. Contact support to verify permissions

Issue 3: Version Descriptions Are Missing​

Symptom: Many versions have blank or unhelpful descriptions

Explanation: Previous admins may not have written descriptions when saving.

Solution:

  • Can't fix past descriptions (they're immutable)
  • Going forward: Write detailed descriptions on YOUR edits
  • Workaround: Compare versions manually to understand changes
  • Document findings: Keep external log with your notes on past changes

Issue 4: Too Many Versions (Hard to Navigate)​

Symptom: 200+ versions, difficult to find relevant changes

Solutions:

  1. Filter by date (if available) - Show only last 30 days
  2. Filter by editor - Show only your changes or specific teammate
  3. Search descriptions - Search for keywords
  4. Use external log - Maintain summary with links to important versions

Advanced Version Management​

Branching Strategy (If Supported)​

Some systems allow prompt branches for testing major changes:

Workflow:

  1. Main Branch (v1-v42): Production prompt, always safe
  2. Test Branch: Experimental changes
  3. Test extensively in test branch
  4. Merge to main when validated

Benefits:

  • Test risky changes safely
  • Don't affect live chatbot
  • Easier rollback (just switch branches)
info

Check with your system administrator if prompt branching is available.

Exporting Change History​

If available, export change history to:

  • CSV (spreadsheet)
  • JSON (data analysis)
  • PDF (reporting)

Uses:

  • Annual reporting (show prompt evolution)
  • Training new admins (learn from history)
  • Analyzing patterns (which changes work best)
  • Compliance audits

Next Steps​

Now that you understand change history:

  1. Learn about Testing Changes - Validate edits before deployment
  2. Understand Hot Reload - How changes take effect immediately
  3. Review Best Practices - Advanced prompt management strategies
  4. Learn about Editing Prompts - Safe editing techniques

Summary Checklist​

When using Change History:

  • Review change history before making edits (know what's changed recently)
  • Write detailed descriptions when saving (help future you)
  • Compare versions to understand changes
  • Test restored versions thoroughly
  • Document outcomes of major changes
  • Coordinate with teammates using history
  • Keep external log of major changes
  • Monitor conversations after restorations

Remember: Change History is your safety net. Use it to learn, troubleshoot, and maintain accountability. Always write good descriptions!

Last updated on