Imported from adthomps/adthomps.github.io (
.apt-backups/20260831012553778/.codex/skills/documentation/migration-guide-writer/SKILL.md). Install upstream withnpx skills add adthomps/adthomps.github.io --skill migration-guide-writer. Copyright stays with the author.
Migration Guide Writer
Purpose
Produce a reviewable migration guide writer outcome that is grounded in repository evidence and explicit about uncertainty.
When to Use
Use for planning, design, implementation review, migration, troubleshooting, or documentation where the task must publish one canonical truth through audience-specific layers, executable examples, diagrams, troubleshooting, and implementation blueprints.
Inputs
- Goal, audience, scope, constraints, and success criteria.
- Relevant source files, contracts, examples, logs, and decisions.
- Known risks, assumptions, dependencies, and approval boundaries.
Process
- Restate the intended outcome and affected audiences.
- Inventory exact current behavior and source-backed constraints.
- Apply the relevant APT principles and identify missing evidence.
- Compare viable options, including compatibility and operational effects.
- Produce the required artifacts: audience map, canonical source, business and partner guides, developer contract, support runbook, AI examples, diagrams, demos, and freshness owner.
- Review one guide for every audience, copied truths, non-runnable examples, missing support identifiers, and docs that describe intent instead of behavior; separate blockers, recommendations, and open questions.
Outputs
A concise recommendation, evidence map, required changes, risks, validation plan, support/documentation impact, and approval status.
Quality Bar
The output is practical, source-backed, audience-aware, testable, reversible where possible, and does not state assumptions as facts.
Domain Checklist
- Treat Migration Guide Writer as an explicit decision with defined scope, evidence, owner, and validation.
- Required evidence: canonical source, audience layer, executable example, troubleshooting, freshness owner.
- State what is verified, what is assumed, and what requires specialist or human approval.
Required Reading
Read the canonical Documentation principle hub, the closest enforceable standard, the applicable checklist, and exact target-repository evidence.