SuperAPI AI 工具集

document

写作与研究

查看项目

更新于 10-16 05:07

技能介绍

用途:在验证通过且用户批准任务后执行文档阶段,基于任务文档、测试报告和实际变更文件编写与更新文档,适用于软件任务收尾阶段的文档沉淀。

主要能力:按需在 docs/features/ 创建或更新面向开发者的功能文档;用户可见行为变化时在 docs/guides/ 创建或更新用户指南;在 docs/learnings/{ID}-{task-name}.md 写复盘;将可复用经验追加到 LEARNINGS.md(避免与已有条目重复);仅当任务确立了长期项目级约定时更新 AGENTS.md;在 TASKS.md 中把任务移到 Approved 并复核。

使用方式:先读 AGENTS.md;确定任务 ID;读取任务文档与测试报告;运行 git diff --name-only 识别实际变更文件;再按触发条件更新相应文档;最后在 TASKS.md 中把任务移到 Approved,并重新读取 TASKS.md 确认该任务行位于 Approved 且不在 Planned、In Progress 或 Testing 中,若此前阶段漏移则在此处补上。不同运行环境可能将此阶段暴露为斜杠命令、菜单操作或自然语言调用,可移植的阶段名称为 document。

文档触发条件:新增用户可见功能对应功能文档与用户指南;修复用户可见行为的缺陷对应故障排查或指南更新;API 或 CLI 行为变化对应开发者文档或参考说明;新增长期项目约定写入 AGENTS.md;可复用经验或坑点写入 LEARNINGS.md;测试环境搭建经验写入 LEARNINGS.md 与测试报告备注。

限:仅在验证通过且用户批准后运行;必须基于任务文档、测试报告与实际变更文件,不凭空编写。官方文本与具体价格、平台支持等信息暂未提供。