| name | docs-maintenance |
| description | 通过更新 README 条目、工作流文档、共享参考资料、技能文档、示例、链接、标题和跨文件一致性来维护 agent-workflows 文档;当 Codex 被要求更新文档、修复过期引用、添加示例、改善文档结构或验证 agent-workflows 文档时使用。 |
文档维护
快速开始
维护流程
- 识别文档变更类型:新增文档、文件重命名、工作流步骤变更、新技能、示例更新、错字修复或一致性修复。
- 盘点文档:
python3 scripts/docs_inventory.py /path/to/agent-workflows
- 更新所有受影响的交叉引用:
- README 清单和设置说明。
- 工作流路由和库加载参考。
- 技能文档以及
agents/interface.yaml 中的规范代理元数据提示词。
- 如果多个工作流文件里出现重复措辞,则更新共享约定。
- 验证链接、锚点、清单和辅助脚本。
- 报告已修改的文档、执行的验证以及任何被跳过的检查。
输出规则
- 优先使用精确措辞,而不是大范围重写。
- 保持现有语气和结构。
- 让示例可执行,或清楚标记为模板。
- 如果某条共享参考资料已经是规范来源,就不要再重复添加安全相关样板文字。