产品供料清单与模板
给视端威工程师:你不用写 Markdown、不用碰 Git,只要按这份清单把真实材料给到文档团队,整理、排版、上线由团队完成。
(想自己写文档、直接提交的,看 工程师上手指南。)
一个原则
你只负责 准、全——内容真实、不漏项;排版和成文交给文档团队。技术文档不能编,驱动步骤、接口参数、框图都得是真的。
标记说明:
- 🔴 必须由工程师提供——文档团队编不出来,只能你给。
- 🟡 规格书里基本有——你核对确认即可,不用重写。
一、怎么交付
- 一个产品一份,文字 / Word / 记事本都行,按下面的填空模板填;填不了的写「无」或「待补」。
- 不用排版、不用管好不好看——内容对就行。
- 附件单独发,命名
型号_类型,例如:EM2860_框图.png(系统框图 / 引脚图)EM2860_出图截图.png(成功运行的画面)EM2860_linux驱动.txt、EM2860_示例代码.c- 规格书 PDF(或注明文件名 + 版本号 + 相关页码)
- 交给谁:发企业微信,或放共享盘
产品文档供料/目录。
二、每个产品要提供的内容
对应文档站每个产品的 6 个板块。
1. 产品概览 🟡
- 一句话定位:是什么芯片 / 模组、给谁用、典型应用场景 🔴
- 2–3 条核心卖点 🟡
2. 核心参数表 🟡
规格书为准,工程师核对:
| 字段 | 说明 |
|---|---|
| 芯片型号 | |
| 视频输入 | 信号类型(CVBS / HDMI / MIPI 等) |
| 视频输出 | |
| 最大分辨率 · 帧率 | |
| 接口 | USB2.0 / 3.0?是否 Type-C? |
| 音频 | |
| 支持驱动 | V4L2 / DirectShow / SDK |
| 工作温度 | |
| 功耗 | |
| 封装 / 尺寸 |
重点核对(易错项)
USB 版本和分辨率上限以前出现过与实际对不上的情况,请务必明确勾对。
- 🔴 系统框图:规格书里有就给页码,没有请提供图片。
3. 快速上手(接线 → 出图)🔴
多数要实测:
- 怎么接:接哪个口、要什么线 / 转接头
- 最小步骤:插上 → 装驱动 → 打开什么软件 → 看到图
- 推荐测试软件:Windows 用什么、Linux 用什么
- 成功标志:出图分辨率 / 帧率截图
4. 驱动安装 🔴
全部实料:
- Windows:驱动哪下载 / 版本号 / 安装步骤 / 设备管理器里显示的设备名
- Linux:模块名或 V4L2 节点(/dev/videoX)/ 加载命令 /
v4l2-ctl验证命令 - 兼容性:支持哪些系统(Win10 / 11、哪些内核版本)
- 驱动文件本身或可靠下载链接
5. 接口说明 / API 🔴
- 对外编程接口:V4L2 / DirectShow / 自家 SDK,能做什么
- 一段最小可跑示例代码(片段也行)
- 支持的分辨率 / 像素格式枚举
- 对外开放的关键参数 / 寄存器(若有)
6. 常见问题 FAQ 🔴
最有价值:
- 客户最常问的 5–10 个问题 + 标准答复
- 已知限制 / 坑:哪些场景不支持、容易踩的雷
三、填空模板
复制下面这段,填好发给文档团队即可:
text
【产品供料表】
产品型号:
一句话定位:
应用场景:
== 核心参数(核对规格书,写实际值)==
视频输入:
视频输出:
最大分辨率/帧率:
接口(USB2.0/3.0/Type-C 等):
音频:
支持驱动:
工作温度:
功耗:
封装/尺寸:
易错项确认(USB 版本、分辨率上限是否与规格书一致):
== 快速上手 ==
接线方式:
最小使用步骤:
推荐测试软件(Win/Linux):
成功标志(附截图文件名):
== 驱动安装 ==
Windows(下载/版本/步骤/设备名):
Linux(模块或节点/加载命令/验证命令):
兼容系统:
驱动文件或链接:
== 接口/API ==
支持的接口(V4L2/DirectShow/SDK):
示例代码(贴片段或附文件名):
支持的分辨率/格式:
== 常见问题 ==
1. 问: 答:
2. 问: 答:
== 附件清单 ==
(框图、截图、驱动、代码、规格书 PDF 的文件名)