信息技術(shù)有限公司用戶手冊(cè)編制規(guī)范(1)

1、第1章 關(guān)于標(biāo)題及編號(hào)的規(guī)定用戶手冊(cè)編制規(guī)范中科海鑫信息技術(shù)有限公司2004.21-6第1章 用戶手冊(cè)格式的統(tǒng)一規(guī)定版權(quán)聲明用戶手冊(cè)編制規(guī)范的版權(quán)歸中科海鑫信息技術(shù)有限公司所有。未經(jīng)中科海鑫信息技術(shù)有限公司的書面準(zhǔn)許，不得將本規(guī)范的任何部分以任何形式、采用任何手段(電子的或機(jī)械的，包括照相復(fù)制或錄制)、或?yàn)槿魏文康?，進(jìn)行復(fù)制或擴(kuò)散。(c)Copyright 2000 中科海鑫信息技術(shù)有限公司。版權(quán)所有，翻制必究。 是中科海鑫信息技術(shù)有限公司的注冊(cè)商標(biāo)。Microsoft、word是Microsoft Corporation的注冊(cè)商標(biāo)。Windows是Microsoft Corporation的

2、商標(biāo)。1-10前 言用戶手冊(cè)對(duì)于任何產(chǎn)品都是不可缺少的組成部分。一個(gè)好的產(chǎn)品沒有一份完備的用戶手冊(cè)，也不能算作一個(gè)完備的產(chǎn)品。對(duì)于軟件產(chǎn)品來說更是如此，沒有用戶手冊(cè)的軟件不能算產(chǎn)品，沒有好的用戶手冊(cè)，就不可能算好產(chǎn)品。也就是說，一個(gè)好的軟件產(chǎn)品除了具備與市場(chǎng)對(duì)路的思想、良好的用戶界面、完備的測(cè)試之外，還必須有一本適合用戶使用的用戶手冊(cè)。本規(guī)范手冊(cè)不僅指明了軟件用戶手冊(cè)的內(nèi)容，而且規(guī)定了中科海鑫信息技術(shù)有限公司軟件用戶手冊(cè)的統(tǒng)一版面、格式。本規(guī)范手冊(cè)就是按本規(guī)定編寫的，但由于本規(guī)范手冊(cè)內(nèi)容的局限性，很難以樣本的形式表現(xiàn)軟件用戶手冊(cè)中可能出現(xiàn)的各種情況，所以請(qǐng)大家認(rèn)真閱讀本規(guī)范手冊(cè)的內(nèi)容。我們希望

3、中科海鑫信息技術(shù)有限公司的相關(guān)人員，能夠按照本規(guī)范手冊(cè)編寫自己的軟件用戶手冊(cè)，做好我們的軟件產(chǎn)品化工作。由于時(shí)間倉促，編者水平有限，希望大家能夠提出寶貴意見，以逐步完善本規(guī)范手冊(cè)的內(nèi)容。i閱讀指南手冊(cè)目標(biāo)本手冊(cè)主要對(duì)中科海鑫信息技術(shù)有限公司軟件產(chǎn)品的用戶手冊(cè)所應(yīng)包含的內(nèi)容及版面格式作一個(gè)初步的統(tǒng)一規(guī)定。由于實(shí)際情況千變?nèi)f化，本規(guī)定很難一次做到面面俱到，需要逐漸完善。閱讀對(duì)象本手冊(cè)是為中科海鑫信息技術(shù)有限公司的所有軟件開發(fā)人員和軟件用戶手冊(cè)編寫人員所編寫的。由于本手冊(cè)中的格式規(guī)定部分是根據(jù) Microsoft Windows 下的 Word 的功能而編寫的，所以中科海鑫信息技術(shù)有限公司的軟件用戶

4、手冊(cè)應(yīng)該使用 MicroSoft Word排版。手冊(cè)構(gòu)成本手冊(cè)基本上由兩部分組成：1. 第1章，“關(guān)于用戶手冊(cè)排版格式的規(guī)定”，規(guī)定了用戶手冊(cè)標(biāo)題及編號(hào)的格式。2. 第2章，“用戶手冊(cè)的內(nèi)容”，規(guī)定了用戶手冊(cè)所應(yīng)包含內(nèi)容較為詳細(xì)的清單。另外，本手冊(cè)基本上是按“用戶手冊(cè)格式的統(tǒng)一規(guī)定”編寫的一個(gè)樣本。手冊(cè)約定本手冊(cè)遵循以下約定：1. 所有標(biāo)題均使用黑體字。2. 如果標(biāo)題后跟有“條件”字樣，說明該標(biāo)題下正文所要求的內(nèi)容是在一定條件下必須的?！咀⒁狻康囊馑际钦?qǐng)讀者注意那些需要注意的事項(xiàng)?！揪妗康囊馑际钦?qǐng)讀者千萬注意某些事項(xiàng)，否則將造成嚴(yán)重錯(cuò)誤。i目 錄第1章 用戶手冊(cè)格式規(guī)定1-1§1.

