Codex Scribe doc-maintainer:维护 DOCS.MD 与代码目录
EnglishCodex 安装步骤
- 打开固定版本的 GitHub 原文,从该版本保留 `.codex/skills/doc-maintainer/` 整个目录。将它放入目标项目的 `.agents/skills/doc-maintainer/`。
- 在目标项目中打开 Codex,输入 `$doc-maintainer` 并给出本页示例里的任务和所需输出。
中文摘要
按文件和入口检查 Scribe 的文档覆盖范围,更新代码库地图、子系统说明和目录。适合新增模块、调整用户操作或更换关键入口后维护单份文档。
SKILL.md 中文导读
可复现示例
给练习副本新增一个示例导出模块后输入 `$doc-maintainer`,请对照模块入口补齐代码库地图,并检查目录能否跳到新段落。工作步骤
- 用 `rg --files` 查找变动模块并阅读入口,再与 DOCS.MD 的现有章节对照。
- 更新相应子系统和目录锚点,用具体文件路径说明入口和用途。
验收方法
DOCS.MD 列出该模块职责和实际入口文件。章节与目录对应,读者能定位导出流程。
GitHub 原文 · 更新日期
适用环境
Codex 与 Scribe 仓库工作副本,具备 DOCS.MD 和相关代码的读取权限。
常见问题
什么时候需要新增独立章节?
复杂功能需要单独说明时可增加章节和目录条目。普通模块可直接登记在代码库地图下。