重构计划模板
概述
重构计划模板是用于记录和跟踪重构工作的标准化文档,包含项目信息、执行摘要、风险评估和详细重构步骤。
关键内容
- 项目信息管理:
- 包括项目/模块名称、目标文件列表、创建日期、作者及状态跟踪
-
定义重构工作的范围和基本信息
-
目标与约束设定:
- 明确重构的主要目标、次要目标和第三目标
-
列出重构过程中的约束条件,如不能改公共API、必须保持向后兼容等
-
风险评估与检查清单:
- 包含风险等级评估(低/中/高)
-
代码异味识别与分析:
- 提供系统化的代码异味识别表格
-
包含异味类型、位置、严重性和优先级的详细分析
-
分阶段重构策略:
- 分为三个阶段:快速收益(低风险)、结构优化(中风险)、架构改动(高风险)
-
每个阶段都有明确的目标、改动预估、用户批准要求和回滚方案
-
详细操作指导:
- 提供具体的重构步骤和验证方法
- 包含上下文对比、逐步操作指南和提交信息格式
来源
- 重构计划模板 — 源自 Claude HowTo 技能文档