SuperAPI AI 工具集

documentation-automation

写作与研究

查看项目

更新于 10-16 03:47

技能介绍

用途:当文档质量需要由脚本、CI 或本地钩子强制执行,而非仅靠人工审查时使用本技能。

主要能力与触发条件:为项目添加 docs:* 脚本;配置 markdownlint、cspell、lychee 或 remark-lint;从源码注释生成 API 文档;为文档添加预提交或 CI 校验;在多个仓库间统一文档检查。

自动化目标:构建生成的 API 文档、检查 Markdown 结构与风格、校验内外部链接、验证代码示例与命令、在行为变更时强制更新 changelog 或 README。

推荐流水线:添加无需 CI 即可运行的本地命令;让 CI 调用相同命令;保持失败输出可操作且快速;预提交做增量检查,CI 做更完整检查。

文档栈参考:继承 documentation-patterns 中的共享栈(事实来源发现、受众定位、结构选择、验证与新鲜度检查),本技能聚焦自动化流水线。

跨客户端可移植:适配 GitHub Copilot、Claude Code 和 Codex。Codex 需将文件夹安装或同步到 $CODEX_HOME/skills/documentation-automation 并在重大变更后重启。

MCP 与回退:无需 MCP 服务器。回退提示为在不使用 MCP 的情况下依赖本地说明、捆绑资源、标准 shell 或编辑器工具及直接验证,并在结论前展示所用证据;宿主未暴露 MCP 时不得声称使用了 MCP 操作。

反模式:为作者而非读者写作、跳过具体示例或命令、放任链接与版本漂移。

验证协议:输出需识别受众、目的、事实来源与新鲜度要求;引用共享文档栈指导而非重复其他技能;对声明、链接、命令、示例与截图进行验证或明确标注未验证。成功标准为零未记录假设,每个面向读者的声明都有出处或范围限定。