系統(tǒng)使用手冊模板

1、xxx系統(tǒng)使用手冊version : 1.0編制 : 審核 : 日期 : 2008-8-12xxx公司 研發(fā)中心文檔修訂歷史紀(jì)錄日期版本說明編制審核2008-8-121.0創(chuàng)建目錄1.目的11.1.閱讀對象11.2.如何使用本手冊11.3.相關(guān)文檔11.4.約定12.軟件概述22.1.功能和特點(diǎn)22.2.新增特色22.3.獲取技術(shù)支持33.軟件環(huán)境33.1.安裝準(zhǔn)備33.2.硬件安裝34.軟件安裝35.使用指南45.1.概述45.2.處理過程45.2.1.xxxx45.2.2.xxxx45.3.出錯處理46.附錄51. 目的說明本用戶手冊的編寫目的。示例：“用戶手冊將向用戶介紹 亞德 abc

2、軟件，并幫助用戶迅速安裝和運(yùn)行該軟件。通過本手冊，您將學(xué)會如何使用視覺控制等嶄新功能，并為您提供軟件使用中遇到的問題的解決辦法以及獲得資源與幫助的渠道?！?1.1. 閱讀對象說明本手冊的預(yù)期閱讀對象。示例：“本手冊的編寫對象為期望通過 intranet 或 internet 進(jìn)行動態(tài)數(shù)據(jù)操作的用戶。手冊中也為不太熟悉 internet 的用戶提供了基本的教程?！?1.2. 如何使用本手冊說明本手冊的閱讀方法，要求針對不同類型的用戶提供相應(yīng)的使用指導(dǎo)。示例：“您既可按順序閱讀每一章，也可根據(jù)索引中的詞條直接獲得所需的信息。下表可以指導(dǎo)您使用本手冊。如果您是請閱讀計(jì)算機(jī)新手附錄“如何使用鼠標(biāo)”亞德

3、 abc 的新用戶準(zhǔn)備安裝 亞德 abc”1.3. 相關(guān)文檔說明與本手冊使用相關(guān)的其他文檔，包括名稱、版本、與本手冊的關(guān)系等。示例：“亞德 abc 軟件提供了紙制印刷文檔（本手冊）與多種在線格式的用戶手冊。在線用戶手冊內(nèi)容更為完整和即時，如果本手冊與在線用戶手冊有區(qū)別，您應(yīng)按在線用戶手冊的說明進(jìn)行操作。您可經(jīng)常訪問 web 站點(diǎn)：www.cqhrsoft.com.cn/product/support/manual 以獲取最新的在線用戶手冊?！?1.4. 約定說明有關(guān)本手冊使用的一些約定，包括對用戶了解相關(guān)知識的約定；本手冊文字格式、圖表含義的約定；有關(guān)本軟件使用的慣用語法約定等。示例：“本手冊

4、假定您對 html，javascript 有基本的了解。” 示例：“本手冊采用的其他約定如下所示：下劃線：附錄“詞匯表索引”中包含的術(shù)語copyright 重慶xxxxx有限公司, all right reserved 本文件之著作權(quán)及商業(yè)秘密屬于重慶正大亞德科技公司，非經(jīng)公司允許不得翻印用戶使用手冊：請參閱本手冊的相關(guān)章節(jié)示例：“本手冊采用以下記號對語法進(jìn)行描述：|：可選擇的項(xiàng)用豎線 隔開； ：方括號 內(nèi)部的項(xiàng)是可選的； ：可選項(xiàng)中必須選擇一個選項(xiàng)，那么可選項(xiàng)包含在花括號中，并由豎線 | 隔開?！?2. 軟件概述2.1. 功能和特點(diǎn)概要介紹本軟件的開發(fā)目的、功能部件、主要功能、性能、安全保密

5、要求等。如果說明的內(nèi)容較多，本節(jié)應(yīng)分小節(jié)逐一介紹。示例：“歡迎您使用亞德 scanner掃描圖象和進(jìn)行圖象處理。本軟件有如下功能和特點(diǎn)：快速掃描和處理：中英文界面：批量圖象掃描：支持bmp、gif、jpg等圖象格式支持黑白、灰度、256色和真彩圖象支持任何與windows兼容的掃描儀、視頻俘獲卡、顯示卡和打印輸出設(shè)備” 2.2. 新增特色說明該版本的軟件與以前版本的軟件相比，本次版本的軟件的新增特色、改動和重要的錯誤修正。示例：“自2.0版的變化:新增特色語音輸入小改動更快速的啟動錯誤修正修正了打開多于16個窗口時發(fā)生的錯誤” 2.3. 獲取技術(shù)支持列出本軟件用戶可以獲取的技術(shù)支持方式和內(nèi)容、

