SuperAPI AI 工具集

docs-updater

写作与研究

查看项目

更新于 10-15 19:57

技能介绍

用途:docs-updater 用于在功能实现完成后,把实现进度同步到产品文档中,保持文档与代码一致。适用于 tasks.md 中指定了文档更新任务、功能实现已完成、用户要求“更新文档”或“同步文档”,以及关闭增量后需要让文档反映真实情况时。

主要能力:读取 tasks.md 中的任务要求,理解已实现的内容;更新 .specweave/docs/ 下的文档文件,写入实际实现;跟踪状态,将文档章节的 [DRAFT] 改为 [COMPLETE];维护文档与增量之间的双向链接;适配现有文档结构(features/ 或 modules/)。

工作流程:1. 读取 tasks.md,找到文档任务;2. 读取实现代码,理解变更;3. 更新文档,补充真实代码示例、端点、配置;4. 标记完成,将 [DRAFT] 改为 [COMPLETE];5. 验证链接,确保增量与文档引用有效。

集成点:由 spec-generator、任务完成钩子调用;更新 .specweave/docs/**/*.md;读取 tasks.md 和实现代码。

最佳实践:在功能任务完成后运行,而非执行过程中;验证文档链接有效(使用相对路径);保持示例与实际代码同步;不要过度记录,聚焦用户需要的内容。

项目特定经验:开始前可检查是否存在技能记忆:cat .specweave/skill-memories/docs-updater.md 2>/dev/null || echo "No project learnings yet"。反思系统会在开发中识别纠正或模式时自动捕获项目经验,帮助理解项目约定与过往决策。

限制:资料未提供具体安装命令、收费方式、支持平台或效果数据。