一键导入
project-skill-convention
Codex 的项目协作公约技能。当仓库希望让需求分析、技术设计、实现计划、实现执行、追踪审查共用一套目录、状态文件和交接规则时使用。它会定义前置检查、目录结构、状态回写规则、阶段职责和与 task-control 的联动方式。
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
菜单
Codex 的项目协作公约技能。当仓库希望让需求分析、技术设计、实现计划、实现执行、追踪审查共用一套目录、状态文件和交接规则时使用。它会定义前置检查、目录结构、状态回写规则、阶段职责和与 task-control 的联动方式。
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Codex 的设计阶段技能。需要根据 requirements 文档产出技术设计、明确实现方案、拆分关键模块、梳理依赖和风险,并把结果写入 `docs/codex/{version}/designs/` 时使用。它应与 `project-skill-convention` 配合,并在完成后回写 `status.md`。
Codex 的项目开发约束技能。涉及代码修改、代码阅读、业务上下文建立、文档编辑、查询代码逻辑、多文件实现时使用。它会约束任务启动、文档优先级、工作区与正式区的使用方式、代码变更后的文档同步,以及对外变更时的确认规则。
Codex 的基础设施只读查询技能。适用于查看数据库表结构、索引、ES mapping、ES 文档、Nacos 配置,以及追踪服务依赖的中间件连接信息。当任务涉及“查配置”“查索引”“查表结构”“查数据库”“DESC”“nacos”“mapping”“文档数”等场景时优先使用,核心原则是不猜,直接查。
Codex 的业务域文档生成技能。适用于为 Java 项目初始化或补充 `docs/desc/` 业务域文档、建立领域上下文、生成技术速查和域文档骨架。当项目缺少业务域文档、需要建立知识库或需要补齐某个业务域说明时使用。
Codex 的计划阶段技能。需要根据 design 文档拆解实施步骤、确定执行顺序、验证依赖、形成可执行计划,并把结果写入 `docs/codex/{version}/plans/` 时使用。它应与 `project-skill-convention` 配合,并在完成后回写 `status.md`。
Codex 的项目入口技能。适用于进入一个项目后的大多数任务起点,包括代码修改、缺陷修复、代码阅读、需求分析、技术设计、执行计划、实现推进、闭环追踪、基础设施查询、业务文档沉淀和长任务恢复。它负责根据任务意图自动选择并串联 `dev-constraints`、`task-control`、`project-skill-convention`、`req-analysis`、`design-phase`、`plan-phase`、`req-trace`、`dev-small-tool`、`docs-desc-generation` 等技能,作为整套 Codex 项目工作流的统一入口。
| name | project-skill-convention |
| description | Codex 的项目协作公约技能。当仓库希望让需求分析、技术设计、实现计划、实现执行、追踪审查共用一套目录、状态文件和交接规则时使用。它会定义前置检查、目录结构、状态回写规则、阶段职责和与 task-control 的联动方式。 |
本公约用于统一需求、设计、计划、实现、追踪之间的协作规则。使用流程型技能时,应先遵循本公约,再执行目标技能。
适用阶段型技能包括:
req-analysisdesign-phaseplan-phasereq-tracedocs/codex/{version}/
├── status.md
├── requirements/
├── designs/
├── plans/
└── trace/
建议使用:
{topic}-requirements.md{topic}-design.md{topic}-plan.md{topic}-trace.md至少确认:
docs/codex/{version}/ 存在status.md 存在开始前必须执行:
dev-constraintsdocs/codex/{version}/status.md 是否存在,不存在则初始化status.mdtask-control当具体技能默认行为与本公约冲突时,以本公约为准。
统一约束包括:
docs/codex/{version}/...status.mdstatus.md 至少包含三部分:
建议状态值:
负责:
status.md 中登记需求条目不负责:
负责:
status.mdstatus.md 中的设计文件路径与设计状态task-control 记录过程负责:
status.mdstatus.md 中的计划文件路径与计划状态task-control 联动记录过程负责:
status.mdtask-control 断点req-trace负责:
status.md 备注列记录问题摘要不负责:
以下场景建议或必须注册到 task-control:
推荐任务命名:
{version}-{topic}-需求分析{version}-{topic}-技术设计{version}-{topic}-执行计划{version}-{topic}-实现{version}-{topic}-追踪审查每个阶段完成后都应更新 status.md:
补充要求:
req-trace。如果需求或设计发生变化:
status.md 的变更记录中追加条目初始化新的 status.md 时,先读取 status-template.md。