文档模板
新建产品文档时,复制对应模板使用。模板中的 [] 占位符需替换为实际内容。
模板清单
产品介绍
文件名:[型号]/index.md
markdown
# [产品名称] — [一句话定位]
## 产品概览
[产品简介:是什么芯片/模组,解决什么问题,适用什么场景。2-3 句话]
## 核心参数
| 参数 | 规格 |
|------|------|
| 芯片型号 | [型号] |
| 视频输入 | [接口类型和信号格式] |
| 最高分辨率 | [分辨率@帧率] |
| 接口 | [USB/HDMI/...] |
| 协议 | [UVC/UAC/V4L2/...] |
| 像素格式 | [YUY2/MJPEG/...] |
| 工作温度 | [范围] |
## 快速入口
- [快速上手](./quick-start)
- [驱动安装](./driver-install)
- [接口说明](./api-reference)
- [常见问题](./faq)快速上手
文件名:[型号]/quick-start.md
markdown
# [产品名称] 快速上手
## 准备工作
- [硬件清单]
## 第一步:硬件连接
[连接步骤 + 示意图]
## 第二步:驱动安装
[简要说明,链接到驱动安装详细页]
## 第三步:出图测试
### Windows (OBS)
[步骤]
### Linux (ffplay)
```bash
[命令]
```
## 下一步
- [相关文档链接]驱动安装
文件名:[型号]/driver-install.md
markdown
# [产品名称] 驱动安装
## Linux
[驱动说明和命令]
## Windows
[安装步骤]
## macOS
[说明或兼容性备注]接口说明
文件名:[型号]/api-reference.md
markdown
# [产品名称] 编程接口
## [协议名称] API
### 打开设备
```c
[代码示例]
```
### 设置参数
[参数说明]FAQ
文件名:[型号]/faq.md
markdown
# [产品名称] 常见问题
## 图像问题
### Q: [问题描述]
[原因和解决方案]
## 连接问题
### Q: [问题描述]
[排查步骤]
## 兼容性
### Q: [问题描述]
[兼容性说明]