5、1 標(biāo)題及編號(hào)1-1§1.1.1 章標(biāo)題的設(shè)置1-1§1.1.2 節(jié)標(biāo)題的設(shè)置1-1§1.1.3 小節(jié)標(biāo)題的設(shè)置1-1§1.1.4項(xiàng)目符號(hào)和編號(hào)的設(shè)置1-2§1.1.5 其它編號(hào)的設(shè)置1-3§1.2 正文及頁眉頁腳的排版1-4§1.2.1 正文排版1-5§1.2.2 版面設(shè)置1-5§1.2.2.1 版面設(shè)置1-5§1.2.2.2 關(guān)于頁眉、頁腳的設(shè)置1-5§1.2.2.3 注意與警告1-5第2章 用戶手冊(cè)的內(nèi)容2-1§2.1 用戶手冊(cè)的目標(biāo)2-4§2.2 用戶手冊(cè)的

6、內(nèi)容2-4§2.2.1 封面2-4§2.2.2 二封2-4§2.2.3 版權(quán)聲明2-4§2.2.4 前言2-4§2.2.5 閱讀指南2-5§2.2.6目錄2-5§2.2.7基礎(chǔ)知識(shí)介紹條件2-5§2.2.8 系統(tǒng)安裝及啟動(dòng)2-6§2.2.9 系統(tǒng)操作說明2-7§2.2.9 1 CAD軟件2-7§2.2.9 2 其它軟件2-9§2.2.10 系統(tǒng)及數(shù)據(jù)維護(hù)2-9§2.2.11 例題條件2-10§2.2.12 各種附錄2-10§2.3 用戶手冊(cè)的風(fēng)格

7、2-11第1章 用戶手冊(cè)格式的規(guī)定第1章 用戶手冊(cè)格式的規(guī)定§1.1 標(biāo)題及編號(hào)一般情況下，用戶手冊(cè)用章、節(jié)來劃分其內(nèi)容，必要時(shí)還可引入小節(jié)、小小節(jié)的概念。§1.1.1 章標(biāo)題的設(shè)置每章的編號(hào)用阿拉伯?dāng)?shù)字表示，采用“第1章”、“第2章”、的形式表示章的編號(hào)，章的編號(hào)后面空一個(gè)半角的格，然后是這一章的標(biāo)題。1. 章必須另起一頁開始打印。2. 章的編號(hào)和標(biāo)題采用左對(duì)齊的格式放在行的左邊，左縮進(jìn)為0。3. 章的編號(hào)和標(biāo)題中漢字采用黑體小三號(hào)字，章的編號(hào)和標(biāo)題總長(zhǎng)度不能超過一行。4. 章的編號(hào)和標(biāo)題行距取最小值、12磅，段前、段后分別取24磅。§1.1.2 節(jié)標(biāo)題的設(shè)置節(jié)

8、的編號(hào)格式為“§x.y”。其中，x為章的號(hào)碼，y為節(jié)的號(hào)碼，用阿拉伯?dāng)?shù)字表示。節(jié)的編號(hào)后面空一個(gè)半角的格，然后是這一節(jié)的標(biāo)題。1. 原則上每一節(jié)另起一頁開始打印，但對(duì)于每章的第一節(jié)，如果章標(biāo)題下無說明文字，可以將其與章標(biāo)題放于一頁之中。2. 節(jié)的編號(hào)和標(biāo)題采用左對(duì)齊的格式放在行的左邊，左縮進(jìn)為0。3. 節(jié)的編號(hào)和標(biāo)題中漢字采用黑體四號(hào)字，節(jié)的編號(hào)和標(biāo)題總長(zhǎng)度不能超過一行。4. 節(jié)的編號(hào)和標(biāo)題行距取最小值、12磅，對(duì)于與章標(biāo)題處于同頁的要將其段前、段后均取12磅，否則段前取24磅、段后取12磅。§1.1.3 小節(jié)標(biāo)題的設(shè)置小節(jié)的編號(hào)格式為“§x.y.z”。其中x為章

9、的號(hào)碼，y為節(jié)的號(hào)碼，z為小節(jié)號(hào)碼，用阿拉伯?dāng)?shù)字表示。小節(jié)的編號(hào)后面空一個(gè)半角的格，然后是這一小節(jié)的標(biāo)題。1. 小節(jié)不必另起一頁開始打印。2. 小節(jié)的編號(hào)和標(biāo)題采用左對(duì)齊的格式放在行的左邊，左縮進(jìn)0.74CM。3. 小節(jié)的編號(hào)和標(biāo)題中漢字采用黑體小四號(hào)字，小節(jié)的編號(hào)和標(biāo)題總長(zhǎng)度不能超過一行。4. 小節(jié)的編號(hào)和標(biāo)題行距取最小值、12磅，段前取12磅?！咀⒁狻?. 如果有必要，還可以在小節(jié)下面劃分更小的節(jié)，我們暫且稱之為小小節(jié)。2. 對(duì)于小小節(jié)的各種規(guī)定與小節(jié)一致，為保持版面清晰，小小節(jié)不再相對(duì)于小節(jié)向右縮進(jìn)。3. 在用戶手冊(cè)中，系統(tǒng)提示信息采用幼圓五號(hào)字，其余所有的數(shù)字及字母采用Arial字體，

