SuperAPI AI 工具集

migration-guide-writer

编程与开发

查看项目

更新于 10-16 00:29

技能介绍

用途:为从旧系统或旧 API 迁移到新系统编写迁移指南,采用 Diátaxis 的 How-To 模式,面向具体迁移目标,假设读者已有基础,按步骤给出从旧到新的路径,可包含多种迁移策略、真实生产场景与故障排查。

主要能力:分析新旧系统并核对 API,建立映射清单;识别 CRUD、认证、配置、错误、异步等迁移模式;编写带 Before/After 示例的结构化指南;记录全部破坏性变更;补充常见编译、运行时与逻辑错误的排查;输出 Markdown 文件,常见位置为 docs/migrations/[old]-to-[new].md、项目根目录 MIGRATION.md 或 docs/how-to/migrate-from-[old].md。

使用方式:手动调用,命令为 /skill migration-guide-writer,也可在用户提出迁移需求时触发。流程分五阶段:系统分析、模式识别、文档编写、故障排查、验证。可与 api-doc-writer、tutorial-writer、api-documentation-verify 配合,本身为独立技能,不调用其他技能。

适用场景:重大版本发布后、弃用旧系统时,或用户询问如何从旧服务迁移到新服务。

限制与规则:零容忍编造,禁止虚构新旧 API、错误签名、无法编译的迁移代码及未经基准验证的性能声明;不写从零教学的教程、完整 API 参考、深层原因解释或营销对比。需说明前置版本要求,提供迁移清单。资料未提供具体价格、平台支持范围与官方发布信息。