下面的內(nèi)容僅代表個(gè)人觀點(diǎn)，是在工作中總結(jié)出來的，如果有錯(cuò)誤之處，還請指教。

轉(zhuǎn)載請注明來自博客園---”邦邦醬好“：

http://www.cnblogs.com/bangbangjiang/p/3673382.html

用戶手冊是詳細(xì)描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。

一. 格式

下面列舉幾個(gè)在編寫文檔中需要注意的地方（博客園---”邦邦醬好“）：

　　1. 頁眉：注意增加公司的資料，如果是內(nèi)部資料，可以寫上：內(nèi)部資料，保密。

　　2. 頁腳：非正文部分使用I，II，III，IV等作為頁碼，從第一章的正文開始使用1，2，3，4.....等頁碼，頁碼號居中。

　　3. 大小標(biāo)題都要統(tǒng)一格式，最好使用word自帶的“樣式集“來進(jìn)行編寫，避免后面重復(fù)修改的麻煩，使用小四字體。

　　4. 功能類似的部分，要統(tǒng)一表述方式，不要相差太多。

　　5. 正文統(tǒng)一使用5號字體，宋體，英文使用Times New Roman字體，行的前后行距要一樣，比如1.25倍行距，不要有些地方間距很大，有些地方又很小。

　　6. 日期的格式要一致，比如統(tǒng)一為：2014-04-16或者2014.04.16或者2014年4月16日，在整個(gè)文檔中，應(yīng)該只出現(xiàn)其中一種日期格式。

　　7. 分級描述時(shí)要使用word的編號庫，而且不同分級之間要注意縮進(jìn)量。使用編號庫的目的在于避免這個(gè)文檔在其他人的電腦上出現(xiàn)不同大小的縮進(jìn)量，導(dǎo)致文檔看著混亂。

　　一級標(biāo)題：標(biāo)題序號為”一‘

　　二級標(biāo)題：標(biāo)題序號為“（一）”

　　三級標(biāo)題：標(biāo)題序號為“1.”

　　四級標(biāo)題：標(biāo)題序號為"（1）"

　　五級標(biāo)題：標(biāo)題序號為“1”（圓圈里有個(gè)1）

　　8. 分級描述時(shí)，注意統(tǒng)一使用分號或句號進(jìn)行結(jié)尾。

　　9. 如果是注意事項(xiàng)，要統(tǒng)一加粗，加亮。

　　10. 圖表編號要連續(xù)，如圖1，圖2等，表1，表2等，圖的編號要放圖的正下方，表的編號要放表的上方。

　　11. 功能大致相同的地方，可以說明操作步驟一樣以及其中稍微不同的地方，請用戶參考某個(gè)章節(jié)使用，避免重復(fù)而累贅的說明。