10、字號(hào)與相應(yīng)的漢字相同。在本規(guī)范中提到的字體如無特殊注明，均指漢字字體。4. 用戶手冊(cè)中，行距均取最小值、12磅。§1.1.4 項(xiàng)目符號(hào)和編號(hào)的設(shè)置在章、節(jié)、小節(jié)、小小節(jié)里面均可以含有項(xiàng)目符號(hào)和編號(hào)。1. 編號(hào)1) 編號(hào)序列相對(duì)于與之對(duì)應(yīng)的標(biāo)題向右縮進(jìn)0.74CM。2) 編號(hào)的格式是“n.”，其中n為阿拉伯?dāng)?shù)字。3) 對(duì)于有名編號(hào)序列名稱采用五號(hào)黑體漢字，其后面的內(nèi)容采用五號(hào)宋體漢字；對(duì)于無名編號(hào)序列中的內(nèi)容字體同有名編號(hào)序列。4) 編號(hào)序列里還允許采用二級(jí)編號(hào)序列，其格式規(guī)定如下：“n)”，其中n為阿拉伯?dāng)?shù)字。5) 二級(jí)編號(hào)相對(duì)于與之對(duì)應(yīng)的一級(jí)編號(hào)向右縮進(jìn)0.74CM。6) 其它規(guī)定

11、和一級(jí)編號(hào)序列一致。7) 編號(hào)及二級(jí)編號(hào)的行間距取最小值，12磅。一級(jí)編號(hào)的第一項(xiàng)段前取12磅，其余各項(xiàng)及二級(jí)編號(hào)段前均取6磅。2. 項(xiàng)目符號(hào)1) 項(xiàng)目符號(hào)相對(duì)于與之對(duì)應(yīng)的標(biāo)題或編號(hào)序列向右縮進(jìn)0.74CM。2) 項(xiàng)目符號(hào)的格式是“”，其中“”字體為Wingdings，五號(hào)字。3) 對(duì)于有名項(xiàng)目符號(hào)序列，名稱采用五號(hào)黑體漢字，其后面的正文采用宋體五號(hào)字，對(duì)于無名項(xiàng)目符號(hào)序列中的內(nèi)容字體同有名編號(hào)序列。4) 如果項(xiàng)目符號(hào)序列處于編號(hào)序列的下級(jí)，則各項(xiàng)各項(xiàng)段前均取6磅；否則首項(xiàng)段前取12磅，其余各項(xiàng)段前取6磅?！咀⒁狻宽?xiàng)目符號(hào)和編號(hào)下的敘述文字相對(duì)于與之對(duì)應(yīng)的項(xiàng)目符號(hào)或編號(hào)向右縮進(jìn)0.74CM，首

12、行縮進(jìn)0.74CM，段前取6磅。漢字字體取宋體五號(hào)。§1.1.5 其它編號(hào)的設(shè)置1. 頁編號(hào)：用戶手冊(cè)中的正文按章進(jìn)行編號(hào)，其格式為“章-頁”。如，第2章的第3頁，編號(hào)為“2-3”。頁編號(hào)放在頁腳中，具體設(shè)置方法詳見“頁眉、頁腳設(shè)置”。2. 圖、表編號(hào)：用戶手冊(cè)中的圖、表均按章分別進(jìn)行編號(hào)，其格式分別為“圖x-y”、“表x-y”。如，第2章的第3幅圖的編號(hào)是“圖2-3”；第2章的第3張表格的編號(hào)是“表2-3”。在圖表編號(hào)的后面空一個(gè)半角的格，然后是這一圖表的名稱。另外，還規(guī)定：1) 表的編號(hào)與名稱放在表的頂部。2) 表的編號(hào)與名稱和表左對(duì)齊，而整個(gè)表則居中放置。3) 表的編號(hào)與名稱段

13、后取6磅。4) 圖的編號(hào)與名稱放在圖的底部。5) 圖的編號(hào)與名稱和圖均居中放置。6) 圖的編號(hào)與名稱段前取6磅。7) 圖前面的正文段后取12磅。8) 圖、表的編號(hào)與名稱中漢字采用黑體五號(hào)字。§1.2 正文及頁眉、頁腳的排版§1.2.1 正文排版正文排版包括字符排版、段落排版、圖形排版和版權(quán)聲明、目錄等的排版，本節(jié)就這幾方面的格式要求加以詳細(xì)闡述。1. 字符排版：1) 用戶手冊(cè)的正文，系統(tǒng)提示采用幼圓五號(hào)字體，其余采用宋體五號(hào)字。2) 對(duì)于界面中的按鈕名稱，應(yīng)把按鈕名稱用“”括起來，按鈕名稱用黑體五號(hào)字書寫。對(duì)于下拉菜單選項(xiàng)的名稱，應(yīng)用“”引起來，選項(xiàng)名稱用宋體五號(hào)字書寫。對(duì)

