SuperAPI AI 工具集

mcaf-documentation

写作与研究

查看项目

更新于 10-16 06:45

技能介绍

用途:MCAF: Documentation 是一个面向工程仓库的文档技能,用于创建或改进可长期维护的文档,重点处理文档结构、导航、事实来源(source-of-truth)放置与写作质量。当仓库文档缺失、过时、重复或难以导航,或需要更清晰的权威结构、需要在不膨胀页面的前提下补充长期工程指引时使用。

主要能力:产出具体的项目增量(代码、文档、配置、测试、CI 或评审产物);通过显式规划、验证与最终校验减少歧义;留下可复用的项目上下文,使后续任务更快更安全。

使用方式:先阅读最近的 AGENTS.md 确认范围与约束;按 Ralph Loop 执行工作流直至结果可接受;返回规定的 Required Result Format,包含具体产物与验证证据。工作流要点:写作前先决定每个事实的权威位置;优先使用链接到细节的导航型文档而非复制细节;保持引导页精简,把工作流脚手架移入技能;文档过时时与对应代码或策略在同一变更中更新。

适用场景:清理混乱的文档、把流程杂项移出公开页面、让仓库文档对智能体可导航。

限制:不适用于已有专门技能覆盖的具体功能规格或 ADR 写作;不适用于向公开页面倾倒大量模板内容。输入包括当前文档结构与入口页、文档应反映的代码/策略/工作流、重复或冲突的事实来源。验证标准:每个长期事实有唯一明确归属、入口页正确引导读者、页面不因模板或参考转储而膨胀、文档匹配真实仓库而非设想的未来仓库。若依赖缺失,可引导补齐或返回 status: not_applicable 并说明原因与回退路径。结果状态包括 complete、clean、improved、configured、not_applicable、blocked。参考文件为 references/documentation.md。