　　12. 如果在某個(gè)版本軟件的功能發(fā)生了改變，應(yīng)該注明：***軟件版本開始增加(或刪除)**功能/***以前的版本可能會(huì)存在**差異，如此一來，用戶就算拿著不同版本的軟件都可以參考此使用手冊。

二. 內(nèi)容

下面描述用戶手冊的內(nèi)容（博客園---”邦邦醬好“）

第 I 頁：

　　大大的字體寫明是本文檔是什么軟件的用戶手冊，并注明當(dāng)前文檔的版本號。

第 II 頁：

　　1. 修訂歷史記錄：

　　　　分別要說明以下幾項(xiàng)：版本號，修訂日期，修訂內(nèi)容，修訂人（最好使用表格，統(tǒng)一表述方式）

　　2. 關(guān)于版本號：一般文檔的初始版本為1.0，如果下次軟件有修改，需要同時(shí)在用戶手冊中增加相關(guān)的說明，那版本號依次變?yōu)?.1,1.2,1.3.....如果軟件有重大的改變，那就將文檔版本升級為2.0。

第 III 頁：

　　目錄，使用word自帶功能插入此目錄，使用超鏈接，注意每次文檔修改完畢，更新一次目錄，避免標(biāo)題內(nèi)容或者頁碼與正文的不一致。

第 1 頁：

　　正文開始~

第一章：引言或簡介

（一）編寫目的：說明編寫本手冊的目的，指明讀者對象。

如： 1.告知**軟件的使用者，**軟件所提供的功能；

　　2.如何正確地使用這些功能來完成***工作；

（二）項(xiàng)目背景：說明項(xiàng)目的來源，委托單位，開發(fā)單位及主管部門。

（三）手冊的范圍：說明軟件的使用范圍，使用者范圍，軟件的版本，簡要介紹手冊各章節(jié)的內(nèi)容。

（四）名詞定義：列舉出手冊中用到的專門術(shù)語的定義及縮寫詞的原意。

（五）參考資料：包括項(xiàng)目的計(jì)劃任務(wù)書，合同或批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說明書；概要設(shè)計(jì)說明書；詳細(xì)設(shè)計(jì)說明書；測試計(jì)劃；手冊中引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。列出這些資料的作者，標(biāo)題，編號，發(fā)表日期，出版單位或資料來源。

第二章：軟件概述

（一）軟件說明：

　　軟件的功能描述，使用過程中要注意的問題，包括數(shù)據(jù)的精確度（包括輸入輸出及處理數(shù)據(jù)的精度），時(shí)間特性（如響應(yīng)時(shí)間，處理時(shí)間，數(shù)據(jù)傳輸時(shí)間等），靈活性（在操作方式，運(yùn)行環(huán)境需要做某些變更時(shí)軟件的適應(yīng)能力）。

（二）運(yùn)行環(huán)境：

　　1. 硬件：軟件運(yùn)行時(shí)所需的硬件最小配置，如主存容量，輸入輸出設(shè)備等。

　　2. 支持軟件：操作系統(tǒng)全稱及版本號，語言編譯系統(tǒng)的名稱及版本號，數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號，其他必要支持。

（三）使用說明：

　　1. 安裝及初始化：表明安裝完成的測試實(shí)例及安裝所需的軟件開發(fā)工具等等。

　　2. 運(yùn)行步驟：按順序說明每種運(yùn)行的步驟，應(yīng)包括運(yùn)行控制；操作信息（運(yùn)行目的，操作要求，啟動(dòng)方法，預(yù)計(jì)運(yùn)行時(shí)間，操作命令格式及說明，其他事項(xiàng)）；輸入輸出文件，啟動(dòng)或回復(fù)過程。

　　3. 常規(guī)過程：提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯(cuò)處理操作、向后備系統(tǒng)切換操作以及維護(hù)人員須知的操作和注意事項(xiàng)。

　　4. 操作命令一覽表：按字母順序逐個(gè)列出全部操作命令的格式、功能及參數(shù)說明。

　　5. 程序文件(或命令文件)和數(shù)據(jù)文件一覽表：按文件名字母順序或按功能與模塊分類順序逐個(gè)列出文件名稱、標(biāo)識符及說明。

　　6. 用戶操作舉例。

（四）軟件界面布局　　

　　介紹軟件啟動(dòng)時(shí)的界面，進(jìn)入某個(gè)功能后的界面。截圖并標(biāo)出各個(gè)部分的序號，并在下面簡要說明各個(gè)部分的用途。

第三章：基本操作及功能介紹

分點(diǎn)，詳細(xì)地介紹軟件的各個(gè)功能，內(nèi)容包括：

功能點(diǎn)簡述：

　　1. 軟件截圖（要介紹的那個(gè)部分）；

　　2. 軟件使用步驟：操作步驟，輸入，輸出；

　　3. 軟件使用注意（加粗加亮表示）；

　　

　　注意做到有條理，順序地說明，不要讓用戶看得一頭霧水，本來簡簡單單的軟件如果被說得復(fù)雜難懂，這樣的用戶手冊是不過關(guān)的。

總結(jié)

以上是生活随笔為你收集整理的用户手册User Guide的写法的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。