文档编排
当调用此技能时,执行以下流水线:
步骤 1:架构审计
生成 general-purpose 智能体,并提示如下:
审计当前代码库,检查自上次文档更新以来发生的任何变更。读取现有的机器文档(单个根
AGENTS.md注册表),并与实际项目进行比较。生成一份简洁的变更报告,涵盖以下内容:
- 新增或移除的包、技能、智能体、配置键或 CLI 命令
- 修改后的安装程序导出或模板语义(
installer/lib/*.mjs)bundle.yaml配置声明与占位符用法不同步- 渲染输出漂移:
node installer/cli.mjs doctor --allow-missing干净 (提交的渲染文件与锁文件同步——编辑包后重新渲染并提交);.gitignore仍然覆盖了故意未跟踪的渲染文件(标签挂钩 工作流、工作树、.waffle/概览文档)只输出变更报告作为结构化文本。不要修改任何文件。
步骤 2:智能体文档
获取变更报告,生成 docs-agent 智能体,并提示如下:
这是 wafflestack 代码库的架构变更报告:
{步骤 1 输出}
更新机器文档——一个单一的根
AGENTS.md注册表——以反映项目的当前状态。读取实际源文件以验证细节——不要仅依赖变更报告。遵循 docs-agent 技能的格式和结构指南。
步骤 3:人类文档
在 docs-agent 完成后,生成 docs-human 智能体,并提示如下:
机器文档刚刚更新。更新人类面向的文档——仓库根目录下的
DECISIONS.md、STATUS.md和ARCHITECTURE.md——以保持一致。读取更新的机器文档和实际源代码以确保准确性。遵循 docs-human 技能的格式、结构及其护栏指南(所有者发声的文档会被标记,从不重写)。
重要事项
- 每个步骤必须完成后才能开始下一个——每个步骤的输出为下一个步骤提供输入。
- 步骤 1 是只读的——审计智能体仅报告。
- docs-agent 和 docs-human 应该修改它们各自的文档文件。