用戶手冊(cè)編寫模板

密級(jí)：內(nèi)部公開{項(xiàng)目名稱}用戶手冊(cè)編寫指南項(xiàng)目編號(hào)文件編號(hào)SXW_TS_UM_V5.0記錄號(hào)項(xiàng)目編號(hào)_TS_UM版本號(hào)可以是日期正文頁(yè)數(shù)附件個(gè)數(shù)（項(xiàng)目經(jīng)理）批準(zhǔn)/日期：用戶手冊(cè)編寫指南第5頁(yè)共12頁(yè)用戶手冊(cè)第1頁(yè)共12頁(yè)文件修訂記錄版本號(hào)變化狀態(tài)*簡(jiǎn)要說(shuō)明（變更內(nèi)容和變更范圍）變更日期變更人*變化狀態(tài)：C―創(chuàng)建，A—增加，M—修改，D—?jiǎng)h除文件審批信息版本號(hào)審批人角色審批意見(jiàn)簽字審批日期

注：藍(lán)色斜體部分為注釋或舉例，實(shí)際使用時(shí)請(qǐng)去掉。版權(quán)聲明[版權(quán)聲明是保護(hù)我們所開發(fā)軟件的產(chǎn)權(quán)、不使公司利益受到損害的一種方式。在版權(quán)聲明中應(yīng)該包括以下內(nèi)容：1.對(duì)我們所提供的軟件及用戶手冊(cè)的保護(hù)聲明2.對(duì)我們的軟件及商標(biāo)所有權(quán)的聲明3.對(duì)我們的用戶手冊(cè)中所提到的各種商標(biāo)的版權(quán)聲明4.我們不對(duì)用戶因?yàn)槭褂梦覀兊能浖斐傻膿p失負(fù)責(zé)的聲明]

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

