# skill-harmonyos-docs-main

**Repository Path**: ambitiouscat/skill-harmonyos-docs-main

## Basic Information

- **Project Name**: skill-harmonyos-docs-main
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-01
- **Last Updated**: 2026-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# skill-harmonyos-docs

HarmonyOS 开发文档离线检索库，为 AI 辅助开发工具（如 Claude Code Skills、CodeArts Doer 等）提供结构化的鸿蒙开发文档快速定位能力。

## 项目简介

本项目从 HarmonyOS 官方开发者文档站点抓取并整理了 **API 23（HarmonyOS 6.0）** 的完整开发文档，涵盖 API 参考、开发指南、最佳实践三大核心分区，共计 **18,932 篇文档**，总内容量约 **363 MB**。

核心设计采用 **分类目录 + 子索引两步检索法**：AI 先读取极小的分类目录（1-3 KB）确定文档所属分类，再按需读取对应子索引精确定位，避免一次性加载大文件，显著降低 token 消耗。

## 文档统计

| 分区 | 文档数 | 大小 | 说明 |
|------|--------|------|------|
| API 参考 (api/) | 7,600 | 174 MB | ArkTS API、C API、组件接口定义 |
| 开发指南 (guides/) | 10,380 | 165 MB | 应用框架、系统服务、媒体图形等开发指导 |
| 最佳实践 (best/) | 860 | 22 MB | 性能优化、稳定性、功耗、布局等实践方案 |
| 版本说明 (releases/) | 92 | 1.8 MB | API 变更清单、平台行为变更说明 |
| **合计** | **18,932** | **~363 MB** | |

## 目录结构

```
skill-harmonyos-docs/
├── README.md                   # 本文件
├── SKILL.md                    # 技能定义（激活条件、检索工作流）
├── INDEX.md                    # 总索引入口
├── api/                        # API 参考文档
│   ├── QUICK_INDEX.md          # 分类目录（~2 KB，第一步检索入口）
│   ├── QUICK_ENTRY.md          # 快速入口（API 名称 → 路径直接映射）
│   ├── _index/                 # 分类子索引（第二步精确定位）
│   │   ├── ArkUI组件.md        # 329 项
│   │   ├── ArkUI_API.md        # 72 项
│   │   ├── 应用服务.md         # 159 项
│   │   └── ...
│   ├── index.md                # 层级导航入口（备选方案）
│   └── 应用框架/系统/AI/...    # 原始文档，按 Kit/模块分层
├── guides/                     # 开发指南文档
│   ├── QUICK_INDEX.md          # 分类目录（~2 KB）
│   ├── _index/                 # 分类子索引
│   │   ├── 01.md ~ 19.md      # 按编号的分类子索引
│   │   └── ...
│   ├── index.md                # 层级导航入口
│   └── 应用框架/系统/媒体/...  # 原始文档，按功能分层
├── best/                       # 最佳实践文档
│   ├── QUICK_INDEX.md          # 分类目录（~3 KB）
│   ├── _index/                 # 分类子索引
│   │   ├── 性能.md             # 51 项
│   │   ├── 稳定性.md           # 53 项
│   │   └── ...
│   ├── index.md                # 层级导航入口
│   └── 性能/稳定性/媒体/...    # 原始文档，按场景分层
└── releases/                   # 版本发布说明
    └── 版本说明/
        └── HarmonyOS 6.1.0(23)/
            ├── 版本概览.md
            ├── OS新增和增强特性.md
            ├── OS平台行为变更说明/
            └── API变更清单/
```

## 检索方式

### 方式一：快速入口（推荐，已知具体 API 名称）

直接读取 `api/QUICK_ENTRY.md`（约 10 KB），通过 API 名称关键词映射到文档路径，一步到位。

### 方式二：两步检索法（探索式查找）

1. **读取分类目录**：根据需求读取对应的 `QUICK_INDEX.md`（1-3 KB）
   - 查 API → `api/QUICK_INDEX.md`
   - 查指南 → `guides/QUICK_INDEX.md`
   - 查实践 → `best/QUICK_INDEX.md`
2. **读取子索引**：根据分类目录确定所属分类，读取 `_index/分类名.md` 精确定位
3. **读取目标文档**：按子索引中的路径读取 `.md` 文件

### 方式三：层级导航（备选）

从 `index.md` 入口逐层浏览，适合不确定分类时的兜底方案。

## 版本信息

- **API 级别**：API 23（HarmonyOS 6.0）
- **ArkTS API 数**：1,219（已排除 C API / JS 组件 / 已停止维护 / 错误码）
- **文档生成时间**：2026-04-24
- **最后更新时间**：2026-04-25

## 作为 AI Skill 使用

本项目设计为 Claude Code / CodeArts Doer 等 AI 工具的 Skill 插件：

1. 将本项目放置到 Skills 目录下
2. AI 会在开发 ArkTS/HarmonyOS 应用时自动激活
3. 激活后 AI 通过两步检索法快速定位所需文档，无需联网查询

详细激活条件和工作流定义见 [SKILL.md](SKILL.md)。

## 许可证

MIT License