14、于熱點(diǎn)，應(yīng)用“”引起來，熱點(diǎn)名稱用黑體五號(hào)字書寫。3) 正文均采用常規(guī)字體、標(biāo)準(zhǔn)位置、標(biāo)準(zhǔn)間距。2. 段落排版：1) 正文段落的首行相對(duì)于與之對(duì)應(yīng)的標(biāo)題或編號(hào)序列向右縮進(jìn)0.74CM。2) 行距采用最小值，12磅，除項(xiàng)目符號(hào)及編號(hào)以及圖形前面正文按前面所述的特殊要求進(jìn)行排版外，其余段前均取12磅。3) 采取兩端對(duì)齊方式。3. 圖形的排版：1) 屏幕截圖時(shí)，應(yīng)使所截圖片的尺寸為最大。2) 對(duì)于尺寸較大的圖片，可使圖片的高度和寬度按同比例適當(dāng)縮小。3) 必要時(shí)可適當(dāng)縮小或?qū)D片移到下一頁，以保證圖片與圖號(hào)及圖名在同頁。4) 當(dāng)正文中對(duì)圖標(biāo)進(jìn)行說明時(shí)，應(yīng)使圖標(biāo)同與之對(duì)應(yīng)的標(biāo)題對(duì)齊。5) 為保證頁面清

15、晰，可適當(dāng)調(diào)整圖標(biāo)右側(cè)說明文字的行間距以及段前、段后。6) 在屏幕截圖時(shí)，圖片中輸入的數(shù)據(jù)不能包含本公司員工的真實(shí)姓名。4. 版權(quán)聲明、目錄等的排版：版權(quán)聲明、前言、閱讀指南、目錄的標(biāo)題為段前取36磅，段后取24磅，采用黑體小三號(hào)字；內(nèi)容排版與手冊(cè)正文排版相同。§1.2.2 版面設(shè)置§1.2.2.1 版面設(shè)置對(duì)于版面設(shè)置作如下規(guī)定：1. 紙張大小：用戶手冊(cè)用紙統(tǒng)一規(guī)定為16開。2. 頁邊距：上：30mm；下：20mm；內(nèi)側(cè)：21mm；外側(cè)：16mm。另外采用“對(duì)稱頁邊距”；對(duì)于版面設(shè)置頁眉、頁腳應(yīng)選用“首頁不同”和“奇偶頁不同”。3. 對(duì)于新項(xiàng)目或新產(chǎn)品可根據(jù)具體情況對(duì)版面

16、設(shè)置適當(dāng)做一些修改。§1.2.2.2 關(guān)于頁眉、頁腳的設(shè)置1. 頁眉的設(shè)置：1) 版權(quán)聲明、前言、閱讀指南、目錄均無篇眉。2) 章編號(hào)和名稱所在頁的篇眉為一行有50%填充的邊框。3) 對(duì)于單號(hào)頁，頁眉的內(nèi)容是當(dāng)前章的標(biāo)題名，要求打印在紙的右上角。4) 對(duì)于雙號(hào)頁，頁眉的內(nèi)容是用戶手冊(cè)的名稱，要求打印在紙的左上角。5) 紙的頂邊與頁眉的距離是23mm。6) 頁眉中漢字采用幼圓小五號(hào)字。2. 頁腳的設(shè)置：1) 頁腳的內(nèi)容是當(dāng)前頁的頁編號(hào)，如第2章第2頁為2-2。2) 頁編號(hào)的字體采用Arial五號(hào)字。3) 紙的底邊與頁腳的距離是13mm。4) 版權(quán)聲明、前言、閱讀指南、目錄的頁腳為，等，

17、居中放置，不帶邊框。§1.2.2.3 注意與警告在用戶手冊(cè)中，對(duì)于那些需要用戶特別注意的事項(xiàng)，應(yīng)該用“【注意】”作為標(biāo)志給用戶以特別的提示。關(guān)于注意標(biāo)志和注意事項(xiàng)的格式有如下規(guī)定：1. 注意標(biāo)志同與之對(duì)應(yīng)的標(biāo)題對(duì)齊。2. 注意標(biāo)志采用黑體小四號(hào)漢字。3. 注意標(biāo)志段前取12磅。4. 如果注意事項(xiàng)只有一條，其內(nèi)容應(yīng)該緊跟在注意標(biāo)志的后面書寫；否則，應(yīng)該在注意標(biāo)志的下一行開始，采用編號(hào)序列的形式分別給出。在用戶手冊(cè)中，對(duì)于那些會(huì)給用戶造成重大損失的行為，應(yīng)該用“【警告】”作為標(biāo)志給用戶以警告性的提示?！咀⒁狻筷P(guān)于警告標(biāo)志和警告事項(xiàng)的格式規(guī)定與關(guān)于注意標(biāo)志和注意事項(xiàng)的格式規(guī)定一致。1-5第

18、2章 用戶手冊(cè)的內(nèi)容本章主要討論編寫用戶手冊(cè)所要達(dá)到的目標(biāo)、軟件用戶手冊(cè)所應(yīng)包含的內(nèi)容、以及在用戶手冊(cè)編寫過程中所應(yīng)保持的風(fēng)格。如果標(biāo)有“條件”字樣，說明該部分內(nèi)容是在一定條件下所必須的。§2.1 用戶手冊(cè)的目標(biāo)某軟件評(píng)測(cè)中心把軟件產(chǎn)品評(píng)測(cè)測(cè)試分為兩個(gè)階段初評(píng)安裝測(cè)試和復(fù)評(píng)測(cè)試。只有通過初評(píng)安裝測(cè)試的軟件才能進(jìn)入復(fù)評(píng)測(cè)試，初評(píng)安裝測(cè)試的內(nèi)容包括：1. 按照軟件用戶手冊(cè)中的安裝說明測(cè)試軟件能否順利安裝成功。2. 對(duì)照軟件用戶手冊(cè)測(cè)試軟件功能是否與手冊(cè)描述一致。3. 評(píng)價(jià)產(chǎn)品包裝及用戶手冊(cè)是否符合商品化要求。4. 通過以上三方面測(cè)試且無嚴(yán)重死機(jī)情況的軟件可進(jìn)入復(fù)評(píng)測(cè)試。由此，我們可以看到

