【 声明：版权所有，欢迎转载，请勿用于商业用途。 联系信箱：feixiaoxing @163.com】

        一个完整的产品，除了上位机软件、固件、硬件、包装之外，一般还需要一个用户手册。好的用户手册应该能够兼顾到大多数人的认知水平，最好能够做到简单易懂。通过简单的操作之后，就可以把产品用起来，这是最好的情况。下面，我们讨论下好的用户手册需要注意哪些方面。

1、版本控制

        用户手册和代码一样，也是需要进行版本控制的。因为在编写的过程中，肯定会涉及到文字、图和表格的修改，所以一定要注意版本的管理。中间如果客户那里发生了错误，也可以锁定当前是哪个版本的文档，是不是有必要update到最新的版本。

2、接线方法

        很多模块都是需要接线的，这里面有电源线，有信号线。特别是电源线，哪个是正极、哪个是负极，都要小心又小心。其他信号线的部分，虽然要求不需要那么严格，但是使用方法也要表达清楚。

3、关联的上位机软件

        除了厂家自身提供的上位机软件，有的时候也需要其他第三方上位机软件。通过这些上位机，也可以判断当前设备工作是不是正常，比如说windows自带的ping工具、telenet工具、ssh工具。还有就是windows自身没有的ftp工具、串口工具等等。

4、交互协议

        如果有些模块是要自己去进行二次开发的，那么这个时候就要把相关的协议描述清楚。最好能给出具体的demo例子。比如像这样，上位机应该怎么发送数据，

上位机发送-》 55 55 00 06 00 01 00 00 AA AA
0x55 0x55 报文头
0x00 0x06 剩下来的报文长度
0x00 0x01 命令号
0x00 0x00 crc (暂时没有实现)
0xaa 0xaa 报文尾巴

        然后下位机应该怎么去回数据，

下位机回复-》 55 55 00 08 00 01 01 00 00 00 AA AA
0x55 0x55 报文头
0x00 0x08 剩下来的报文长度
0x00 0x01 命令号
0x01 0x00（01代表个位数，0x00代表小数，需要除以1000，这里就是1.000v）
0x00 0x00 crc (暂时没有实现)
0xaa 0xaa 报文尾巴

5、试用

        如果要想判断自己写的文档好不好，可以先去找一个其他专业的人确认下，是不是真的用的起来。看看什么地方需要修改。设置于说，可以找一个没有相关基础的同学来进行确认和验证。越是对使用者没有要求，我们的产品才能够被更多的人使用。

6、其他

        除了上面这些内容，剩下来的就是一些截图和表哥。最最重要的是，把自己的联系方式加上，包括不限于微信、邮箱，这样出了什么问题，别人也能第一时间找到你。