【 聲明：版權所有，歡迎轉載，請勿用于商業用途。 聯系信箱：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、其他

? ? ? ? 除了上面這些內容，剩下來的就是一些截圖和表哥。最最重要的是，把自己的聯系方式加上，包括不限于微信、郵箱，這樣出了什么問題，別人也能第一時間找到你。