Skills
.Work. You
Rest

api-doc-checker

Official

Audit OpenHarmony API docs and catch inconsistencies.

Software Engineering#report generation#api documentation#quality audit#openharmony#findability#excel report#sdk consistency
Authoropenharmonyinsight
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps you evaluate the quality of OpenHarmony API documentation by detecting issues across multiple quality dimensions and (when applicable) verifying the documentation against the official SDK type definitions.

Core Features & Use Cases

  • Multi-dimension API documentation checks: Runs a comprehensive set of validations covering spelling, syntax, internal path consistency, example semantics, project structure conformance, findability, completeness, correctness, clarity, and capability-related guidance.
  • SDK source consistency validation (API docs only): Compares API documentation details with interface_sdk-js .d.ts definitions using file-to-SDK mapping rules and validates version/params/returns/systemapi markers/enums/interface fields.
  • Structured reporting: Produces an Excel (.xlsx) report with severity levels and optional Markdown summary for quick review.

Quick Start

Run api-doc-checker to check the OpenHarmony API documentation files in your workspace and generate an Excel report with identified quality issues.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-doc-checker
Download link: https://github.com/openharmonyinsight/openharmony-skills/archive/main.zip#api-doc-checker

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.