19、軟件用戶手冊(cè)是一個(gè)軟件產(chǎn)品的基礎(chǔ)，沒有合格的軟件用戶手冊(cè)就根本談不上合格的軟件產(chǎn)品。另一方面，良好的安裝說明及軟件功能與手冊(cè)描述的一致性是對(duì)軟件用戶手冊(cè)的兩個(gè)基本要求。我們編寫的用戶手冊(cè)要達(dá)到兩個(gè)目的：1. 讓用戶手冊(cè)成為用戶學(xué)習(xí)使用我們產(chǎn)品的最好教材。用戶通過閱讀用戶手冊(cè)，應(yīng)該對(duì)我們產(chǎn)品的功能、操作有一定的認(rèn)識(shí)；按照用戶手冊(cè)上的說明，通過實(shí)際操作，用戶應(yīng)該能夠掌握我們產(chǎn)品的操作過程。2. 讓用戶手冊(cè)能夠起到降低銷售費(fèi)用的作用。用戶手冊(cè)不僅應(yīng)該包括我們的產(chǎn)品操作說明，而且還應(yīng)該包括系統(tǒng)（軟件和必要的硬件）安裝、數(shù)據(jù)維護(hù)、出錯(cuò)處理等。通過用戶手冊(cè)，就可以讓用戶掌握在使用我們軟件的過程中出現(xiàn)各種情

20、況的處理方法。為達(dá)到這兩個(gè)目標(biāo)，在一般情況下，用戶手冊(cè)應(yīng)該包含如下幾個(gè)方面的內(nèi)容：1. 封面2. 二封3. 版權(quán)4. 聲明5. 前言6. 閱讀指南7. 目錄8. 基礎(chǔ)知識(shí)介紹條件9. 系統(tǒng)安裝(包括必要的硬件安裝)及啟動(dòng)10. 系統(tǒng)操作說明11. 系統(tǒng)及數(shù)據(jù)維護(hù)12. 例題條件13. 各種附錄【注意】如果本系統(tǒng)軟件是一個(gè)大系統(tǒng)，其系統(tǒng)安裝、操作說明、系統(tǒng)及數(shù)據(jù)維護(hù)都相當(dāng)復(fù)雜，則可以把這三個(gè)部分分別編寫為一本甚至幾本用戶手冊(cè)，每本手冊(cè)都有自己的封面、版權(quán)聲明、前言、閱讀指南、目錄以及相應(yīng)的基礎(chǔ)知識(shí)介紹和附錄。§2.2 用戶手冊(cè)的內(nèi)容§2.2.1 封面封面內(nèi)容應(yīng)包括公司的ICO

21、N、軟件名稱及版本號(hào)、公司名稱及手冊(cè)印刷時(shí)間。§2.2.2 二封二封正面為軟件名稱及版本號(hào)、公司名稱、手冊(cè)印刷時(shí)間、公司地址及服務(wù)電話等。以EDD4.0手冊(cè)為例，其形式如下：EDD/AutoCAD R14 V4.0用戶手冊(cè) 中科海鑫信息技術(shù)有限公司地址：沈陽市和平區(qū)三好街84-2號(hào)電話：(024)23841748 (024)23783000傳真：(024)23890817 (024)23782266客戶服務(wù)熱線：800-890-8000Email：Serviceneu-§2.2.3 版權(quán)聲明版權(quán)聲明是保護(hù)我們所開發(fā)軟件的產(chǎn)權(quán)、不使我們公司利益受到損害的一種方式。在版權(quán)聲明中

22、應(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é)的聲明。具體請(qǐng)參考本規(guī)范的版權(quán)聲明。§2.2.4 前言對(duì)于前言所應(yīng)包含的內(nèi)容經(jīng)常根據(jù)用戶手冊(cè)編寫人員的習(xí)慣不同而不同，有時(shí)僅僅包含了系統(tǒng)的開發(fā)背景和目的，有時(shí)還包含了系統(tǒng)簡(jiǎn)介，有時(shí)甚至還包含了用戶手冊(cè)的閱讀指南。為了統(tǒng)一起見，在這里我們規(guī)定前言主要包括以下內(nèi)容：1. 系統(tǒng)的開發(fā)背景和目的。2. 系統(tǒng)所能應(yīng)用的領(lǐng)域和使用對(duì)象。3. 系統(tǒng)的功能及特性簡(jiǎn)介。4. 如果本手冊(cè)不是該系

