代码库文档与现代化改造
原名:doc-and-modernize
先生成可验证的代码库说明,再规划逐步升级与现代化改造。
中文 Skills 技能说明
适合遗留系统需要补档或升级框架、依赖和架构的场景。先建立当前事实和测试基线,再分阶段提出改造;批量替换、升级依赖和删除旧实现前必须说明兼容影响与回退方案。
上游能力依据
上游原始适用说明:Two related workflows for a locally-cloned codebase, in one skill. Documentation mode produces a single, comprehensive, verifiable architecture document primarily by reading files on disk (local-first) — use it whenever the user wants to understand, map, document, research, or onboard onto a codebase ("research this repo", "write up the architecture", "do an architecture deep dive", "document how this codebase works", "map the system design", "create an onboarding doc"). Modernization mode generates a phased plan to modernize, migrate, upgrade, or rewrite a legacy system ("modernize this", "plan the migration", "how would we rewrite this", "how do we get off this legacy stack"); if no architecture document exists yet it first runs Documentation mode, then continues straight through to the plan. It assumes the legacy stack may be dead, runs a time-boxed feasibility spike, and picks the highest achievable rung on a safety ladder instead of demanding a fully-green legacy CI gate up front.
上游 SKILL.md 主要章节(保留原文标题):
- Mode selection
- Documentation mode
- Why local-first
- Workflow
- Output structure
- Conventions that make the document trustworthy
- Scope control
- Modernization mode
- Prerequisites
- Phase N: [Name] (T-shirt size: M)
使用边界
先读取项目约定、依赖版本和现有测试,再提出最小改动。写文件、运行脚本、提交代码或发布前应检查差异并保留回退路径。
作者、翻译与许可证
- 原作者
- GitHub, Inc. 与 awesome-copilot contributors
- 中文翻译
- CEOFans翻译
- 许可证
- MIT
- 上游来源
- https://github.com/github/awesome-copilot/tree/3f0bba475ec40b9680e1d0311b9caffeec5ad4c3/skills/doc-and-modernize
适用范围
平台:linux、macos、windows;标签:软件开发、代码库文档与现代化改造
安全提示
基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件,请在最小权限环境中使用,高风险操作必须人工确认。
如发现侵权、许可证或安全问题,可在本页前台提交投诉,管理员复核后可立即下架。