From HarmonyOS Skills
HarmonyOS官方文档快速查找Skill。在skill内部的references文件夹(包含2860个markdown文件)中高效检索开发文档、API参考、开发指导、常见问题等。使用三步查找法:先文件名匹配缩小范围,再内容搜索精确定位,最后读取目标文件。当用户开发HarmonyOS应用或插件时使用,适合API用法、功能实现、错误排查、Kit介绍、组件使用等任何需要查阅官方文档的情况。触发关键词:HarmonyOS开发、鸿蒙开发、鸿蒙适配、鸿蒙文档、ArkTS开发指导、@ohos API、Kit文档、组件用法、错误码查询、开发指南、如何实现、常见问题等。
How this skill is triggered — by the user, by Claude, or both
Slash command
/harmony-skills:harmonyos-docs-lookupThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
本skill帮助你在HarmonyOS官方文档markdown文件中高效定位所需内容。文档位于skill内部的`references/`文件夹,包含约2860个markdown文件。核心原则:**避免大量读取,优先使用文件过滤和内容搜索工具**。
references/AI-Agent Framework Kit(智能体框架服务)-Agent Framework Kit简介.mdreferences/AI-Agent Framework Kit(智能体框架服务)-通过Function组件拉起智能体.mdreferences/AI-Agent Framework Kit(智能体框架服务).mdreferences/AI-CANN Kit(CANN异构计算框架服务).mdreferences/AI-Core Speech Kit(基础语音服务)-Core Speech Kit简介.mdreferences/AI-Core Speech Kit(基础语音服务)-个人数据处理说明.mdreferences/AI-Core Speech Kit(基础语音服务)-文本转语音.mdreferences/AI-Core Speech Kit(基础语音服务)-语音识别.mdreferences/AI-Core Speech Kit(基础语音服务).mdreferences/AI-Core Vision Kit(基础视觉服务)-Core Vision Kit简介.mdreferences/AI-Core Vision Kit(基础视觉服务)-个人数据处理说明.mdreferences/AI-Core Vision Kit(基础视觉服务)-主体分割.mdreferences/AI-Core Vision Kit(基础视觉服务)-人脸检测.mdreferences/AI-Core Vision Kit(基础视觉服务)-人脸比对.mdreferences/AI-Core Vision Kit(基础视觉服务)-多目标识别.mdreferences/AI-Core Vision Kit(基础视觉服务)-通用文字识别.mdreferences/AI-Core Vision Kit(基础视觉服务)-骨骼点检测.mdreferences/AI-Core Vision Kit(基础视觉服务).mdreferences/AI-Intents Kit(意图框架服务)-Intents Kit接入流程.mdreferences/AI-Intents Kit(意图框架服务)-Intents Kit简介.md本skill帮助你在HarmonyOS官方文档markdown文件中高效定位所需内容。文档位于skill内部的references/文件夹,包含约2860个markdown文件。核心原则:避免大量读取,优先使用文件过滤和内容搜索工具。
传统方法是逐个读取文件或盲目搜索,这在2860个文件中极其低效。正确的做法是:
这样可以把查找时间从"需要读取数百个文件"降低到"只需读取几个文件"。
HarmonyOS官方文档markdown文件位于skill内部的**references/文件夹**。
在本SKILL.md中,references/...表示相对于当前skill base directory的逻辑路径,不是相对于用户当前工作目录的路径。
实际调用工具前,先按以下规则处理路径:
references/...解析到当前skill目录下references/...D:\references\...)查找因此,查找与读取时遵循:
references/下匹配*关键词*.mdreferences/或候选文件集合中搜索关键词references/文档名.md;必要时传绝对路径查找文档时强烈建议先用脚本,脚本结果不满足时再使用三步查找法。
根据 API 名称自动搜索所有相关文档,按优先级排序,帮助快速筛选最佳实践。
核心价值:不只搜索 API 签名,自动搜出最佳实践文档。
# 单个或多个 API(空格分隔)
python scripts/search_api_related_docs.py PinchGesture PanGesture Image
# JSON 输出
python scripts/search_api_related_docs.py PinchGesture --json
输入 API: PinchGesture, PanGesture, Image
| 优先级 | 类型 | 匹配API数 | 文件名 | 匹配的API |
|--------|------|-----------|--------|----------|
| 8 | 最佳实践 | 3 | 图片预览器.md | PinchGesture, PanGesture, Image |
| 5 | 最佳实践 | 1 | 单一手势.md | PinchGesture |
**推荐**:图片预览器.md(匹配 3 个 API,包含完整实现)
| 类型 | 优先级 | 判断条件 | 包含内容 |
|---|---|---|---|
| 最佳实践 | 5 | 文件名含 "最佳实践"、"实践"、"预览器"、"示例"、"场景化"、"解决方案" | 完整实现代码 + 正确用法 |
| 开发指导 | 4 | 文件名含 "(ArkTS)"、"(C_C++)"、"开发指导" | 开发步骤 + 示例 |
| 常见问题 | 3 | 文件名含 "常见问题"、"如何"、"FAQ" | 问题原因 + 解决方案 |
| 概述 | 2 | 文件名含 "简介"、"概述" | 功能介绍 |
| API参考 | 1 | 其他 | API 签名(不含正确用法) |
最佳实践与 API 签名是互补的,都要参考:
PinchGesture API 参考 → 接口定义、参数类型、返回值图片预览器.md 最佳实践 → 缩放中心计算公式、边界处理、性能优化脚本按优先级排序,优先展示最佳实践文档。但完整实现需要结合两者:
目的:从2860个文件中快速筛选出10-50个候选文件
方法:根据查询主题,使用支持通配符或glob的工具匹配文件名模式。匹配模式中的references/...先按当前skill目录解析;如果工具按cwd解析,则改用绝对路径。
常见文件名模式:
@装饰器名装饰器:说明.md # 状态管理装饰器(如@State、@Link)
Kit名简介.md # Kit介绍文档
功能名(ArkTS).md # ArkTS开发指导
功能名(C_C++).md # C/C++开发指导
组件名.md # UI组件文档(如Button、Text)
Kit名(服务名).md # Kit完整名称文档
错误码 原因.md # 错误码说明文档
如何...md # 常见问题解答
...常见问题.md # FAQ文档
...概述.md # 功能概述文档
...开发指导(ArkTS).md # 开发步骤指导
使用...实现...md # 实践示例文档
文件名匹配示例:
references/*相机*.mdreferences/*音频播放*.md或references/*AudioRenderer*.mdreferences/@State*.mdreferences/*Button*.mdreferences/401*.mdreferences/*Camera Kit*.mdreferences/*网络*.mdreferences/*Web组件*.md或references/*WebView*.md目的:在10-50个候选文件中搜索内容关键词,缩小到1-5个最相关文件
方法:使用grep或全文搜索类工具搜索特定API、方法名、错误信息等精确关键词。优先限制在候选文件内搜索,不要依赖某个固定工具的参数格式。
何时使用:
内容搜索示例:
getCameraManager方法 → 在references/*相机*.md中搜索getCameraManagerAudioRenderer创建方法 → 在references/*AudioRenderer*.md中搜索create@ohos.multimedia.camera导入 → 在相机文档中搜索import目的:读取最终确定的1-3个最相关文件,获取完整信息
方法:读取最终确定的目标文件。读取前先将逻辑路径解析到当前skill目录;如果读取工具按cwd解析相对路径,则改用绝对路径。
注意:
这是快速查找的关键:知道什么主题用什么关键词搜索
| 主题 | 推荐文件名关键词 | 内容关键词示例 |
|---|---|---|
| 状态管理 | @State, @Link, @Prop, @Observed, 状态管理 | 状态变量、装饰器、同步 |
| UI组件 | Button, Text, List, Grid, Swiper, Progress | 组件名、属性、方法 |
| 路由导航 | 页面路由, 路由, router | pushUrl、replaceUrl、back |
| 动画 | 动画, 属性动画, 转场 | animateTo、animation |
| Lottie | Lottie- | LottieView、loadAnimation、@ohos/lottie-turbo、@ohos/lottie |
| 手势交互 | 手势, 拖拽, 绑定手势 | gesture、GestureEvent |
| 布局 | 布局, 线性布局, 弹性布局, 层叠布局, Flex, Stack | Row、Column、Flex |
| 弹窗 | 弹窗, 弹出框, Dialog, CustomDialog | showDialog、CustomDialog |
| 主题 | 推荐文件名关键词 | 内容关键词示例 |
|---|---|---|
| 相机 | 相机, Camera, 拍照, 录像 | CameraManager、CameraInput、preview |
| 音频 | 音频, Audio, AudioRenderer, 播放, 录制 | AudioRenderer、create、start |
| 视频 | 视频, Video, 播放, AVPlayer | AVPlayer、AVRecorder |
| 网络 | 网络, HTTP, WebSocket, Socket | http.request、WebSocket |
| 存储 | 数据库, 存储, Preferences, 键值, 关系型 | RdbStore、Preferences |
| 文件 | 文件, 文件管理, 沙箱 | fileIo、FilePicker |
| 位置 | 位置, 定位, 地理围栏, geoLocationManager | getCurrentLocation |
| 传感器 | 传感器, Sensor | sensor.on、subscribe |
| 主题 | 推荐文件名关键词 | 内容关键词示例 |
|---|---|---|
| Account Kit | Account Kit, 账号, 华为账号, 登录, 一键登录 | Account Kit、login |
| Ads Kit | Ads Kit, 广告 | Ads Kit、BannerAd |
| AppGallery Kit | AppGallery, 应用市场 | AppGallery Kit、评论 |
| Wallet Kit | Wallet Kit, 卡券, 支付 | Wallet Kit、卡券 |
| Notification Kit | 通知, Notification, 推送 | Notification Kit、publish |
| App Linking | App Linking, 链接 | App Linking、link |
| 主题 | 推荐文件名关键词 | 内容关键词示例 |
|---|---|---|
| 错误码查询 | 错误码(如401、1001500001等) | 错误码、解决办法、可能原因 |
| 权限问题 | 权限, 申请权限, 授权 | permission、requestPermission |
| 权限详情查询 | 直接读取 references/permissions_full.json | 权限名称、类型、授权方式、版本、描述 |
| 性能问题 | 性能, 优化, 卡顿 | 性能优化、检测 |
| 编译问题 | 编译, 打包, 签名 | 编译失败、签名 |
| 运行时问题 | 常见问题, 如何解决, FAQ | 具体错误信息 |
| 主题 | 推荐文件名关键词 | 内容关键词示例 |
|---|---|---|
| AR/VR | AR, AR Engine | AR Engine、ARSession |
| 安全 | 安全, 加密, 密钥, 权限 | Cipher、Key、加密 |
| 无障碍 | 无障碍, Accessibility | Accessibility、accessibility |
| 多语言 | 多语言, 国际化 | i18n、Localization |
| 分布式 | 分布式, 跨设备 | distributed、跨设备 |
文件名均以 Lottie- 开头,与官方文档区分。来源:lottie_turbo、lottieArkTS。
| 文件 | 用途 |
|---|---|
Lottie-库选型与迁移指南.md | 两库对比、选型、最小迁移(不确定用哪个库时先读) |
Lottie-@ohos-lottie-turbo开发指南.md | @ohos/lottie-turbo 声明式 LottieView 完整说明 |
Lottie-@ohos-lottie-ArkTS开发指南.md | @ohos/lottie Canvas + loadAnimation 完整说明 |
Lottie-@ohos-lottie-turbo-API类型声明.d.ts | turbo API 类型 |
Lottie-@ohos-lottie-ArkTS-API类型声明.d.ts | ArkTS 版 API 类型 |
选型原则:新项目优先 lottie-turbo;已有 Canvas + loadAnimation 代码用 lottieArkTS 或按迁移指南升级。
查找示例:
references/Lottie-*.md 或 references/Lottie-*turbo*Lottie- 文档为准用户问题:如何在HarmonyOS应用中实现相机拍照功能?
查找流程:
references/下匹配*相机*.md或*拍照*.md
拍照
references/拍照.md、references/拍照实践.md、references/相机管理.md
用户问题:AudioRenderer播放音频的完整流程是什么?
查找流程:
references/下匹配*AudioRenderer*.md或*音频播放*.md
AudioRenderer
references/使用AudioRenderer开发音频播放功能.md
用户问题:应用出现401错误码,如何解决?
查找流程:
references/下匹配401*.md
references/401 参数检查失败的可能原因和解决办法.md
用户问题:Button组件有哪些常用属性和样式设置?
查找流程:
references/下匹配*Button*.md
references/按钮.md和references/场景化Button.md
用户问题:@State装饰器的使用规则和最佳实践?
查找流程:
references/下匹配@State*.md
references/@State装饰器:组件内状态.md(可能较长,分段读取)
用户问题:鸿蒙项目如何播放 AE 导出的 JSON 动画?
查找流程:
references/Lottie-库选型与迁移指南.md(确定 turbo 或 ArkTS)references/Lottie-*开发指南.mdrawfile、LottieView 或 loadAnimationLottie-@ohos-lottie-turbo开发指南.md;Canvas 方案读 Lottie-@ohos-lottie-ArkTS开发指南.mdLottie-*-API类型声明.d.tsreferences/...先解析为当前skill下的实际路径,必要时使用绝对路径references/*.md或references/*开发*.mdreferences/...当成相对当前工作目录的路径:先按skill目录解析,再调用工具快速判断文档类型,决定读取优先级:
| 文档类型 | 特征 | 内容特点 | 读取优先级 |
|---|---|---|---|
| 开发指导 | 文件名含"(ArkTS)"或"(C_C++)"、"开发指导" | 完整步骤、示例代码 | 最高 |
| API参考 | 文件名含Kit名、方法名、API名 | API说明、参数、返回值 | 高 |
| 概述/简介 | 文件名含"概述"、"简介"、Kit名+"简介" | 功能介绍、架构说明 | 中(先读) |
| 常见问题 | 文件名含"常见问题"、"如何"、错误码 | 问题原因、解决方案 | 根据需求 |
| FAQ | 文件名含"FAQ"、"问答" | 常见疑问解答 | 根据需求 |
| 最佳实践 | 文件名含"最佳实践"、"实践" | 优化建议、推荐做法 | 补充阅读 |
如果三步查找法没有找到满意的文档:
references/*相机*.md扩展到references/*Camera*.md).d.ts,位于 skill 内部 references/)api-references/ 下 4000+ 官方 API markdown)@ohos/lottie、@ohos/lottie-turbo 类型声明均在本 skill 的 references/Lottie-* 中,不在 SDK API lookupreferences/...视为skill内逻辑路径,不要视为相对用户当前工作目录的路径references/references/下匹配*关键词*.mdreferences/*相机*拍照*.md这类模式references/中搜索关键词path、include等过滤能力,可用它限制范围,但不要依赖某个固定参数格式references/文档名.md解析为当前skill下的实际路径核心查找原则:
references/...先解析到当前skill目录,必要时改用绝对路径掌握这个三步查找法,可以在2860个文档中快速定位所需信息,避免大量无效读取,提高查找效率。
Creates, edits, and optimizes skills for Claude Code, including drafting, evaluating with test prompts, iterating on performance, and improving skill descriptions for better triggering accuracy.
npx claudepluginhub harmonyos-ai/harmony-skills --plugin harmony-skills