Codex 技术设计文档技能:写清范围、方案与验收条件
EnglishCodex 安装步骤
- 打开 GitHub 固定提交的 `.agents/skills/design-doc-writing/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.agents/skills/design-doc-writing/`,把核对后的文件保存为 `.agents/skills/design-doc-writing/SKILL.md`。
- 在该项目根目录启动 Codex,输入 `$design-doc-writing` 并选择同名技能。
中文摘要
把已有需求写成可交接的技术设计文档,明确项目边界、主要方案和上线前验证条件。
SKILL.md 中文导读
可复现示例
为虚构的活动报名页写一段技术设计文档,重点说明范围和验收。
{"feature":"Save an unfinished signup locally","scope":"single tab","excluded":"cross-device sync","acceptance":"draft survives one refresh"}工作步骤
- 先确认问题、包含范围和不包含的范围,写明约束与成功标准。
- 给出推荐方案,说明数据和接口,以及风险和应对方法。
- 补齐上线与验证,附上验收条件,请评审者标记仍需修改的内容。
验收方法
范围段写 `single tab` 并标出 `cross-device sync` 不在本次范围。验收条件应明确写出 `draft survives one refresh`,用一次刷新即可观察。
GitHub 原文 · 更新日期
适用环境
在 Codex 中打开工作项目,准备待解决的问题、已知约束和可核对的验收条件。可以先用虚构功能练习设计文档写作。
常见问题
Codex 技术设计文档需要默认列出很多实现方案吗?
先写一项推荐方案,并说明范围与验收条件。评审者要求比较时,再把备选方案一起记录。