SuperAPI AI 工具集

mcaf-documentation

写作与研究

查看项目

更新于 10-16 00:05

技能介绍

用途:该技能针对文档缺失、过时、重复或难以导航的情况,帮助仓库建立更清晰的权威来源(source-of-truth)结构,并补充可长期使用的工程指导,同时避免页面臃肿。适用于整理杂乱文档、把流程性内容移出公开页面、让仓库文档更便于代理导航等请求。

主要能力:先为每条事实确定唯一权威位置,再编写文档;倾向使用带链接的导航型文档而非复制细节;保持引导页精简,把工作流脚手架移入技能;在代码或政策变更的同一变更中更新过时文档。交付物包括更清晰的文档结构、更好的权威来源位置,以及与实际代码和工作流一致的文档。

使用方式:先阅读最近的 AGENTS.md 并确认范围与约束;按照 Ralph Loop 执行工作流直至结果可接受;最后按“Required Result Format”返回具体产物与验证证据。Ralph Loop 要求先强制头脑风暴(分析现状、定义问题与目标、约束和风险、生成选项并权衡),再制定详细执行计划(含最终验证技能的运行顺序与理由),然后逐步执行、审查、小批量修复并更新计划,直至可接受或仅剩明确例外。若缺少依赖,可自行引导或返回 status: not_applicable 并说明原因与回退路径。

结果格式:status 可取 complete、clean、improved、configured、not_applicable、blocked;同时给出 plan、actions_taken、validation_skills、verification、remaining。仅设置类请求返回 status: configured 与确切的后续命令。

限制与不适用:不用于已经适配的特定功能规格或 ADR 写作;不用于把大量模板内容倾倒到公开页面。验证要点:每条持久事实只有一个明确归属;入口页能正确引导读者;页面不因模板或参考堆砌而臃肿;文档反映真实仓库而非未来设想。参考文件为 references/documentation.md。官方资料未提供收费、价格与平台信息。