← 全部极客知识库

主流 Agent 入门教程 / Codex

22. 附录3-高质量任务描述模板

原文备份 · 第 23 / 27 篇 · 查看极客时间原知识库 ↗

本篇目录 · 9 节

来源:Codex

提示词不需要写得像合同,但至少要让 Codex知道目标、范围、约束和怎样算完成。

一、实现新功能

目标:<用户最终能做什么>

当前背景:
- <相关文件或现有行为>
- <为什么要做>

需求:
1. <行为一>
2. <行为二>

不在范围内:
- <本次不做的事情>

约束:
- <技术、依赖、兼容、安全要求>

验收:
- <可观察结果>
- <必须运行的测试>

请先检查现状并列出歧义,给出计划;确认后再实施。完成时报告修改文件、验证证据和剩余限制。

二、修复缺陷

现象:<用户看见什么>
复现步骤:<怎样触发>
预期结果:<正确行为>
影响范围:<已知用户或数据>

请先不要修改。先用最小输入复现,记录命令、实际结果和根因证据;补一个会失败的回归测试。确认后做最小修复,运行局部测试、完整测试并审查 Diff。

三、理解陌生项目

请只读调查当前仓库,不修改文件。

输出:
1. 项目目标和主要入口;
2. 关键目录与数据流;
3. 安装、启动和测试命令;
4. 配置、外部依赖和敏感边界;
5. 当前 Git 状态与主要风险;
6. 仍然无法确认的问题。

每个结论引用具体文件或实际命令结果。

四、代码审查

请审查 <当前 Diff / 分支 / 提交范围>,不要直接修改。

优先发现:正确性、数据安全、兼容性、并发、错误处理、测试失真和文档不一致。忽略纯格式偏好。

每个发现给出:严重程度、文件位置、触发条件、用户影响、证据和建议验证方式。没有发现时明确说明审查范围和仍未覆盖的风险。

五、重构

重构目标:<要降低的具体风险>
必须保持:<接口、输出、数据格式、性能边界>
允许修改:<文件或模块>
不允许修改:<范围外内容>

请先确认现有测试能保护行为;若不足先补特征测试。重构过程中不增加新功能。完成后运行完整测试,比较关键输入输出,并展示 Diff。

六、文件整理

请先只读盘点 <目录>,不要移动、重命名、覆盖或删除。

先输出文件清单、分类依据、不确定项、建议目录结构、移动预览、冲突处理和回滚方案。确认后再执行。执行前生成原路径到目标路径的清单,完成后核对文件总数和失败项。

七、数据分析

请先检查 <文件> 的字段、范围、空值、重复、异常值和口径,不要马上得出业务结论。

先说明清洗规则和指标公式,等我确认后再计算。最终结论必须附数据表或计算依据;区分事实、推断和待验证问题,不把相关性写成因果关系。

八、发布检查

请对 <版本> 做发布前检查,不提交、不打标签、不推送、不发布。

检查:Git 状态、完整测试、关键手动路径、兼容性、README、CHANGELOG、密钥和运行数据。报告分为通过、阻塞和提醒,并记录实际命令、退出码和证据。

九、中途纠偏

暂停当前修改。你已经偏离了 <原范围>。

请先说明已经改了哪些文件、哪些改动与目标无关、怎样在不影响我原有工作的前提下收缩范围。暂时不要继续写入。