《用戶手冊(cè)編寫規(guī)范》(20210314015246)

1、杭州東聯(lián)軟件有限公司用戶手冊(cè)編寫規(guī)則QB版本：1.0索菱有限公司用戶手冊(cè)編寫規(guī)范文件基本信息文檔主題用戶手冊(cè)編寫規(guī)則文檔編寫劉飛龍文檔審核於杰文檔批準(zhǔn)徐筱明文檔類型作業(yè)指導(dǎo)書安全狀態(tài)受控狀態(tài)首次發(fā)布2007/7/10分發(fā)對(duì)象過程改進(jìn)工作指導(dǎo)委員會(huì)和過程改進(jìn)組成員修改歷史記錄版本日期更改記錄批準(zhǔn)者更改者1. 目的12. 適用范圍13. 用戶（操作）手冊(cè)內(nèi)容13.1. 引言13.1.1. 編寫目的13.1.2. 定義13.1.3. 參考資料（可選）13.1.4. 文檔綜述（可選）13.2. 軟件概述13.2.1. 目標(biāo)13.2.2. 功能13.2.3. 性能（特色）13.3. 產(chǎn)品運(yùn)行環(huán)境13.3

2、.1. 硬件環(huán)境13.3.2. 支持軟件13.4. 產(chǎn)品安裝23.4.1. 安裝條件23.4.2. 安裝步驟23.4.3. 安裝配置方法 23.5. 使用說明23.5.1. 產(chǎn)品界面介紹23.5.2. 幫助操作說明33.5.3. 操作說明 33.6. 用戶常見問題說明（可選）33.7. 熱鍵和快捷鍵一覽表34. 用戶手冊(cè)排版規(guī)則 34.1. 封面34.2. 目錄34.3. 一級(jí)標(biāo)題34.4. 二級(jí)標(biāo)題34.5. 三級(jí)標(biāo)題34.6. 正文31. 目的通過對(duì)本公司公司 產(chǎn)品的用戶（操作）手冊(cè)編寫進(jìn)行基本規(guī)范，使用戶（操作）手冊(cè)的編寫達(dá)到標(biāo)準(zhǔn)化。2. 適用范圍適用于本公司各 類產(chǎn)品用戶（操作）手冊(cè)的

3、編寫。本標(biāo)準(zhǔn)指定可 選內(nèi)容可視產(chǎn)品的性質(zhì)進(jìn)行選擇。在產(chǎn)品用戶（手冊(cè)）的具體編寫時(shí)，可不按本標(biāo)準(zhǔn)的排列方式（順序）和相應(yīng)的目錄。3. 用戶（操作）手冊(cè)內(nèi)容3.1. 引言311編寫目的闡明編寫用戶（操作）手冊(cè)的目的，指明讀者對(duì)象。312定義列出用戶（操作）手冊(cè)中使用的專門術(shù)語(yǔ)的定義和縮寫詞的原意、適用范圍。3.1.3. 參考資料（可選）列出有關(guān)參考 資料的名稱、作者、標(biāo)題、發(fā)表日期、出版單位或資料來(lái)源。3.1.4. 文檔綜述（可選）描述文檔其余部分的內(nèi)容和 組織結(jié)構(gòu)。3.2. 軟件概述321目標(biāo)描述產(chǎn)品所能達(dá)到的目標(biāo)。322功能描述產(chǎn)品的主要功能。323性能（特色）描述產(chǎn)品的主要性能（特色）。33

4、產(chǎn)品運(yùn)行環(huán)境331硬件環(huán)境描述軟件系統(tǒng)運(yùn)行時(shí)所需的硬件最小配置。332支持軟件1）.描述操作系統(tǒng)名稱和版本號(hào)。2）.如有數(shù)據(jù)庫(kù)管理系統(tǒng)的話，描述數(shù)據(jù)庫(kù)系統(tǒng)的名稱及版本號(hào)。3）.如有其它必要的支持 軟件的話，描述其它軟件的名稱及版本號(hào)。3.4.產(chǎn)品安裝341安裝條件列出該產(chǎn)品安裝所需的 軟硬件環(huán)境和系統(tǒng)配置等前提條件和注意事 項(xiàng)。3.4.1.1. 硬件環(huán)境和配置要求說明該系統(tǒng)對(duì)硬件及其配置的要求。3.4.1.2. 軟件環(huán)境和配置要求說明系統(tǒng)對(duì)軟件運(yùn)行環(huán)境的要求，可包括：對(duì)操作系統(tǒng)、數(shù)據(jù)庫(kù)、其它所需外來(lái)軟件產(chǎn)品和配置的要求等。3.4.1.3. 安裝注意事項(xiàng)列出安裝時(shí)需特別給予注意的一些事宜，如 對(duì)

