api-doc-checker
Installation
SKILL.md
快速开始
检查API文档质量的基本步骤:
- 判断文档类型 - 确定是API文档还是开发指南
- 加载规则 - 从
references/index.json加载规则模块 - 解析文档 - 提取文档结构信息(代码块、表格、链接、标题、方法签名等)
- 执行检查 - 根据文档类型执行相应的检查项
- 生成报告 - 生成Excel报告和可选的Markdown汇总
详细实现见:references/workflow-details.md
文档类型判断
API文档特征
- 文件名匹配模式:
js-apis-*.md、js-apis-app-ability-*.md、js-apis-inner-*.md、capi-*.md - 包含API方法签名、接口定义、参数说明
- 示例:
js-apis-geolocation.md、js-apis-app-ability-wantAgent.md