代码重构:让 AI 输出架构设计文档,先梳理现状再给方案,配模板和避坑。
把代码重构提示词拆成输入、步骤、输出和复核四段,通常比一次写很长的提示词更稳。
先看这个场景:架构设计
- {{系统}}:电商系统/社交系统/内容管理系统
- {{架构类型}}:微服务/单体/Serverless
- {{服务列表}}:用户服务、商品服务、订单服务
- {{输出要求}}:服务划分、接口设计、数据流图
第二个场景这样改:代码重构
- {{语言}}:Python/JavaScript/Java
- {{设计模式}}:单例模式/工厂模式/观察者模式
- {{质量要求}}:可读性/可维护性/性能
- {{文档要求}}:注释/文档字符串/README
先用这几段试一次
可替换的模板
| 类型 | 模板 | 示例 |
|------|------|------|
| 架构设计 | 请为{{系统}}设计{{架构类型}}架构,包括{{服务列表}},给出{{输出要求}} | 电商系统、微服务、用户/商品/订单服务 |
| 代码重构 | 请重构这段{{语言}}代码,使用{{设计模式}},提高{{质量要求}},添加{{文档要求}} | Python、单例模式、可读性、注释 |
| 技术文档 | 请为这个{{组件}}写技术文档,包括{{文档内容}} | API、接口地址、参数、响应格式 |
两种场景的模板
两版写法对比
| 维度 | 手写 | AI 生成 |
|------|------|---------|
| 时间 | 长 | 短 |
| 结构 | 依赖个人 | 标准化 |
| 完整性 | 可能遗漏 | 全面 |
| 迭代成本 | 高 | 低 |
把原因讲清楚
AI 擅长结构化输出。架构设计、技术文档都是结构化的,AI 能快速生成初稿,你只需要调整细节。
继续优化的地方
1. 用「上下文」:提供现有代码,让 AI 理解业务背景
2. 用「约束条件」:指定技术栈、性能要求、安全要求
3. 用「迭代优化」:第一次输出不满意,把问题反馈给 AI
使用时的常见问题
Q:AI 生成的架构设计靠谱吗?
A:可以作为初稿,但需要架构师审核。AI 可能忽略业务特殊性。
Q:代码重构会破坏原有功能吗?
A:需要测试验证。AI 重构后要跑测试用例,确保功能不变。
Q:技术文档需要哪些内容?
A:接口地址、请求参数、响应格式、错误码、使用示例。