Skip to content

Free Engineering Template

Free Migration Guide

Migration from [source] to [target]

Overview Prerequisites Pre-Migration Checklist Migration Steps Data Validation Rollback Procedure Post-Migration

Migration Guide

Use this template to migration from [source] to [target].

Template Metadata

Field Details
Category Engineering
Owner [Team or owner]
Version [Version number]
Effective Date [Date]
Review Cycle [Monthly / Quarterly / Annual / Event-based]
Status [Draft / In Review / Approved]

Overview

What's being migrated, from where, and to where.

Item Details Owner Status
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Prerequisites

Required access, tools, and preparation.

Item Details Owner Status
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Pre-Migration Checklist

Checklist of items to verify before starting.

Item Details Owner Status
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Migration Steps

Detailed, numbered steps.

Item Details Owner Status
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Data Validation

How to verify data integrity after migration.

Item Details Owner Status
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Rollback Procedure

Exact steps to revert if needed.

Item Details Owner Status
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Post-Migration

Cleanup, monitoring, and validation. Use code blocks for commands. Include estimated timing.

Item Details Owner Status
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]
[Item or requirement] [Describe the relevant detail, evidence, or decision] [Owner] [Open / Complete]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Review and Signoff

Document review conclusions, approvals, unresolved items, and next review date.

Role Name Date Notes
Preparer [Name] [Date] [Notes]
Reviewer [Name] [Date] [Notes]
Approver [Name] [Date] [Notes]

Template Structure

What the Migration Guide Includes

Use this engineering template as a starting point, then customize each section to match your internal workflow, evidence, and signoff needs.

1

Overview

What's being migrated, from where, and to where.

2

Prerequisites

Required access, tools, and preparation.

3

Pre-Migration Checklist

Checklist of items to verify before starting.

4

Migration Steps

Detailed, numbered steps.

5

Data Validation

How to verify data integrity after migration.

6

Rollback Procedure

Exact steps to revert if needed.

7

Post-Migration

Cleanup, monitoring, and validation. Use code blocks for commands. Include estimated timing.

Recommended Structure

Write a Migration Guide. Structure with:

Overview

What's being migrated, from where, and to where.

Prerequisites

Required access, tools, and preparation.

Pre-Migration Checklist

Checklist of items to verify before starting.

Migration Steps

Detailed, numbered steps.

Data Validation

How to verify data integrity after migration.

Rollback Procedure

Exact steps to revert if needed.

Post-Migration

Cleanup, monitoring, and validation.

Use code blocks for commands. Include estimated timing.

Example Filled Template

Migration Guide: MongoDB → PostgreSQL

Overview

Migrating the user service data store from MongoDB 6.0 to PostgreSQL 16. This affects ~2.3M user records and 12 collections being mapped to relational tables.

Estimated Duration: 4 hours (2h migration + 2h validation) Scheduled Window: Saturday 2026-02-22, 02:00-06:00 UTC

Prerequisites

  • [ ] PostgreSQL 16 target database provisioned
  • [ ] pgloader v3.6+ installed on migration host
  • [ ] Read access to MongoDB production replica
  • [ ] Write access to PostgreSQL target
  • [ ] Schema migration scripts reviewed and tested on staging

Pre-Migration Checklist

  • [ ] MongoDB backup verified (less than 1 hour old)
  • [ ] PostgreSQL schema applied (./scripts/apply_schema.sql)
  • [ ] Feature flag USE_POSTGRES_USERS ready to toggle
  • [ ] Monitoring dashboards open: DB connections, error rates, latency
  • [ ] Rollback runbook reviewed by on-call engineer

Migration Steps

Step 1: Export from MongoDB (est. 45 min)

mongodump --uri="mongodb://replica.internal:27017/userdb" \
--out=/migration/dump \
--readPreference=secondaryPreferred

Step 2: Transform and Load (est. 60 min)

python scripts/transform_and_load.py \
--source /migration/dump/userdb \
--target "postgresql://migration@pg.internal/userdb" \
--batch-size 10000

Step 3: Validate Record Counts

python scripts/validate_counts.py
# Expected output: "All 12 collections match. Total records: 2,341,892"

Rollback Procedure

  1. Toggle feature flag USE_POSTGRES_USERS to false
  2. Restart user service pods: kubectl rollout restart deploy/user-service
  3. Verify traffic is hitting MongoDB via connection metrics
  4. Keep PostgreSQL data intact for investigation
Skip Manual Drafting

Generate a Migration Guide from a Video

Record a walkthrough, training session, or process demonstration. Docsie AI turns it into structured documentation using this template as the starting framework.

Use the template manually, or let Docsie generate the first draft from source footage.

DOCX, PDF, and Markdown downloads
Works with process and training videos

Template FAQ

Migration Guide FAQ

Common questions about using and generating a migration Guide.

Using This Template

Q: What is a migration Guide?

A: A migration Guide is a structured document for migration from [source] to [target].

Q: Can I download this migration Guide as Word or PDF?

A: Yes. This page includes free downloads in DOCX, PDF, and Markdown formats so you can edit, share, or import the template into your documentation system.

Q: Can Docsie generate this from a video?

A: Yes. Upload a process walkthrough, training recording, or screen capture to Docsie, then use this template structure to generate a first draft automatically.