II.
Workflow overview
Reference · liveworkflow:migration-guide-authoring
Migration Guide Authoring overview
Authors comprehensive migration guides for breaking changes — inventorying all breaking changes and deprecations, writing step-by-step upgrade instructions with code examples, providing codemods or automated fix scripts, testing guides against real consumer codebases, and publishing with version-specific navigation. Excludes the breaking change implementation itself.
Attributes
displayName
Migration Guide Authoring
workflowKind
development
triggerType
event-driven
typicalCadence
per-major-release
complexity
cross-team
description
Authors comprehensive migration guides for breaking changes — inventorying
all breaking changes and deprecations, writing step-by-step upgrade
instructions with code examples, providing codemods or automated fix
scripts, testing guides against real consumer codebases, and publishing
with version-specific navigation. Excludes the breaking change
implementation itself.
Outgoing edges
applies_to_domain2
- domain:software-engineering·DomainSoftware Engineering
- domain:platform-engineering·DomainPlatform Engineering
involves_role3
- role:technical-writer·RoleTechnical Writer
- role:devrel·RoleDeveloper Relations
- role:staff-engineer·RoleStaff Engineer
performed_by_org_unit2
- org-unit:devrel-team·OrgUnitDeveloper Relations
- org-unit:engineering·OrgUnitEngineering
requires_skill_area2
- skill-area:tutorial-design·SkillAreaTutorial Design
- skill-area:breaking-change-management·SkillAreaBreaking Change Management
triggers_responsibility2
- responsibility:write-user-docs·ResponsibilityWrite end-user documentation
- responsibility:changelog-maintenance·ResponsibilityChangelog maintenance
Incoming edges
None.