SuperAPI AI 工具集

compound-docs

写作与研究

查看项目

更新于 10-16 09:56

技能介绍

用途:在问题解决后记录过程知识,供团队复用,并作为 /ia-compound 的流程支持。适用于需要撰写已解决事项经验、教训总结的场景。

主要能力:采用单文件架构,每个问题一个 Markdown 文件,按症状分类存入目录(如 docs/solutions/performance-issues/n-plus-one-briefs.md),文件头使用 YAML frontmatter 存元数据;遵循 7 步文档采集流程;支持自动触发(出现“that worked”“it's fixed”等确认语后调用,琐碎修复跳过);收集上下文(模块、症状、调查尝试、根因、解决方案、预防措施),关键上下文缺失则阻断;检查既有文档并给出新建交叉引用、更新或其它选项;按 [sanitized-symptom]-[module]-[YYYYMMDD].md 生成文件名;校验 YAML;用 resolution-template.md 写入文档;建立交叉引用并识别同类问题达到 3 个以上的关键模式。

使用方式:将草稿存为临时 Markdown 文件后运行 validate-frontmatter.sh 校验;校验器依赖 Python 3 与 PyYAML,若缺少依赖应如实报告而非声称已校验,失败则修正 frontmatter 后重跑。完成文档后通过 AskUserQuestion(Claude Code,未加载时用 ToolSearch 的 select:AskUserQuestion)或 request_user_input(Codex)呈现决策菜单,也可回退到聊天中的编号菜单并等待用户回复。依赖安装命令为 python3 -m pip install PyYAML(需获授权)。

适用场景与限制:适合团队将排障经验沉淀为可查文档;采集门槛要求:若未来工程师阅读最终代码、测试、注释、CLAUDE.md/AGENTS.md 及现有文档或技能后仍会重犯或重做调查,才值得记录。相关参考包括 documentation-process.md、yaml-schema.md、quality-guidelines.md、example-scenario.md、resolution-template.md、critical-pattern-template.md、validate-frontmatter.py 等。资料未提供收费、价格与具体平台支持信息。