메뉴
Checks API documentation coverage and sync status against source header files. Use when adding new APIs, modifying header files, or auditing documentation completeness for openvela modules (kernel, bluetooth, media, telephony, etc).
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
NuttX/Vela 驱动代码质量审查（59 Pattern + 双轮交叉验证 + 量化评分）。 Use when: driver review, driver code review, 驱动审查, 驱动代码审查, review driver, 审查驱动代码, NuttX driver review, 驱动质量检查, review nuttx/drivers, review arch/ driver, 驱动提交前检查. 即使用户只说"帮我审查下这个驱动"也应触发。 驱动开发/实现(use nuttx-driver-development).
Create, update, review, or audit NuttX RTOS C device drivers. Covers sensor (uORB), char device, network (ethernet, MAC, PHY, DMA, netdev, SPI-Ethernet, CAN, SocketCAN, CAN FD, CAN bus, LIN, LIN bus, LIN master, LIN slave), framebuffer (fb, LCDC, display controller), LCD (SPI LCD, I2C LCD, ST7789, SSD1306, ILI9341, lcd_dev, lcd_framebuffer), USB (Host Controller Driver and device Controller Driver), audio (I2S smart PA, power amplifier, audio_comp), power/battery (charger, monitor, gauge), MCAL (AUTOSAR MCAL adaptation, EB Tresos, MCAL upper-half bridging), I2C/SPI bus, Kconfig/build integration, and board registration. Use for driver implementation, code audit, sensor/timer/LED/ethernet/CAN/LIN/fb/LCD/audio/PA/battery subsystems, or board bringup.
openvela 固件编译、配置和模拟器运行。Use when: 编译 openvela、build、make、构建、menuconfig、运行模拟器、emulator、编译报错修复。
向 openvela 社区提交 Pull Request。通过 Fork 模式提交（先 fork 上游仓库，push 到 fork，再从 fork 向上游提 PR）。支持单仓库或多仓库批量提交、指定文件/分支、自动检测 GitHub/Gitee 平台、分支模糊匹配、MCP 配置引导。Trigger: 提交 PR、提交代码到社区、push 到 openvela、创建 pull request、批量提交、多仓库提交。
openvela 技术书籍稿件审校 Agent。以资深技术书籍编辑和 NuttX 架构专家的视角，对飞书云文档中的书稿内容进行逐字逐句审查。 涵盖出版社写作规范（22 条）、技术准确性、编辑审校三个维度。 使用方式：提供飞书文档 URL 或 doc_id，Agent 将读取文档内容并输出审校报告和修改建议。 当用户提到以下关键词时触发：审校、审稿、书稿审查、稿件评审、review 书稿、检查文档规范、技术书审校、出版规范检查、书籍审校、manuscript review。
openvela 项目技术文档审校与优化。对 docs/ 目录下的 Markdown 文档进行结构化优化、术语规范、安全合规检查和技术准确性审校。 使用方式：提供一个 Markdown 文件路径，输出审校报告和优化后的完整文档。 当用户提到以下关键词时触发：文档审校、文档优化、docs 审查、Markdown 优化、技术文档规范、文档结构优化、review docs、文档润色。
| name | api-doc-check |
| description | Checks API documentation coverage and sync status against source header files. Use when adding new APIs, modifying header files, or auditing documentation completeness for openvela modules (kernel, bluetooth, media, telephony, etc). |
# 检查头文件变更时文档是否同步
bash .claude/skills/api-doc-check/scripts/check-api-doc-sync.sh
# 检查本次变更的 API 文档翻译质量（中文检查中英混杂，英文检查混入中文）
bash .claude/skills/api-doc-check/scripts/check-zh-translation.sh
# 作为 pre-commit hook 安装（两项检查都会执行）
cp .claude/skills/api-doc-check/scripts/pre-commit .git/hooks/pre-commit
确保 openvela 公开头文件（.h）与 API 参考文档（docs/zh-cn/api/）保持同步，防止头文件变更后文档未更新。
| 能力 | 说明 |
|---|---|
| ✅ 头文件-文档映射 | 维护 50+ 个头文件到文档的对应关系 |
| ✅ 变更检测 | 检测 git staged 中的头文件变更 |
| ✅ 同步校验 | 验证头文件变更时对应文档是否也有更新 |
| ✅ 翻译质量检查 | 检测中英文文档的翻译质量问题 |
| ✅ pre-commit 集成 | 可作为 git hook 阻止不同步的提交 |
当前维护的头文件 → 文档映射覆盖以下模块：
| 模块 | 映射数 | 头文件路径前缀 |
|---|---|---|
| 内核 | 5 | nuttx/include/ |
| 蓝牙 | 13 | frameworks/connectivity/bluetooth/framework/include/ |
| 多媒体 | 8 | frameworks/multimedia/media/include/ |
| Telephony | 12 | frameworks/connectivity/telephony/include/ |
| 系统框架 | 2 | apps/system/ / frameworks/system/ |
详细映射见 scripts/check-api-doc-sync.sh 中的 HEADER_DOC_MAP。
cp .claude/skills/api-doc-check/scripts/pre-commit .git/hooks/pre-commit
这会同时执行两项检查：
git commit --no-verify
scripts/check-api-doc-sync.sh 的 HEADER_DOC_MAP 中添加映射生成 API 文档时遵循以下格式：
### 函数名
\`\`\`c
返回类型 函数名(参数列表);
\`\`\`
功能描述。
**参数**：
- \`param1\` 描述。
**返回值**：
成功时返回 X，失败时返回 Y。
### 章节#include <xxx.h>