用戶手冊編寫指南

1、密級：內(nèi)部公開XXXX項目名稱用戶手冊編寫指南文件修訂記錄版本號變化狀態(tài)*簡要說明（變更內(nèi)容和變更范圍）變更日期變更人*變化狀態(tài)：c創(chuàng)建，A增加，M修改，D刪除文件審批信息版本號審批人角色審批意見簽字審批日期注：藍色斜體部分為注釋或舉例，實際使用時請去掉。版權(quán)聲明版權(quán)聲明是保護我們所開發(fā)軟件的產(chǎn)權(quán)、不使公司利益受到損害的一種方式。在版權(quán)聲明中應該包括以 下內(nèi)容：1. 對我們所提供的軟件及用戶手冊的保護聲明2. 對我們的軟件及商標所有權(quán)的聲明3. 對我們的用戶手冊中所提到的各種商標的版權(quán)聲明4. 我們不對用戶因為使用我們的軟件所造成的損失負責的聲明文檔目標通過閱讀該用戶手冊，用戶應該或能夠達到什

2、么目標。閱讀對象說明誰應該閱讀本手冊，或誰應該閱讀本手冊的哪些部分。關(guān)于本手冊如果本系統(tǒng)的用戶手冊（包括管理員手冊、參考手冊等 ）由多份文檔組成，則首先應該分別簡要介紹這些手冊的情況。然后分別介紹本手冊在每一章所要描述的內(nèi)容。有助于用戶閱讀和理解本手冊的相關(guān)文檔 資源，也可以在本段中特別指明。文檔約定說明文檔中字體體例，用什么字體代表什么意義。例如：黑體（粗）代表命令，黑體（常規(guī)）代表命 令參數(shù)等等。說明文檔中的符號代表何種意義。例如:縮略語和術(shù)語列出本文檔涉及的縮略語和術(shù)語，并扼要解釋。如果篇幅較大，則可以以附錄和引用文件的形式給出。如何獲得最新版本說明獲得本手冊最新版本的途徑。用戶反饋列出

3、用戶通過什么途徑，提交對產(chǎn)品手冊的意見。目錄1簡介61.1 XX系統(tǒng)描述 61.1.1 的用途 61.1.2 系統(tǒng)主要特性 61.1.3 XX 系統(tǒng)不能勝任的工作（本條可選） 61.2 安裝、運行環(huán)境 61.2.1 軟件環(huán)境 61.2.2 硬件環(huán)境 61.2.3 其它 61.3問題報告和獲得幫助 62快速指南（本章可選） 63系統(tǒng)安裝 63.1 wi ndows 2003 下安裝（用實際的操作系統(tǒng)名稱來代替標題中的操作系統(tǒng)名稱） 73.1.1 安裝前準備 73.1.2 安裝 73.1.3 安裝驗證測試（本條可選） 73.2 Solaris 下安裝（用實際的操作系統(tǒng)名稱來代替標題中的操作系統(tǒng)名稱

4、） 73.2.1 安裝前準備 73.2.2 安裝 73.2.3 正確安裝測試（本條可選） 73.3 RedHat Linux AS4 下安裝（用實際的操作系統(tǒng)名稱來代替標題中的操作系統(tǒng)名稱）.74用戶界面（本章可選） 74.1 簡介 84.2開始使用系統(tǒng) 84.3主窗口 84.4菜單 84.4.1 “文件”（File ）菜單 84.4.2 “編輯”（Edit ）菜單 84.4.3 84.4.4 “幫助”（Help）菜單 85使用 85.1用戶管理 85.1.1 用戶登錄 85.1.2 新建用戶 85.1.3 刪除用戶 85.2數(shù)據(jù)管理 86 .97常見問題解決 98附錄98.1附錄1-列表（本

5、條可選） 98.1.1 表格列表 98.1.2 插圖列表 98.1.3 示例列表 98.2附錄2-參考文檔 91. 簡介1.1 xx系統(tǒng)描述1.1.1 xx系統(tǒng)的用途描述系統(tǒng)的用途，例如用于社區(qū)信息管理，諸如此類。1.2.1 系統(tǒng)主要特性扼要描述系統(tǒng)的主要特性（features ），例如支持多少種操作系統(tǒng)、支持多少個用戶、支持同時多少 個并發(fā)等等。1.2.2 XX系統(tǒng)不能勝任的工作（本條可選）描述系統(tǒng)不具備的能力，防止用戶誤用。例如用戶可能會用一個網(wǎng)絡包分析和包生成軟件來實施路由 功能，顯然這不是應用程序設計的本意。1.2安裝、運行環(huán)境描述系統(tǒng)安裝、運行所需的環(huán)境。如果安裝和運行的環(huán)境不一致，