23、統(tǒng)的第一個(gè)版本，還應(yīng)該簡(jiǎn)介較上一版本的改進(jìn)部分。§2.2.5 閱讀指南閱讀指南是每本(套)用戶手冊(cè)必不可少的組成部分，用戶通過它可以了解到用戶手冊(cè)的基本內(nèi)容；了解到應(yīng)該如何、從哪兒開始閱讀該用戶手冊(cè)。用戶手冊(cè)的閱讀指南應(yīng)該包含如下幾部分：1. 手冊(cè)目標(biāo)：通過閱讀該用戶手冊(cè)，用戶應(yīng)該或能夠達(dá)到什么目標(biāo)。2. 閱讀對(duì)象：指明什么人員應(yīng)該閱讀該手冊(cè)，或什么人員應(yīng)該閱讀本手冊(cè)的哪些部分；閱讀對(duì)象在閱讀本手冊(cè)之前應(yīng)該掌握哪些知識(shí)，必要時(shí)應(yīng)給出資料清單，以便用戶查閱。3. 手冊(cè)構(gòu)成：如果本系統(tǒng)的用戶手冊(cè)(包括管理員手冊(cè)、參考手冊(cè))由幾本組成，首先應(yīng)該分別簡(jiǎn)要介紹這些手冊(cè)的情況。最根本的是應(yīng)該介紹

24、本手冊(cè)在哪一章或哪幾章講解了什么內(nèi)容，對(duì)于較大系統(tǒng)，如Universal Office 3.5，分別介紹每一章內(nèi)容比較繁瑣，則可概括性地介紹。4. 手冊(cè)約定：這一部分應(yīng)該包括字體的約定、特殊符號(hào)的約定以及【注意】、【警告】、【說明】等的含義。必要時(shí)，應(yīng)該給出某些基本術(shù)語的定義。也可以把基本術(shù)語、概念的定義作為基礎(chǔ)知識(shí)來介紹。具體請(qǐng)參考本規(guī)范的閱讀指南。§2.2.6 目錄目錄的編寫要盡量詳盡。如果用戶手冊(cè)的內(nèi)容用到小節(jié)，則目錄就應(yīng)該編寫到小節(jié)；如果用戶手冊(cè)的內(nèi)容用到小小節(jié)，則目錄就應(yīng)該編寫到小小節(jié)。編寫用戶手冊(cè)目錄的目的就是為了讓用戶能夠根據(jù)它很快地找到想要的內(nèi)容。有關(guān)格式請(qǐng)參考本規(guī)范

25、目錄的編寫。§2.2.7 基礎(chǔ)知識(shí)介紹條件這一部分內(nèi)容是在一定條件下必需的，用戶手冊(cè)編寫人員應(yīng)該根據(jù)實(shí)際情況確定是否需要這一部分。如果包括基礎(chǔ)知識(shí)介紹，應(yīng)將其放在第1章。在一般情況下，使用我們的軟件系統(tǒng)需要一定的基礎(chǔ)知識(shí)。這些知識(shí)可以從有關(guān)書籍上得到，但是用戶從這些資料得到這些知識(shí)需要花費(fèi)相當(dāng)?shù)臅r(shí)間。在某些情況下，我們只需要用戶掌握用戶手冊(cè)中使用的那些概念，那么我們就有必要編寫一章“基礎(chǔ)知識(shí)介紹”來進(jìn)行專門介紹。比如說，在工廠管道設(shè)計(jì)系統(tǒng)用戶手冊(cè)中，經(jīng)常用到按下鼠標(biāo)“數(shù)據(jù)鍵”、“捕捉鍵”、“復(fù)位鍵”的概念，用戶雖然可以從Microstation的用戶手冊(cè)中得到這些概念，但是比較不方便

26、。由于我們編寫用戶手冊(cè)的主要目標(biāo)就是方便用戶，所以有必要在用戶手冊(cè)的一開始就介紹這些概念。§2.2.8 系統(tǒng)安裝及啟動(dòng)如果手冊(cè)中包括基礎(chǔ)知識(shí)介紹，應(yīng)把系統(tǒng)安裝及啟動(dòng)作為第2章，否則，將其作為第1章首先向讀者予以介紹。系統(tǒng)安裝及啟動(dòng)部分應(yīng)該包括如下內(nèi)容：1. 系統(tǒng)的運(yùn)行環(huán)境 硬件環(huán)境要求說明：系統(tǒng)運(yùn)行時(shí)所需硬件環(huán)境描述。包括機(jī)型、內(nèi)存大小、硬盤空間等。如果必要，還應(yīng)包括輸入/輸出設(shè)備、通訊環(huán)境等。 軟件環(huán)境要求說明：系統(tǒng)運(yùn)行時(shí)所需軟件支持環(huán)境的描述。包括所需任何其它軟件的名稱及版本號(hào)等。 其它環(huán)境要求說明條件：應(yīng)該說明要求的任何其它環(huán)境。2. 系統(tǒng)的安裝對(duì)于不同的系統(tǒng)其安裝應(yīng)有所區(qū)別，

27、一般來說，應(yīng)給出最終用戶能夠據(jù)此把軟件安裝到其操作系統(tǒng)并配置完成，且能成功運(yùn)行的任何信息和操作。系統(tǒng)的安裝包括軟件的安裝過程及系統(tǒng)環(huán)境的配置條件，必要時(shí)還應(yīng)給出硬件的安裝條件。 硬件安裝條件：如果必要，應(yīng)該詳細(xì)說明系統(tǒng)所需硬件環(huán)境的安裝過程，其中包括軟件加密鎖的安裝。 軟件安裝：應(yīng)該用圖示方法詳細(xì)介紹軟件的安裝過程。對(duì)于網(wǎng)絡(luò)版軟件，應(yīng)對(duì)服務(wù)器端及客戶端的安裝分別予以介紹（可參考文檔管理系統(tǒng)SEAS2000-AMS 5.0）。如果二者安裝過程相似，可以詳細(xì)介紹一種，另一種參考前一種即可。如果軟件由多個(gè)模塊構(gòu)成，且其中部分模塊需單獨(dú)安裝，如Universal Office 3.5，則應(yīng)分別給出安裝

