Sourcery 是一款在线服务：AI 代码审查与重构建议工具。

这篇不讲概念，直接给能复制修改的模板，以及每个模板该怎么填。

模板怎么用

每个模板都由三部分组成：背景（你是谁、要做什么）、约束（格式、篇幅、禁止事项）、验收（怎样算合格）。把方括号里的内容换成你自己的信息即可。

模板 1：读懂陌生代码库

适合：一个刚接手的项目仓库。

先不要改任何代码。请阅读这个仓库，输出：1）目录结构说明；2）主要模块之间的调用关系；3）本地运行步骤；4）你认为最脆弱的 3 个地方。

填写提示：把你最看重的一条要求放在最前面；验收看「运行步骤能实际跑通」。

模板 2：写技术文档

适合：一个模块的源码。

根据源码为这个模块写 README：用途、安装、最小示例、配置项表格和常见问题。示例代码必须能直接运行。

填写提示：如果结果太长，补一句字数或条数上限；验收看「示例代码可运行」。

模板 3：小功能开发

适合：一个清晰的需求描述。

实现以下需求：【需求】。要求：先给出实现计划和要改动的文件列表，等我确认后再写代码；遵循现有代码风格；补充必要的测试。

填写提示：先用一份小样本试跑，再处理完整材料；验收看「先有计划再动手」。

模板维护

  • 给每个模板编号并记录修改日期。
  • 保留一份「效果好」的示例输出作为对照。
  • 团队共用时注明适用场景和负责人。

更多可以试的用法

修复报错

输入：一段报错堆栈和相关代码。

这是报错信息和相关代码。请先解释报错原因，给出最小修改方案，并说明为什么这个修改不会影响其他调用方。

交付前确认：修改范围足够小。

代码审查

输入：一个 Pull Request 的改动。

审查这个改动，按「必须修改 / 建议修改 / 可以忽略」三级列出问题，每条附上文件和行号，重点关注安全、并发和错误处理。

交付前确认：问题定位到行。

补单元测试

输入：一个缺少测试的函数或模块。

为【函数名】编写单元测试，覆盖正常输入、边界值和异常输入，使用项目现有的测试框架，不要修改被测代码。先列测试用例再写代码。

检查点：测试能在本地通过。

常见问题：泄露密钥的风险

把密钥放在环境变量，规则文件中禁止读取 .env 等敏感文件。

常见问题：越改越乱

回滚到上一个可用提交，把需求拆小后重新开始。

常见问题：AI 改动范围过大

要求先给计划和文件清单，限定只改指定文件。

概念补充：编程智能体

能读写多个文件、运行命令并迭代修复的 AI，需要控制权限。

概念补充：规则文件

放在仓库里的说明文件，告诉 AI 项目约定和禁止事项。

适合人群：小店老板

小店老板可以用 Sourcery 处理门店宣传物料、顾客评价回复等工作。需要注意：价格和活动信息以实际为准，顾客电话等信息不要随意上传。

适合人群：科研人员

科研人员可以用 Sourcery 处理文献检索与阅读、实验记录与数据整理等工作。需要注意：遵守期刊和机构关于 AI 使用的披露要求，引用逐条核对。

使用提醒

涉及个人信息、商业机密或受监管数据时，先确认 Sourcery 的数据处理条款，再决定能否使用。

文中提示词和示例仅作示意，实际效果取决于你的材料和 Sourcery 当前版本，重要内容请人工核对后再使用。

延伸阅读