OHOS-Docs-SKILL:基于 OpenHarmony 的开发文档索引查询引擎项目

用户可借助该项目高效查询 OpenHarmony/HarmonyOS 开发文档,它拥有 8700+ 份中文文档,采用三级渐进式索引架构,覆盖应用开发、设备开发等多领域,面向 AI 编程助手,能实现精准快速的文档定位。【此简介由AI生成】

分支1Tags0
文件最后提交记录最后更新时间
1 个月前
1 个月前
1 个月前
1 个月前
1 个月前
1 个月前
1 个月前
1 个月前
1 个月前
1 个月前

ohos-dev-docs — OpenHarmony 开发文档查询 Skill

OpenHarmony / HarmonyOS 开发文档索引查询引擎。8700+ 份中文开发文档,三级渐进式索引架构,面向 AI 编程助手(OpenCode 等)。

前置条件:准备原始文档

本 skill 索引的 OpenHarmony 中文文档需要提前下载到本地。建议放在用户根目录(~/ohosDocs)下,这也是本 skill 的默认文档路径。

方式一:从上游仓库克隆(推荐,覆盖最新)

# 1. 克隆 OpenHarmony 官方文档仓库(仅需最新版本)
git clone --depth 1 https://gitcode.com/openharmony/docs.git /tmp/ohos-docs-repo

# 2. 将中文文档复制到默认路径(仅复制 zh-cn,不要 en)
mkdir -p ~/ohosDocs
cp -r /tmp/ohos-docs-repo/zh-cn/* ~/ohosDocs/

# 3. 清理临时文件
rm -rf /tmp/ohos-docs-repo

方式二:手动指定路径

如果文档放在其他路径,需修改本 skill 下所有索引文件中的文档路径前缀 /home/user/ohosDocs/ 为你实际路径。

安装本 skill

npx skills add https://gitcode.com/<你的仓库地址>

或手动复制到 OpenCode 全局 skill 目录:

cp -r ohos-dev-docs/ ~/.config/opencode/skills/ohos-dev-docs/

目录结构

ohos-dev-docs/
├── SKILL.md                              ← L1: 入口 + 问题初筛
│
├── application-dev-index.md              ← L2: 应用开发大类总览
├── device-dev-index.md                   ← L2: 设备开发大类总览
├── reference-index.md                    ← L2: API 参考
├── release-notes-index.md                ← L2: 版本说明
├── contribute-design-index.md            ← L2: 贡献与设计
├── third-party-index.md                  ← L2: 三方生态
│
├── application-dev/                      ← L3: 43 个细分索引
│   ├── ui-index.md              (324篇)
│   ├── security-index.md         (276篇)
│   ├── media-index.md            (207篇)
│   ├── application-models-index.md (133篇)
│   ├── napi-index.md             (114篇)
│   ├── arkts-utils-index.md      (93篇)
│   ├── performance-index.md      (72篇)
│   ├── web-index.md              (58篇)
│   ├── database-index.md         (40篇)
│   └── ... (其余 34 个)
│
└── device-dev/                           ← L3: 12 个细分索引
    ├── kernel-index.md           (137篇)
    ├── subsystems-index.md       (128篇)
    ├── driver-index.md           (55篇)
    └── ... (其余 9 个)

三级渐进式索引工作机制

层级 文件 作用 上下文开销
L1 SKILL.md 问题分类、初筛,引导到 L2 ~3KB
L2 *-index.md 大类概览,列出子领域并引导到 L3 ~3KB 每个
L3 application-dev/*-index.md 具体文档路径 + 梗概,直接引用 ~5-35KB 每个

AI 根据用户问题,从 L1 开始逐级深入,不会一次性加载全部索引。

分类覆盖

L2 大类 文档数 覆盖内容
应用开发 ~5,300 ArkTS、ArkUI、Ability、安全、媒体、网络、数据库、性能、NAPI 等 43 个子领域
设备开发 ~1,764 驱动、内核、子系统、移植、编译烧录、XTS
API 参考 ~3,393 所有 Kit 的 JS/C++ API 接口、错误码、SysCap
版本说明 ~1,399 版本发布记录、API Diff、Changelog
贡献与设计 ~120 编码规范、UX/UI 设计规范、交互指南
三方生态 ~63 三方案例、三方组件集成

项目介绍

用户可借助该项目高效查询 OpenHarmony/HarmonyOS 开发文档,它拥有 8700+ 份中文文档,采用三级渐进式索引架构,覆盖应用开发、设备开发等多领域,面向 AI 编程助手,能实现精准快速的文档定位。【此简介由AI生成】

定制我的领域