5、軟件版本的要求或 對(duì)不同平臺(tái)的不同的定制文件的要求等。342安裝步驟簡(jiǎn)要說明安裝的步 驟，各相關(guān)軟硬件安裝的順序。343安裝配置方法詳細(xì)說明所需各項(xiàng)安裝的詳細(xì)方法、步驟 和注意事項(xiàng)。3.4.3.1. 硬件環(huán)境的安裝和配置（可選）說明產(chǎn)品所需硬件 環(huán)境的安裝和配置方法及其注意事項(xiàng)。3.4.3.2. 操作系統(tǒng)的安裝和配置說明產(chǎn)品所需操作系 統(tǒng)的安裝和對(duì)網(wǎng)絡(luò)等進(jìn)行配置的方法及其注意事 項(xiàng)，如需安裝 補(bǔ)丁”也要給出安裝說 明和特別的提示。3.4.3.3. 數(shù)據(jù)庫(kù)系統(tǒng)的安裝和配置（可選）說明產(chǎn)品使用的數(shù)據(jù) 庫(kù)產(chǎn)品的安裝和 設(shè)置方法及其注意事 項(xiàng)，如需安裝 補(bǔ)丁”也要給出安裝說明和特別的 提示。3.4.3

6、.4. 其它所需軟件的安裝和配置（可選）若安裝、調(diào)試 或使用產(chǎn)品時(shí)，需要其它外來(lái)軟件產(chǎn)品的支持，應(yīng)列出其安裝配置的方法和注意事項(xiàng)。3.4.3.5. 項(xiàng)目應(yīng)用軟件的安裝和配置3.4.3.5.1. 應(yīng)用軟件的安裝詳細(xì)列出該產(chǎn)品的安裝詳細(xì)步驟和注意事項(xiàng)，包括用戶、環(huán)境、口令等等方面設(shè) 置的要求，同時(shí)應(yīng)說明備份 保護(hù)機(jī)制。3.4.3.52 應(yīng)用數(shù)據(jù)庫(kù)的創(chuàng)建（可選）詳細(xì)描述產(chǎn)品應(yīng)用數(shù)據(jù)庫(kù)的創(chuàng)建、設(shè)置和初始化的步 驟與方法，說明數(shù)據(jù)備份機(jī)制等需要注意的 問題。3.4.36調(diào)試與驗(yàn)證為了確保安裝的正確性和適用性，應(yīng)作一些相 應(yīng)的調(diào)試和驗(yàn)證，應(yīng)給出相應(yīng)的調(diào)試與驗(yàn)證的方法和要求3.5. 使用說明3.5.1. 產(chǎn)

7、品界面介紹詳細(xì)對(duì)產(chǎn)品界面進(jìn)行描述，包括功能菜單、工具條、指令圖標(biāo)等。3.5.2. 幫助操作說明詳細(xì)描述產(chǎn)品的在線幫助的使用方法。3.5.3. 操作說明1）.詳細(xì)描述產(chǎn)品各功能的操作方法；2）.詳細(xì)描述產(chǎn)品所產(chǎn)生文件的保存方式（格式）；3）.詳細(xì)描述產(chǎn)品與第三方同類產(chǎn)品的數(shù)據(jù)交換方式。3.6. 用戶常見問題說明（可選）詳細(xì)描述對(duì)用戶常見問題（由于用戶操作經(jīng)驗(yàn)和操作方法而引起的）的 處理方法。3.7. 熱鍵和快捷鍵一覽表按字母順序或按功能逐個(gè)列出 熱鍵和快捷鍵的名稱和功能 說明。4. 用戶手冊(cè)排版規(guī)則4.1. 封面1）產(chǎn)品名稱：X系統(tǒng)。字體為黑體、小初；2）公司名稱：杭州浙大大天信息有限公司。字體為黑體、三號(hào)；3）出版日期：xxxx年 %月。字體為黑體、小四號(hào)；4.2. 目錄1）目錄，字體為黑體、三號(hào)；2）目錄列表：字體為宋體，五號(hào)。4.3. 一級(jí)標(biāo)題第一章”字體為宋體、小一、灰色5%底紋、加粗。4.4. 二級(jí)標(biāo)題第一節(jié)”字體為宋體、小一、灰色5%底紋、加粗。4.5. 三級(jí)標(biāo)題“1.1.1” ：字體為宋體、三號(hào)、加粗。4.6. 正文1）提示文字：操作系統(tǒng)。字體為宋體、小四、加粗。2）所有文字行距1.5倍行距。3）段首縮進(jìn)：2個(gè)字符。4）本節(jié)要點(diǎn)： 本節(jié)要點(diǎn)”字體為黑體、小四。小四。5）要點(diǎn)