28、步驟。所有產(chǎn)品的安裝包括以下界面：安裝快閃界面條件、安裝初始窗口（歡迎）、版權(quán)聲明界面、選擇安裝路徑界面、選擇程序文件夾（程序組）界面條件、安裝進(jìn)程界面條件及安裝完成界面。 系統(tǒng)配置條件：應(yīng)給出系統(tǒng)配置的詳細(xì)過程，以便用戶能夠順利操作系統(tǒng)。對(duì)于網(wǎng)絡(luò)版軟件，應(yīng)分別講述服務(wù)器和客戶端的配置過程。3. 系統(tǒng)的啟動(dòng)：應(yīng)給出系統(tǒng)啟動(dòng)的方法。如果系統(tǒng)由多個(gè)模塊組成，則不必單列出一節(jié)講述系統(tǒng)的啟動(dòng)方法，只須在介紹各個(gè)模塊的操作時(shí)給出模塊的啟動(dòng)方法即可。對(duì)于系統(tǒng)的安裝及啟動(dòng)的結(jié)構(gòu)總結(jié)如下，供編寫用戶手冊(cè)時(shí)參考：|-系統(tǒng)的運(yùn)行環(huán)境 |-硬件環(huán)境| |-軟件環(huán)境|系統(tǒng)的安裝及啟動(dòng) | |-硬件安裝|-系統(tǒng)的安裝

29、|-軟件安裝| |-系統(tǒng)的配置|-系統(tǒng)的啟動(dòng)§2.2.9 系統(tǒng)操作說明系統(tǒng)操作說明是所有用戶手冊(cè)的主體，它所包含的內(nèi)容相當(dāng)廣泛。主要包括：輸入的命令和數(shù)據(jù)、軟件的功能、輸出結(jié)果、出錯(cuò)信息及其矯正和恢復(fù)方法。對(duì)于不同的軟件，其操作說明也應(yīng)有所不同，下面就幾種情況分別予以介紹。§2.2.9.1 CAD軟件CAD軟件的操作說明應(yīng)包括文件管理、圖紙尺寸設(shè)置、圖形繪制、圖形編輯、尺寸標(biāo)注、圖層管理、圖庫調(diào)用條件、圖庫維護(hù)條件及附錄條件等內(nèi)容。在用戶手冊(cè)中應(yīng)按操作順序或界面中菜單順序分別對(duì)上述內(nèi)容中的每一項(xiàng)操作予以介紹。要求詳細(xì)給出操作過程及命令格式與功能，具體規(guī)定如下：1. 各種操作

30、、命令和語言：軟件系統(tǒng)的使用過程都是使用軟件系統(tǒng)提供的各種操作、命令和語言的過程。所以，我們必須做到：1) 操作和命令：在用戶手冊(cè)中詳細(xì)給出各種操作的過程和功能、命令的格式和功能；應(yīng)當(dāng)描述在使用上的各種限制，如，操作狀態(tài)、操作條件、操作序列等。另外，必要時(shí)可以通過適當(dāng)?shù)嘏e例講述各種操作和命令的使用方法，以幫助用戶理解。2) 輸出信息：應(yīng)該詳細(xì)列出與操作、命令相關(guān)的各種輸出信息。如果輸出信息的意思本身不是很明顯，應(yīng)當(dāng)給予解釋。另外還應(yīng)當(dāng)說明對(duì)于這些信息所采取的操作。3) 程序設(shè)計(jì)語言條件：如果我們的軟件系統(tǒng)提供了某種語言，對(duì)其語言規(guī)則應(yīng)當(dāng)給予說明。2. 各種數(shù)據(jù)：在軟件的使用過程中，用戶必須與各

31、種數(shù)據(jù)和信息打交道。為了讓用戶能夠操作我們的軟件，我們必須為用戶提供各種結(jié)構(gòu)以及每個(gè)數(shù)據(jù)元素的含義有些數(shù)據(jù)適合在系統(tǒng)操作說明中給出，有些適合在后面的附錄中給出，甚至有些除了在操作說明的同時(shí)給出外，還要在附錄中給予歸納，這些都由用戶手冊(cè)編寫人員根據(jù)實(shí)際情況來決定。這些數(shù)據(jù)包括：1) 輸入數(shù)據(jù)條件：應(yīng)該給出數(shù)據(jù)的內(nèi)容、邏輯結(jié)構(gòu)、格式以及每一個(gè)數(shù)據(jù)元素的意思。如果輸入數(shù)據(jù)依賴于某特定數(shù)據(jù)介質(zhì)，則應(yīng)當(dāng)給予說明。2) 輸出數(shù)據(jù)：應(yīng)當(dāng)給出軟件以何種形式輸出的數(shù)據(jù)的內(nèi)容和格式，并要求以例樣的形式給予說明。3) 中間數(shù)據(jù)條件：如果我們告訴用戶在軟件的運(yùn)行過程中所產(chǎn)生的中間數(shù)據(jù)的內(nèi)容和格式，有助于用戶理解軟件的