6、則需要單獨說明。1.2.1 軟件環(huán)境列出系統(tǒng)安裝、運行所需的操作系統(tǒng)以及其他輔助的應用程序，例如Windows2003 SQL Server，諸如此類。1.2.2 硬件環(huán)境列出系統(tǒng)安裝、運行所需的硬件環(huán)境，例如主機的數(shù)量、主機的配置（CPU內(nèi)存、硬盤、網(wǎng)卡）以及外設（打印機、掃描儀、繪圖儀），諸如此類。1.2.3 其它列出系統(tǒng)安裝、運行所需的其它要求。1.3問題報告和獲得幫助說明用戶反映系統(tǒng)問題以及獲得幫助的途徑，例如email、電話、在線幫助，諸如此類。2. 快速指南（本章可選）以一個或幾個簡單的功能為例，快速地把操作流程演示一遍，讓用戶對系統(tǒng)的界面和功能有一個直觀 的印象，減少陌生感。本段

7、篇幅應該盡量短少，幾頁就可能收到不錯的效果。描述的風格以用戶界面截屏 圖以及菜單操作為主。3. 系統(tǒng)安裝說明系統(tǒng)的安裝流程。如果系統(tǒng)的安裝前的準備工作對于不同的操作系統(tǒng)有特殊的要求，那么就應該 按不同的操作系統(tǒng)分別列出。例如：3.1.Win dows 20033.2.Solaris33RedHat Li nux AS43.1 windows 2003下安裝（用實際的操作系統(tǒng)名稱來代替標題中的操作系統(tǒng) 名稱）3.1.1 安裝前準備說明系統(tǒng)安裝之前需要進行的準備工作，例如檢查操作系統(tǒng)和應用程序的版本、硬盤的空間、用戶在 系統(tǒng)中的權(quán)限、環(huán)境變量的設置，諸如此類。3.1.2 安裝詳細說明系統(tǒng)的整個安裝

8、過程，內(nèi)容包括：編譯（本條可選）。如果系統(tǒng)是以源代碼方式提供的，則說明如何編譯成可執(zhí)行的安裝程序。安裝命令。例如菜單命令、命令行命令以及腳本命令等等。安裝過程中的交互。詳細描述每一次交互的輸入、輸出以及所導致的系統(tǒng)狀態(tài)的改變。建議用GUI交互的應同時提供截屏圖，用命令行交互的給出命令的完整輸入、輸出結(jié)果。3.1.3 安裝驗證測試（本條可選）說明安裝完成以后，執(zhí)行哪些測試操作來驗證系統(tǒng)已經(jīng)被正確安裝，詳細說明整個驗證流程和輸出結(jié) 果。3.2 Solaris下安裝（用實際的操作系統(tǒng)名稱來代替標題中的操作系統(tǒng)名稱）3.2.1安裝前準備3.2.2 安裝3.2.3 正確安裝測試（本條可選）3.3 Red

9、Hat Linux AS4下安裝（用實際的操作系統(tǒng)名稱來代替標題中的操作系統(tǒng)名稱）4. 用戶界面（本章可選）說明用戶界面上的各個菜單項的內(nèi)容和功能。對于沒有用戶界面的系統(tǒng)，例如后臺服務程序，則不需 要在本段說明。如果系統(tǒng)可以在多個操作系統(tǒng)中使用，在不同的操作系統(tǒng)中的用戶界面又不完全一致，則對不一致的 地方要單獨說明。4.1簡介簡單介紹用戶界面的特性。4.2開始使用系統(tǒng)說明系統(tǒng)的啟動方式。4.3主窗口扼要描述主窗口菜單的外觀與布局，例如工具欄、狀態(tài)欄的位置、文本編輯區(qū)的布局，諸如此類。4.4菜單詳細說明每個菜單的內(nèi)容、功能以及包含的子菜單。說明的方式可以用對一個頂層菜單完全展開的方 式來說明。最

10、好配以相應菜單的截屏圖。4.4.1“文件”（File ）菜單4.4.2“編輯”（Edit ）菜單4.4.34.4.4“幫助”（Help）菜單5. 使用vXX系統(tǒng)說明如何用本系統(tǒng)開始工作。針對每一項主要的任務（用戶管理、數(shù)據(jù)管理等等），說明其工作的流 程。如果系統(tǒng)可以在多個操作系統(tǒng)中使用，在不同的操作系統(tǒng)中的工作流程又不完全一致，則對不一致的 地方要單獨說明。5.1用戶管理8.1.1用戶登錄8.1.2新建用戶8.1.3刪除用戶5.2數(shù)據(jù)管理6. 視具體情況，添加更多的章節(jié)來說明系統(tǒng)。例如：命令參考、系 統(tǒng)數(shù)據(jù)格式說明等7. 常見問題解決列出系統(tǒng)曾經(jīng)遇到過的常見的問題以及解決方案。如下示例:問題序號問題描述解決方案1不能