api-doc-checker
快速开始
检查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
More from openharmonyinsight/openharmony-skills
openharmony-cpp
Expert coding guide for OpenHarmony C++ development. Use this skill when writing, refactoring, or reviewing C++ code for OpenHarmony projects. It enforces strict project-specific conventions (naming, formatting, headers) and critical security requirements (input validation, memory safety).
81openharmony-security-review
Use when reviewing OpenHarmony C++ system service code for security vulnerabilities, particularly IPC handlers, multithreaded components, or code handling sensitive user data
80oh-ut-generator
|
67cpp-core-guidelines-review
Parallel C++ Core Guidelines code review using multiple specialized sub-agents. Use when reviewing C++ code, modules, or files against C++ Core Guidelines to identify violations. Each sub-agent reviews against a specific guideline section (Functions, Classes, Resource Management, etc.) and outputs findings to separate markdown files in the review/ directory, followed by a consolidated summary.
60openharmony-build
This skill should be used when the user asks to "编译 OpenHarmony", "build OpenHarmony", "编译完整代码", "执行编译", "编译 OpenHarmony 代码", "快速编译", "跳过gn编译", "fast-build", "编译测试", "编译测试用例", "build ace_engine_test", "编译 sdk", "编译 SDK", "build sdk", "build SDK", "编译 ohos-sdk", "编译测试列表", "build test list", "按列表编译测试", "编译指定测试", or mentions building the full OpenHarmony system, fast rebuild, test compilation, SDK compilation, or building tests from a target list. Handles complete build process including build execution, success verification, and failure log analysis with primary focus on out/{product}/build.log.
58ohos-chromium-security-review
|
57