32、使用，則應(yīng)當(dāng)給予說明4) 數(shù)據(jù)限制條件：如果對(duì)數(shù)據(jù)有限制，如數(shù)據(jù)的大小限制，則應(yīng)當(dāng)給予說明。5) 數(shù)據(jù)文件條件：如果要告訴用戶我們的軟件所使用的某些數(shù)據(jù)文件的結(jié)構(gòu)有助于用戶理解我們軟件的使用，則應(yīng)給予說明，但應(yīng)該注意技術(shù)保密。如果對(duì)數(shù)據(jù)文件有所限制，例如每個(gè)文件的最大記錄數(shù)、每個(gè)磁盤的最大文件數(shù)等，應(yīng)當(dāng)給予說明。3. 處理過程條件：如果我們簡(jiǎn)要地給用戶描述我們軟件對(duì)用戶的操作、輸入的命令和輸入數(shù)據(jù)的處理過程，有助于用戶了解我們軟件的使用，則應(yīng)給予說明。4. 截圖內(nèi)容：目前，多數(shù)軟件已不再采用命令行輸入方式，而是采用對(duì)話框輸入方式。在此情況下，應(yīng)該以圖示方式對(duì)軟件的操作過程予以介紹。采用圖示方式

33、講述軟件操作過程應(yīng)注意以下幾點(diǎn)： 所截圖形的輸入、輸出信息中不應(yīng)包含本公司人員的真實(shí)姓名，且各種輸入、輸出信息以不泄漏公司機(jī)密為原則。 截圖是為使敘述更加明確、簡(jiǎn)潔，所以應(yīng)盡量避免不必要的截圖。一般來說，在用戶手冊(cè)中應(yīng)該包括系統(tǒng)的主界面、各種操作的初始界面（點(diǎn)取命令后彈出的第一個(gè)界面，一般需要輸入信息）、操作中間過程界面、操作結(jié)果界面以及其它一些必要的界面。沒有必要為下拉菜單、快捷菜單等內(nèi)容截圖，因?yàn)檫@些操作都比較簡(jiǎn)單，只要用語言敘述用戶即可明確其操作方法。另外，在同一本手冊(cè)中，應(yīng)避免重復(fù)截圖，對(duì)于不同輸入或輸出信息的同一界面在手冊(cè)中不應(yīng)重復(fù)（例題除外）。5. 出錯(cuò)處理：應(yīng)當(dāng)給出各種出錯(cuò)情況以

34、及相應(yīng)的處理措施。6. 現(xiàn)對(duì)系統(tǒng)操作說明的步驟總結(jié)如下，供編寫用戶手冊(cè)時(shí)參考：1) 進(jìn)入相關(guān)界面。2) 調(diào)用命令（選擇菜單、鍵入命令或點(diǎn)擊工具按鈕）。3) 彈出相應(yīng)的操作初始界面（或提示行）。4) 對(duì)輸入信息給予說明。5) 繼續(xù)操作（點(diǎn)擊按鈕或選擇參數(shù)及鍵入按鍵等）。6) 結(jié)果界面（或結(jié)果提示行）。7) 對(duì)輸出信息給予說明?！揪妗吭诰帉戃浖脩羰謨?cè)的系統(tǒng)操作說明時(shí)，我們?cè)跊Q定是否提供某種數(shù)據(jù)的格式時(shí)，應(yīng)以不泄漏公司的技術(shù)而且有利于用戶使用為準(zhǔn)則。§2.2.9.2 其它軟件對(duì)于一些比較復(fù)雜的軟件，一般包括多個(gè)模塊。對(duì)于此類系統(tǒng)，要求按照操作順序?qū)Ω鱾€(gè)模塊分別介紹。一般按模塊分成若干章

35、，在各章中對(duì)相關(guān)模塊的操作予以介紹。對(duì)于此類軟件的操作步驟總結(jié)如下：1. 啟動(dòng)某一模塊，進(jìn)入該模塊的主界面。2. 執(zhí)行某一功能（選擇菜單或工具按鈕）。3. 彈出相關(guān)界面。4. 對(duì)輸入信息予以說明。5. 繼續(xù)操作（點(diǎn)擊按鈕）。6. 結(jié)果界面。7. 對(duì)輸出信息予以說明。有些軟件的操作可能需要一定的技術(shù)和經(jīng)驗(yàn)才能獲得滿意的結(jié)果，那么應(yīng)該在用戶手冊(cè)上盡量給出這些技術(shù)和經(jīng)驗(yàn)的描述，或告訴用戶如何才能獲得這些技術(shù)和經(jīng)驗(yàn)。例如，在操作SEAS系統(tǒng)作圖紙凈化處理時(shí)，如何選擇適當(dāng)?shù)拈y值就需要一定的技術(shù)和經(jīng)驗(yàn)。一些比較簡(jiǎn)單的系統(tǒng)，如NetEye、OpenVideo等其系統(tǒng)操作比較簡(jiǎn)單，操作說明內(nèi)容比較少。對(duì)于此類軟件，手冊(cè)中可以將操作說明歸納為一章，再按操作順序予