目錄1簡(jiǎn)介 71.1<XX系統(tǒng)>描述 71.1.1<XX系統(tǒng)>的用途 71.1.2系統(tǒng)主要特性 71.1.3<XX系統(tǒng)>不能勝任的工作（本條可選） 71.2安裝、運(yùn)行環(huán)境 71.2.1軟件環(huán)境 71.2.2硬件環(huán)境 71.2.3其它 71.3問(wèn)題報(bào)告和獲得幫助 82快速指南（本章可選） 83系統(tǒng)安裝 83.1windows2003下安裝（用實(shí)際的操作系統(tǒng)名稱來(lái)代替標(biāo)題中的操作系統(tǒng)名稱） 83.1.1安裝前準(zhǔn)備 83.1.2安裝 83.1.3安裝驗(yàn)證測(cè)試（本條可選） 93.2Solaris下安裝（用實(shí)際的操作系統(tǒng)名稱來(lái)代替標(biāo)題中的操作系統(tǒng)名稱） 93.2.1安裝前準(zhǔn)備 93.2.2安裝 93.2.3正確安裝測(cè)試（本條可選） 93.3RedHatLinuxAS4下安裝（用實(shí)際的操作系統(tǒng)名稱來(lái)代替標(biāo)題中的操作系統(tǒng)名稱） 94用戶界面（本章可選） 94.1簡(jiǎn)介 104.2開始使用系統(tǒng) 104.3主窗口 104.4菜單 104.4.1“文件”（File）菜單 104.4.2“編輯”（Edit）菜單 104.4.3…… 104.4.4“幫助”（Help）菜單 105使用<XX系統(tǒng)> 105.1用戶管理 115.1.1用戶登錄 115.1.2新建用戶 115.1.3刪除用戶 115.2數(shù)據(jù)管理 116<視具體情況，添加更多的章節(jié)來(lái)說(shuō)明系統(tǒng)。例如：命令參考、系統(tǒng)數(shù)據(jù)格式說(shuō)明等> 117常見(jiàn)問(wèn)題解決 118附錄 118.1附錄1-列表（本條可選） 118.1.1表格列表 118.1.2插圖列表 128.1.3示例列表 128.2附錄2-參考文檔 12用戶手冊(cè)模板第11頁(yè)共11頁(yè)用戶手冊(cè)模板第6頁(yè)共12頁(yè)簡(jiǎn)介<XX系統(tǒng)>描述<XX系統(tǒng)>的用途描述系統(tǒng)的用途，例如用于社區(qū)信息管理，諸如此類。系統(tǒng)主要特性扼要描述系統(tǒng)的主要特性（features），例如支持多少種操作系統(tǒng)、支持多少個(gè)用戶、支持同時(shí)多少個(gè)并發(fā)等等。<XX系統(tǒng)>不能勝任的工作（本條可選）描述系統(tǒng)不具備的能力，防止用戶誤用。例如用戶可能會(huì)用一個(gè)網(wǎng)絡(luò)包分析和包生成軟件來(lái)實(shí)施路由功能，顯然這不是應(yīng)用程序設(shè)計(jì)的本意。安裝、運(yùn)行環(huán)境描述系統(tǒng)安裝、運(yùn)行所需的環(huán)境。如果安裝和運(yùn)行的環(huán)境不一致，則需要單獨(dú)說(shuō)明。軟件環(huán)境列出系統(tǒng)安裝、運(yùn)行所需的操作系統(tǒng)以及其他輔助的應(yīng)用程序，例如Windows2003、SQLServer，諸如此類。硬件環(huán)境列出系統(tǒng)安裝、運(yùn)行所需的硬件環(huán)境，例如主機(jī)的數(shù)量、主機(jī)的配置（CPU、內(nèi)存、硬盤、網(wǎng)卡）以及外設(shè)（打印機(jī)、掃描儀、繪圖儀），諸如此類。其它列出系統(tǒng)安裝、運(yùn)行所需的其它要求。問(wèn)題報(bào)告和獲得幫助說(shuō)明用戶反映系統(tǒng)問(wèn)題以及獲得幫助的途徑，例如email、電話、在線幫助，諸如此類?？焖僦改希ū菊驴蛇x）以一個(gè)或幾個(gè)簡(jiǎn)單的功能為例，快速地把操作流程演示一遍，讓用戶對(duì)系統(tǒng)的界面和功能有一個(gè)直觀的印象，減少陌生感。本段篇幅應(yīng)該盡量短少，幾頁(yè)就可能收到不錯(cuò)的效果。描述的風(fēng)格以用戶界面截屏圖以及菜單操作為主。系統(tǒng)安裝說(shuō)明系統(tǒng)的安裝流程。如果系統(tǒng)的安裝前的準(zhǔn)備工作對(duì)于不同的操作系統(tǒng)有特殊的要求，那么就應(yīng)該按不同的操作系統(tǒng)分別列出。例如：3.1. Windows20033.2. Solaris3.3. RedHatLinuxAS4……windows2003下安裝（用實(shí)際的操作系統(tǒng)名稱來(lái)代替標(biāo)題中的操作系統(tǒng)名稱）安裝前準(zhǔn)備說(shuō)明系統(tǒng)安裝之前需要進(jìn)行的準(zhǔn)備工作，例如檢查操作系統(tǒng)和應(yīng)用程序的版本、硬盤的空間、用戶在系統(tǒng)中的權(quán)限、環(huán)境變量的設(shè)置，諸如此類。安裝詳細(xì)說(shuō)明系統(tǒng)的整個(gè)安裝過(guò)程，內(nèi)容包括：編譯（本條可選）。如果系統(tǒng)是以源代碼方式提供的，則說(shuō)明如何編譯成可執(zhí)行的安裝程序。安裝命令。例如菜單命令、命令行命令以及腳本命令等等。安裝過(guò)程中的交互。詳細(xì)描述每一次交互的輸入、輸出以及所導(dǎo)致的系統(tǒng)狀態(tài)的改變。建議用GUI交互的應(yīng)同時(shí)提供截屏圖，用命令行交互的給出命令的完整輸入、輸出結(jié)果。安裝驗(yàn)證測(cè)試（本條可選）說(shuō)明安裝完成以后，執(zhí)行哪些測(cè)試操作來(lái)驗(yàn)證系統(tǒng)已經(jīng)被正確安裝，詳細(xì)說(shuō)明整個(gè)驗(yàn)證流程和輸出結(jié)果。Solaris下安裝（用實(shí)際的操作系統(tǒng)名稱來(lái)代替標(biāo)題中的操作系統(tǒng)名稱）安裝前準(zhǔn)備……安裝……正確安裝測(cè)試（本條可選）……RedHatLinuxAS4下安裝（用實(shí)際的操作系統(tǒng)名稱來(lái)代替標(biāo)題中的操作系統(tǒng)名稱）……用戶界面（本章可選）說(shuō)明用戶界面上的各個(gè)菜單項(xiàng)的內(nèi)容和功能。對(duì)于沒(méi)有用戶界面的系統(tǒng)，例如后臺(tái)服務(wù)程序，則不需要在本段說(shuō)明。如果系統(tǒng)可以在多個(gè)操作系統(tǒng)中使用，在不同的操作系統(tǒng)中的用戶界面又不完全一致，則對(duì)不一致的地方要單獨(dú)說(shuō)明。簡(jiǎn)介簡(jiǎn)單介紹用戶界面的特性。開始使用系統(tǒng)說(shuō)明系統(tǒng)的啟動(dòng)方式。主窗口扼要描述主窗口菜單的外觀與布局，例如工具欄、狀態(tài)欄的位置、文本編輯區(qū)的布局，諸如此類。菜單詳細(xì)說(shuō)明每個(gè)菜單的內(nèi)容、功能以及包含的子菜單。說(shuō)明的方式可以用對(duì)一個(gè)頂層菜單完全展開的方式來(lái)說(shuō)明。最好配以相應(yīng)菜單的截屏圖?！拔募保‵ile）菜單“編輯”（Edit）菜單……“幫助”（Help）菜單使用<XX系統(tǒng)>說(shuō)明如何用本系統(tǒng)開始工作。針對(duì)每一項(xiàng)主要的任務(wù)（用戶管理、數(shù)據(jù)管理等等），說(shuō)明其工作的流程。如果系統(tǒng)可以在多個(gè)操作