用戶手冊User Guide的寫法

下面的內容僅表明我的觀點，是在工做中總結出來的，若是有錯誤之處，還請指教。

轉載請註明來自博客園---」邦邦醬好「：

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

 

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

一.  格式

下面列舉幾個在編寫文檔中須要注意的地方（博客園---」邦邦醬好「）：

　　1. 頁眉：注意增長公司的資料，若是是內部資料，能夠寫上：內部資料，保密。

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

　　3. 大小標題都要統一格式，最好使用word自帶的「樣式集「來進行編寫，避免後面重複修改的麻煩，使用小四字體。

　　4. 功能相似的部分，要統一表述方式，不要相差太多。

　　5. 正文統一使用5號字體，宋體，英文使用Times New Roman字體，行的先後行距要同樣，好比1.25倍行距，不要有些地方間距很大，有些地方又很小。

　　6. 日期的格式要一致，好比統一爲：2014-04-16或者2014.04.16或者2014年4月16日，在整個文檔中，應該只出現其中一種日期格式。

　　7. 分級描述時要使用word的編號庫，並且不一樣分級之間要注意縮進量。使用編號庫的目的在於避免這個文檔在其餘人的電腦上出現不一樣大小的縮進量，致使文檔看着混亂。

　　一級標題：標題序號爲」一‘

　　二級標題：標題序號爲「（一）」

　　三級標題：標題序號爲「1.」

　　四級標題：標題序號爲"（1）"

　　五級標題：標題序號爲「1」（圓圈裏有個1）

　　8. 分級描述時，注意統一使用分號或句號進行結尾。

　　9. 若是是注意事項，要統一加粗，加亮。

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

　　11. 功能大體相同的地方，能夠說明操做步驟同樣以及其中稍微不一樣的地方，請用戶參考某個章節使用，避免重複而累贅的說明。

　　12. 若是在某個版本軟件的功能發生了改變，應該註明：***軟件版本開始增長(或刪除)**功能/***之前的版本可能會存在**差別，如此一來，用戶就算拿着不一樣版本的軟件均可以參考此使用手冊。

 

二. 內容

下面描述用戶手冊的內容（博客園---」邦邦醬好「）

第 I 頁：

　　大大的字體寫明是本文檔是什麼軟件的用戶手冊，並註明當前文檔的版本號。

 

第 II 頁：

　　1. 修訂歷史記錄：

　　　　分別要說明如下幾項：版本號，修訂日期，修訂內容，修訂人（最好使用表格，統一表述方式）

　　2. 關於版本號：通常文檔的初始版本爲1.0，若是下次軟件有修改，須要同時在用戶手冊中增長相關的說明，那版本號依次變爲1.1,1.2,1.3.....若是軟件有重大的改變，那就將文檔版本升級爲2.0。

 

第 III 頁：

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

 

第 1 頁：

　　正文開始~

第一章：引言或簡介

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

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

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

（二）項目背景：說明項目的來源，委託單位，開發單位及主管部門。

（三）手冊的範圍：說明軟件的使用範圍，使用者範圍，軟件的版本，簡要介紹手冊各章節的內容。

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

（五）參考資料：包括項目的計劃任務書，合同或批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；測試計劃；手冊中引用的其餘資料、採用的軟件工程標準或軟件工程規範。列出這些資料的做者，標題，編號，發表日期，出版單位或資料來源。

 

第二章：軟件概述

（一）軟件說明：

　　軟件的功能描述，使用過程當中要注意的問題，包括數據的精確度（包括輸入輸出及處理數據的精度），時間特性（如響應時間，處理時間，數據傳輸時間等），靈活性（在操做方式，運行環境須要作某些變動時軟件的適應能力）。

（二）運行環境：

　　1. 硬件：軟件運行時所需的硬件最小配置，如主存容量，輸入輸出設備等。

　　2. 支持軟件：操做系統全稱及版本號，語言編譯系統的名稱及版本號，數據庫管理系統的名稱及版本號，其餘必要支持。

（三）使用說明：

　　1. 安裝及初始化：代表安裝完成的測試實例及安裝所需的軟件開發工具等等。

　　2. 運行步驟：按順序說明每種運行的步驟，應包括運行控制；操做信息（運行目的，操做要求，啓動方法，預計運行時間，操做命令格式及說明，其餘事項）；輸入輸出文件，啓動或回覆過程。

　　3. 常規過程：提供應急或很是規操做的必要信息及操做步驟，如出錯處理操做、向後備系統切換操做以及維護人員須知的操做和注意事項。

　　4. 操做命令一覽表：按字母順序逐個列出所有操做命令的格式、功能及參數說明。

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

　　6. 用戶操做舉例。

（四）軟件界面佈局　　

　　介紹軟件啓動時的界面，進入某個功能後的界面。截圖並標出各個部分的序號，並在下面簡要說明各個部分的用途。

 

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

分點，詳細地介紹軟件的各個功能，內容包括：

功能點簡述：

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

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

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

　　

　　注意作到有條理，順序地說明，不要讓用戶看得一頭霧水，原本簡簡單單的軟件若是被說得複雜難懂，這樣的用戶手冊是不過關的。