6、聯(lián)系方式、用戶為獲取技術(shù)支持應(yīng)做的準(zhǔn)備工作或注意事項(xiàng)等。技術(shù)支持的內(nèi)容包括：產(chǎn)品升級、用戶注冊、使用教程與培訓(xùn)、維護(hù)、軟件錯誤反饋等。本節(jié)內(nèi)容較多時，其組織方式可以是：按內(nèi)容分小節(jié)敘述；或本節(jié)僅做概要的說明，詳細(xì)內(nèi)容作為用戶手冊的附錄或指明用戶取得詳細(xì)技術(shù)支持信息的渠道（如在線的技術(shù)支持、軟件的幫助文件等）。3. 軟件環(huán)境3.1. 安裝準(zhǔn)備說明在軟件安裝之前，對系統(tǒng)配置的要求，用戶應(yīng)當(dāng)完成的其他相關(guān)準(zhǔn)備活動。系統(tǒng)配置要求應(yīng)當(dāng)說明軟件正常運(yùn)行所需的系統(tǒng)（軟件和硬件）的最低配置，如：操作系統(tǒng)類型、版本；應(yīng)用軟件及版本；機(jī)型、內(nèi)存與外存大?。煌鈬O(shè)備；通訊設(shè)備等。建議提供本軟件運(yùn)行的最優(yōu)系統(tǒng)配置。用

7、戶須完成的相關(guān)準(zhǔn)備活動可能有：預(yù)備空白軟盤；備份工作；了解存放于本手冊之外的最新安裝信息等。示例：“安裝 cpu killer 2000前，請確認(rèn)計(jì)算機(jī)是否滿足以下最小系統(tǒng)要求：pentium 800 mhz 或以上的處理器128 mb 的內(nèi)存硬盤空間：最小安裝需600 mb，完全安裝需900 mb” 示例：“要運(yùn)行安裝程序，您需要準(zhǔn)備一張已格式化的空白3.5英寸高密度軟盤。安裝前，建議您備份計(jì)算機(jī)上的所有重要文件。另外，請您閱讀光盤上的setup.txt文件，了解安裝的最新信息?！?3.2. 硬件安裝本節(jié)提供硬件安裝的有關(guān)信息。本節(jié)內(nèi)容較多時，可以作為單獨(dú)一章，并置于軟件安裝之前。本節(jié)相關(guān)內(nèi)

8、容在文檔的其他部分如有說明，應(yīng)在本節(jié)適當(dāng)處指明。硬件安裝主要說明重要安全說明、安裝步驟和硬件技術(shù)規(guī)格。應(yīng)在必要的地方用醒目標(biāo)識提供安全警告。4. 軟件安裝說明軟件安裝的詳細(xì)步驟、與軟件安裝有關(guān)的安全和保密信息、安裝過程中可能出現(xiàn)的問題和排除方法。軟件安裝的步驟應(yīng)按照不同的安裝方式（首次安裝或升級安裝）、不同的操作環(huán)境或應(yīng)用軟件環(huán)境分別進(jìn)行敘述。安裝步驟應(yīng)當(dāng)詳細(xì)，并配合實(shí)際的安裝界面進(jìn)行描述。安全與保密信息指在安裝過程中或安裝后系統(tǒng)首次啟動時，用戶可見的安全與保密特性。如：登陸密碼說明；從何處獲得密碼；如何添加或刪除密碼等。示例：“您可以選擇以下方式安裝亞德 abc 2000：從亞德 abc 9

9、8升級到亞德 abc 2000執(zhí)行新安裝windows 3.x環(huán)境下安裝windows 95/98環(huán)境下安裝安裝選項(xiàng)” 示例：“每次啟動abc 2000時，都回出現(xiàn)對話框要求您登陸。請鍵入用戶名和密碼以登陸到系統(tǒng)。如果不知道密碼，請與系統(tǒng)管理員聯(lián)系。關(guān)于密碼的詳細(xì)信息請參閱軟件的“幫助”中“索引”選項(xiàng)中的“密碼”一條對應(yīng)的內(nèi)容?！?5. 使用指南本章為用戶提供軟件的使用指南。如果軟件功能較多，使用步驟比較復(fù)雜，本章可細(xì)分為若干章，每章的名稱對應(yīng)該章的內(nèi)容。章節(jié)的具體組織取決于軟件的特性。某些軟件可能按用戶的工作區(qū)域、任務(wù)進(jìn)行說明。對另外一些軟件來講，使用指南的組織方式可以是：第五章介紹軟件的菜

10、單，第六章介紹命令語言，第七章介紹各項(xiàng)具體功能。根據(jù)軟件的設(shè)計(jì)，章節(jié)可按工作窗口、菜單結(jié)構(gòu)、功能結(jié)構(gòu)、事務(wù)處理結(jié)構(gòu)等分類方式逐一加以介紹。安全警告標(biāo)志應(yīng)當(dāng)在相應(yīng)地方標(biāo)明。5.1. 概述本小節(jié)對本章需要介紹的內(nèi)容進(jìn)行簡要介紹，并說明軟件使用中的術(shù)語、縮略語、慣用約定等，或指明術(shù)語、縮略語、慣用約定等在本手冊的相關(guān)位置。5.2. 處理過程此處對本節(jié)內(nèi)容的組織方式（如按功能、菜單、窗口）進(jìn)行說明，同時應(yīng)說明必須按特定順序執(zhí)行的處理流程。5.2.1. xxxx本節(jié)的名稱應(yīng)當(dāng)對應(yīng)所描述的功能、菜單、或窗口等。說明的內(nèi)容包括：菜單、窗口、表格的樣式和內(nèi)容、圖標(biāo)、輸入、輸出、診斷、錯誤或警告信息、幫助的使用等。5