SuperAPI AI 工具集

documentation-quality

测试与质量

查看项目

更新于 10-16 03:47

技能介绍

用途:这是一个文档质量审查技能,用于在文档审查、合并或发布前,按明确标准而非主观偏好判断文档质量。触发场景包括:合并前审查文档、创建或更新风格指南、定义示例/结构/术语的期望、审计文档集的一致性与可读性。

主要能力:核心标准包括清晰的受众与范围、稳定的标题层级、可运行或诚实的示例、一致的术语、明确写出边界情况/约束/失败模式。技能强调继承共享的文档栈(来源发现、受众界定、结构选择、验证与时效检查),本身聚焦质量门禁。附带文档写作标准参考,以及一个文档风格审计脚本,可检查 Markdown 文件的标题跳级、过长行、制表符和行尾空白。

使用方式:给出待审查文档(文件或粘贴草稿)与受众,检查清晰度、完整性、示例准确性、术语一致性和过期引用;先报告具体发现,再建议最小高价值修复。验证通过项包括:输出明确了受众、目的、事实来源与时效要求;引用了共享文档栈指导而非重复他人;声明、链接、命令、示例、截图均经验证或明确标注未验证。

限制:无需 MCP 服务器;若宿主未提供 MCP,须使用本地说明、附带资源、标准 shell 或编辑器工具及直接验证作为回退,不得声称使用了不存在的 MCP 操作。需避免面向作者而非读者写作、跳过硬示例、让链接/截图/版本漂移等反模式。安装方式资料仅提及:Codex 可将文件夹同步到 $CODEX_HOME/skills/documentation-quality 并重启;GitHub Copilot 与 Claude Code 的路径要求见原文。相关技能包括 documentation-authoring、documentation-patterns、documentation-verification、notion-docs。官方文本暂未提供。