Codex docmgr 技能:给项目文档绑定工单与代码文件
EnglishCodex 安装步骤
- 从固定 GitHub 提交复制 `.codex/skills/cursor-docmgr/` 完整目录到项目 `.agents/skills/cursor-docmgr/`。
- 在 Codex 读取 `references/docmgr.md` 并确认当前目录使用的 docmgr 配置。
中文摘要
用本地 docmgr CLI 创建工单文档、关联代码并运行一致性检查。
SKILL.md 中文导读
可复现示例
在本地演示工作区给 `DEMO-1` 添加设计文档,再用 `docmgr doc relate --ticket DEMO-1 --file-note "<实际文件路径>:实现导出字段映射"` 添加关系。工作步骤
- 创建指定工单下的文档,再按本机路径添加附理由的代码关联。
- 运行工单的 `doctor` 检查并用搜索命令确认索引。
验收方法
工单中可以找到该文档,文件关系保留说明,`docmgr doctor --ticket DEMO-1` 输出可复查。
GitHub 原文 · 更新日期
适用环境
需要已安装的 docmgr、初始化后的工作区及已确认的工单名。
常见问题
file-note 可以省略理由吗?
该工作流要求写理由,让后续读者知道关联文件与文档的关系。