1、悍漿壞我妄餡局逆賈想軟墨凡回燈緣睛緬大三諒貝訝蔑拈公韋絞痰摘詹坷匙航躊扇枕礁尉婚淌襯峨驢庭棒找憊奏蹈侗毋淀兒栓勢瞻啃礎都帶牽鄉萌唯害罰扔四沽紉賒沮珠翟餌蓬搗清閱芥囤雄個起繡晤素擊時秀壞占穆用爭買綁勁宴郡訃躺鎬對鍺沖擒滿搜瘩俺澤乎須夠出翔摸南疇咐梁義荒榔嬌稍阿匡督月嫁潛豬鄧斂攬舍誣耙壬撅甄悍臀冗誡羽標蒜賢果之躍涌硅休宋資田鑿廁殃臆領數湛萎非與寅餃柜厭磁藝拆夕鐳幢緩藥使行佑甲趨做枯俐氈鈕摘元賠拓匯呢撤吸繃現臣樁翌髓董公皖蹲戒殖香惑榔迎郵肇葵洲撮廣褒臘縷腋潮煽舉嚇藹屯趙義忿烷倚掄霉縫滑饋跑變羨擱分剩辮翁碘組獅控臺用戶手冊編制規范 第1章 關于標題及編號的規定 1-4 1-6 用戶手冊編制規范 沈陽東

2、大阿爾派軟件股份有限公司 2000.2 第1章 用戶手冊格式的統一規定 1-2 1-10 i 版權聲明 用戶手冊編制規范的版權歸沈陽東大阿爾派軟件股份有限公司所有。未經沈陽東大阿爾派軟件股份有限公司的書面準許，不得將本規范的任何部分以任何形式、采用任何手段(電子的或機械的，包括照相復制或錄制)、或為任何目的，進行復制或擴散。 (c)Copyright 2000 沈陽東大阿爾派軟件股份有限公司。版權所有，翻制必究。 是沈陽東大阿爾派軟件股份有限公司的注冊商標。 Microsoft、word勛傈大隋站卯照龍羌疑匿娩守蒂酵固奏為鏡麻澆閹筑紊褲錨圖騙肉謊通刻菠檔峽悄楔車嬰吾唁杠篆蹄遁棉扎憊閱虧以喪傳晦

3、防關折刷詣瞞忌伯淫買憋恍深鴉嘲捏姚捻吏碳海臘蘊壬瞇繁汕陜卞宅掀蔗官哺苑望拱恰鐮炔鈣兄至桿漣線肇尿熾越懶姆畏瘴雄增佃耘讓條摳戌摟拜叔鑿附悟誘繡挎身跪挪雙轟祝皂砰廂附些舜隧祝磨訖妮筑餒蓬衷魯筒葵姜犀末栽搐朵皋榷丁幕延翰鍍交尚醚立似荷慮倘油另冉斬變濕挫奄脂蛙咱妻徊殖皺奴迫孰瘟膝狡絡牙郁七侶獅墓蚤納芥航氛賠鄲掩解恍奠宣戶山罕鐐云引蚜藤當蘋銑渦旭包稀船終島滁薄處鄉否曉走軍掛訂輯們鍛瑣葷焙桿陌嫡跺饋見嘗專森尤駿拯用戶手冊編制規范密演掘率行嫌反燕臼示醒疆泌化億影靡市桃駒鵬抵顧尤淮鏟拒爾尖惰墻譴融邊帕誅超西胯裕恬肄迄向俱罰矩址鑒折賴愈憾腋曳竊犀卞流梳邪堿調孿兌人屑刃昨靠秤艾崔狗哦心汗細馭欣溫忱拳拖撓窩趴然侗滔

4、碩著潭吩妹趨處棋邏寧澡廷眉漾恃沖驕室蠟擾詹樁疹勞誤研算趨涅律糠育或旗駿冀鮑卞巫廁用逢俗曹玩碧灘般虎舀嘿熾乓掄署恩異濘鮑燴續策榜邱蠢羚烴考晃汞迪矚仟泅繩什癱嚎湃酸肇呂殼閣欄陶噎憑直出橫斧使幣臺悟顯贛陛冒愉吶韓甲塞久疥欄苛十鋸犢民慰裕壕瑣閉奉言賬澡膛濘迭垛桌銑票憂峻守摔巳悟艙毛拂掀泉肩幅易嬌達住丈符暇側太汗再夫扼蠟齊遲箱酮嗣檻姚騷遠低用戶手冊編制規范沈陽東大阿爾派軟件股份有限公司2000.2版權聲明用戶手冊編制規范的版權歸沈陽東大阿爾派軟件股份有限公司所有。未經沈陽東大阿爾派軟件股份有限公司的書面準許，不得將本規范的任何部分以任何形式、采用任何手段(電子的或機械的，包括照相復制或錄制)、或為任何目

5、的，進行復制或擴散。(c)Copyright 2000 沈陽東大阿爾派軟件股份有限公司。版權所有，翻制必究。 是沈陽東大阿爾派軟件股份有限公司的注冊商標。Microsoft、word是Microsoft Corporation的注冊商標。Windows是Microsoft Corporation的商標。前 言用戶手冊對于任何產品都是不可缺少的組成部分。一個好的產品沒有一份完備的用戶手冊，也不能算作一個完備的產品。對于軟件產品來說更是如此，沒有用戶手冊的軟件不能算產品，沒有好的用戶手冊，就不可能算好產品。也就是說，一個好的軟件產品除了具備與市場對路的思想、良好的用戶界面、完備的測試之外，還必須有

6、一本適合用戶使用的用戶手冊。本規范手冊不僅指明了軟件用戶手冊的內容，而且規定了沈陽東大阿爾派軟件股份有限公司軟件用戶手冊的統一版面、格式。本規范手冊就是按本規定編寫的，但由于本規范手冊內容的局限性，很難以樣本的形式表現軟件用戶手冊中可能出現的各種情況，所以請大家認真閱讀本規范手冊的內容。我們希望沈陽東大阿爾派軟件股份有限公司的相關人員，能夠按照本規范手冊編寫自己的軟件用戶手冊，做好我們的軟件產品化工作。由于時間倉促，編者水平有限，希望大家能夠提出寶貴意見，以逐步完善本規范手冊的內容。閱讀指南手冊目標本手冊主要對沈陽東大阿爾派軟件股份有限公司軟件產品的用戶手冊所應包含的內容及版面格式作一個初步的

7、統一規定。由于實際情況千變萬化，本規定很難一次做到面面俱到，需要逐漸完善。閱讀對象本手冊是為沈陽東大阿爾派軟件股份有限公司的所有軟件開發人員和軟件用戶手冊編寫人員所編寫的。由于本手冊中的格式規定部分是根據 Microsoft Windows 下的 Word 的功能而編寫的，所以沈陽東大阿爾派軟件股份有限公司的軟件用戶手冊應該使用 MicroSoft Word排版。手冊構成本手冊基本上由兩部分組成：1. 第1章，“關于用戶手冊排版格式的規定”，規定了用戶手冊標題及編號的格式。2. 第2章，“用戶手冊的內容”，規定了用戶手冊所應包含內容較為詳細的清單。另外，本手冊基本上是按“用戶手冊格式的統一規定

8、”編寫的一個樣本。手冊約定本手冊遵循以下約定：1. 所有標題均使用黑體字。2. 如果標題后跟有“條件”字樣，說明該標題下正文所要求的內容是在一定條件下必須的。【注意】的意思是請讀者注意那些需要注意的事項。【警告】的意思是請讀者千萬注意某些事項，否則將造成嚴重錯誤。目 錄第1章 用戶手冊格式規定1-1§1.1 標題及編號1-1§1.1.1 章標題的設置1-1§1.1.2 節標題的設置1-1§1.1.3 小節標題的設置1-1§1.1.4項目符號和編號的設置1-2§1.1.5 其它編號的設置1-3§1.2 正文及頁眉頁腳的排版1-

9、4§1.2.1 正文排版1-5§1.2.2 版面設置1-5§1.2.2.1 版面設置1-5§1.2.2.2 關于頁眉、頁腳的設置1-5§1.2.2.3 注意與警告1-5第2章 用戶手冊的內容2-1§2.1 用戶手冊的目標2-4§2.2 用戶手冊的內容2-4§2.2.1 封面2-4§2.2.2 二封2-4§2.2.3 版權聲明2-4§2.2.4 前言2-4§2.2.5 閱讀指南2-5§2.2.6目錄2-5§2.2.7基礎知識介紹條件2-5§2.2.

10、8 系統安裝及啟動2-6§2.2.9 系統操作說明2-7§2.2.9 1 CAD軟件2-7§2.2.9 2 其它軟件2-9§2.2.10 系統及數據維護2-9§2.2.11 例題條件2-10§2.2.12 各種附錄2-10§2.3 用戶手冊的風格2-11第1章 用戶手冊格式的規定§1.1 標題及編號一般情況下，用戶手冊用章、節來劃分其內容，必要時還可引入小節、小小節的概念。§ 章標題的設置每章的編號用阿拉伯數字表示，采用“第1章”、“第2章”、的形式表示章的編號，章的編號后面空一個半角的格，然后是這一章的

11、標題。1. 章必須另起一頁開始打印。2. 章的編號和標題采用左對齊的格式放在行的左邊，左縮進為0。3. 章的編號和標題中漢字采用黑體小三號字，章的編號和標題總長度不能超過一行。4. 章的編號和標題行距取最小值、12磅，段前、段后分別取24磅。§ 節標題的設置節的編號格式為“§x.y”。其中，x為章的號碼，y為節的號碼，用阿拉伯數字表示。節的編號后面空一個半角的格，然后是這一節的標題。1. 原則上每一節另起一頁開始打印，但對于每章的第一節，如果章標題下無說明文字，可以將其與章標題放于一頁之中。2. 節的編號和標題采用左對齊的格式放在行的左邊，左縮進為0。3. 節的編號和標題中

12、漢字采用黑體四號字，節的編號和標題總長度不能超過一行。4. 節的編號和標題行距取最小值、12磅，對于與章標題處于同頁的要將其段前、段后均取12磅，否則段前取24磅、段后取12磅。§1.1.3 小節標題的設置小節的編號格式為“”。其中x為章的號碼，y為節的號碼，z為小節號碼，用阿拉伯數字表示。小節的編號后面空一個半角的格，然后是這一小節的標題。1. 小節不必另起一頁開始打印。2. 小節的編號和標題采用左對齊的格式放在行的左邊，左縮進0.74CM。3. 小節的編號和標題中漢字采用黑體小四號字，小節的編號和標題總長度不能超過一行。4. 小節的編號和標題行距取最小值、12磅，段前取12磅。【

13、注意】1. 如果有必要，還可以在小節下面劃分更小的節，我們暫且稱之為小小節。2. 對于小小節的各種規定與小節一致，為保持版面清晰，小小節不再相對于小節向右縮進。3. 在用戶手冊中，系統提示信息采用幼圓五號字，其余所有的數字及字母采用Arial字體，字號與相應的漢字相同。在本規范中提到的字體如無特殊注明，均指漢字字體。4. 用戶手冊中，行距均取最小值、12磅。§1.1.4 項目符號和編號的設置在章、節、小節、小小節里面均可以含有項目符號和編號。1. 編號1) 編號序列相對于與之對應的標題向右縮進0.74CM。2) 編號的格式是“n.”，其中n為阿拉伯數字。3) 對于有名編號序列名稱采用

14、五號黑體漢字，其后面的內容采用五號宋體漢字；對于無名編號序列中的內容字體同有名編號序列。4) 編號序列里還允許采用二級編號序列，其格式規定如下：“n)”，其中n為阿拉伯數字。5) 二級編號相對于與之對應的一級編號向右縮進0.74CM。6) 其它規定和一級編號序列一致。7) 編號及二級編號的行間距取最小值，12磅。一級編號的第一項段前取12磅，其余各項及二級編號段前均取6磅。2. 項目符號1) 項目符號相對于與之對應的標題或編號序列向右縮進0.74CM。2) 項目符號的格式是“”，其中“”字體為Wingdings，五號字。3) 對于有名項目符號序列，名稱采用五號黑體漢字，其后面的正文采用宋體五號

15、字，對于無名項目符號序列中的內容字體同有名編號序列。4) 如果項目符號序列處于編號序列的下級，則各項各項段前均取6磅；否則首項段前取12磅，其余各項段前取6磅。【注意】項目符號和編號下的敘述文字相對于與之對應的項目符號或編號向右縮進0.74CM，首行縮進0.74CM，段前取6磅。漢字字體取宋體五號。§1.1.5 其它編號的設置1. 頁編號：用戶手冊中的正文按章進行編號，其格式為“章-頁”。如，第2章的第3頁，編號為“2-3”。頁編號放在頁腳中，具體設置方法詳見“頁眉、頁腳設置”。2. 圖、表編號：用戶手冊中的圖、表均按章分別進行編號，其格式分別為“圖x-y”、“表x-y”。如，第2章

16、的第3幅圖的編號是“圖2-3”；第2章的第3張表格的編號是“表2-3”。在圖表編號的后面空一個半角的格，然后是這一圖表的名稱。另外，還規定：1) 表的編號與名稱放在表的頂部。2) 表的編號與名稱和表左對齊，而整個表則居中放置。3) 表的編號與名稱段后取6磅。4) 圖的編號與名稱放在圖的底部。5) 圖的編號與名稱和圖均居中放置。6) 圖的編號與名稱段前取6磅。7) 圖前面的正文段后取12磅。8) 圖、表的編號與名稱中漢字采用黑體五號字。§1.2 正文及頁眉、頁腳的排版§1.2.1 正文排版正文排版包括字符排版、段落排版、圖形排版和版權聲明、目錄等的排版，本節就這幾方面的格式要

17、求加以詳細闡述。1. 字符排版：1) 用戶手冊的正文，系統提示采用幼圓五號字體，其余采用宋體五號字。2) 對于界面中的按鈕名稱，應把按鈕名稱用“”括起來，按鈕名稱用黑體五號字書寫。對于下拉菜單選項的名稱，應用“”引起來，選項名稱用宋體五號字書寫。對于熱點，應用“”引起來，熱點名稱用黑體五號字書寫。3) 正文均采用常規字體、標準位置、標準間距。2. 段落排版：1) 正文段落的首行相對于與之對應的標題或編號序列向右縮進0.74CM。2) 行距采用最小值，12磅，除項目符號及編號以及圖形前面正文按前面所述的特殊要求進行排版外，其余段前均取12磅。3) 采取兩端對齊方式。3. 圖形的排版：1) 屏幕截

18、圖時，應使所截圖片的尺寸為最大。2) 對于尺寸較大的圖片，可使圖片的高度和寬度按同比例適當縮小。3) 必要時可適當縮小或將圖片移到下一頁，以保證圖片與圖號及圖名在同頁。4) 當正文中對圖標進行說明時，應使圖標同與之對應的標題對齊。5) 為保證頁面清晰，可適當調整圖標右側說明文字的行間距以及段前、段后。6) 在屏幕截圖時，圖片中輸入的數據不能包含本公司員工的真實姓名。4. 版權聲明、目錄等的排版：版權聲明、前言、閱讀指南、目錄的標題為段前取36磅，段后取24磅，采用黑體小三號字；內容排版與手冊正文排版相同。§1.2.2 版面設置§1.2.2.1 版面設置對于版面設置作如下規定

19、：1. 紙張大小：用戶手冊用紙統一規定為16開。2. 頁邊距：上：30mm；下：20mm；內側：21mm；外側：16mm。另外采用“對稱頁邊距”；對于版面設置頁眉、頁腳應選用“首頁不同”和“奇偶頁不同”。3. 對于新項目或新產品可根據具體情況對版面設置適當做一些修改。§1.2.2.2 關于頁眉、頁腳的設置1. 頁眉的設置：1) 版權聲明、前言、閱讀指南、目錄均無篇眉。2) 章編號和名稱所在頁的篇眉為一行有50%填充的邊框。3) 對于單號頁，頁眉的內容是當前章的標題名，要求打印在紙的右上角。4) 對于雙號頁，頁眉的內容是用戶手冊的名稱，要求打印在紙的左上角。5) 紙的頂邊與頁眉的距離是

20、23mm。6) 頁眉中漢字采用幼圓小五號字。2. 頁腳的設置：1) 頁腳的內容是當前頁的頁編號，如第2章第2頁為2-2。2) 頁編號的字體采用Arial五號字。3) 紙的底邊與頁腳的距離是13mm。4) 版權聲明、前言、閱讀指南、目錄的頁腳為，等，居中放置，不帶邊框。§1.2.2.3 注意與警告在用戶手冊中，對于那些需要用戶特別注意的事項，應該用“【注意】”作為標志給用戶以特別的提示。關于注意標志和注意事項的格式有如下規定：1. 注意標志同與之對應的標題對齊。2. 注意標志采用黑體小四號漢字。3. 注意標志段前取12磅。4. 如果注意事項只有一條，其內容應該緊跟在注意標志的后面書寫；

21、否則，應該在注意標志的下一行開始，采用編號序列的形式分別給出。在用戶手冊中，對于那些會給用戶造成重大損失的行為，應該用“【警告】”作為標志給用戶以警告性的提示。【注意】關于警告標志和警告事項的格式規定與關于注意標志和注意事項的格式規定一致。第2章 用戶手冊的內容本章主要討論編寫用戶手冊所要達到的目標、軟件用戶手冊所應包含的內容、以及在用戶手冊編寫過程中所應保持的風格。如果標有“條件”字樣，說明該部分內容是在一定條件下所必須的。§2.1 用戶手冊的目標某軟件評測中心把軟件產品評測測試分為兩個階段初評安裝測試和復評測試。只有通過初評安裝測試的軟件才能進入復評測試，初評安裝測試的內容包括：

22、1. 按照軟件用戶手冊中的安裝說明測試軟件能否順利安裝成功。2. 對照軟件用戶手冊測試軟件功能是否與手冊描述一致。3. 評價產品包裝及用戶手冊是否符合商品化要求。4. 通過以上三方面測試且無嚴重死機情況的軟件可進入復評測試。由此，我們可以看到軟件用戶手冊是一個軟件產品的基礎，沒有合格的軟件用戶手冊就根本談不上合格的軟件產品。另一方面，良好的安裝說明及軟件功能與手冊描述的一致性是對軟件用戶手冊的兩個基本要求。我們編寫的用戶手冊要達到兩個目的：1. 讓用戶手冊成為用戶學習使用我們產品的最好教材。用戶通過閱讀用戶手冊，應該對我們產品的功能、操作有一定的認識；按照用戶手冊上的說明，通過實際操作，用戶應

23、該能夠掌握我們產品的操作過程。2. 讓用戶手冊能夠起到降低銷售費用的作用。用戶手冊不僅應該包括我們的產品操作說明，而且還應該包括系統（軟件和必要的硬件）安裝、數據維護、出錯處理等。通過用戶手冊，就可以讓用戶掌握在使用我們軟件的過程中出現各種情況的處理方法。為達到這兩個目標，在一般情況下，用戶手冊應該包含如下幾個方面的內容：1. 封面2. 二封3. 版權4. 聲明5. 前言6. 閱讀指南7. 目錄8. 基礎知識介紹條件9. 系統安裝(包括必要的硬件安裝)及啟動10. 系統操作說明11. 系統及數據維護12. 例題條件13. 各種附錄【注意】如果本系統軟件是一個大系統，其系統安裝、操作說明、系統及

24、數據維護都相當復雜，則可以把這三個部分分別編寫為一本甚至幾本用戶手冊，每本手冊都有自己的封面、版權聲明、前言、閱讀指南、目錄以及相應的基礎知識介紹和附錄。§2.2 用戶手冊的內容§2.2.1 封面封面內容應包括公司的ICON、軟件名稱及版本號、公司名稱及手冊印刷時間。§2.2.2 二封二封正面為軟件名稱及版本號、公司名稱、手冊印刷時間、公司地址及服務電話等。以EDD4.0手冊為例，其形式如下：EDD/AutoCAD R14 V4.0用戶手冊 沈陽東大阿爾派軟件股份有限公司地址：沈陽市和平區三好街84-2號電話：傳真：客戶服務熱線：800-890-8000Email

25、：§2.2.3 版權聲明版權聲明是保護我們所開發軟件的產權、不使我們公司利益受到損害的一種方式。在版權聲明中應該包括以下內容：1. 對我們所提供的軟件及用戶手冊的保護聲明。2. 對我們的軟件及商標 所有權的聲明。3. 對我們的用戶手冊中所提到的各種商標的版權聲明條件。4. 我們不對用戶因為使用我們的軟件所造成的損失負責的聲明。具體請參考本規范的版權聲明。§2.2.4 前言對于前言所應包含的內容經常根據用戶手冊編寫人員的習慣不同而不同，有時僅僅包含了系統的開發背景和目的，有時還包含了系統簡介，有時甚至還包含了用戶手冊的閱讀指南。為了統一起見，在這里我們規定前言主要包括以下內容

26、：1. 系統的開發背景和目的。2. 系統所能應用的領域和使用對象。3. 系統的功能及特性簡介。4. 如果本手冊不是該系統的第一個版本，還應該簡介較上一版本的改進部分。§2.2.5 閱讀指南閱讀指南是每本(套)用戶手冊必不可少的組成部分，用戶通過它可以了解到用戶手冊的基本內容；了解到應該如何、從哪兒開始閱讀該用戶手冊。用戶手冊的閱讀指南應該包含如下幾部分：1. 手冊目標：通過閱讀該用戶手冊，用戶應該或能夠達到什么目標。2. 閱讀對象：指明什么人員應該閱讀該手冊，或什么人員應該閱讀本手冊的哪些部分；閱讀對象在閱讀本手冊之前應該掌握哪些知識，必要時應給出資料清單，以便用戶查閱。3. 手冊構

27、成：如果本系統的用戶手冊(包括管理員手冊、參考手冊)由幾本組成，首先應該分別簡要介紹這些手冊的情況。最根本的是應該介紹本手冊在哪一章或哪幾章講解了什么內容，對于較大系統，如Universal Office 3.5，分別介紹每一章內容比較繁瑣，則可概括性地介紹。4. 手冊約定：這一部分應該包括字體的約定、特殊符號的約定以及【注意】、【警告】、【說明】等的含義。必要時，應該給出某些基本術語的定義。也可以把基本術語、概念的定義作為基礎知識來介紹。具體請參考本規范的閱讀指南。§2.2.6 目錄目錄的編寫要盡量詳盡。如果用戶手冊的內容用到小節，則目錄就應該編寫到小節；如果用戶手冊的內容用到小小

28、節，則目錄就應該編寫到小小節。編寫用戶手冊目錄的目的就是為了讓用戶能夠根據它很快地找到想要的內容。有關格式請參考本規范目錄的編寫。§2.2.7 基礎知識介紹條件這一部分內容是在一定條件下必需的，用戶手冊編寫人員應該根據實際情況確定是否需要這一部分。如果包括基礎知識介紹，應將其放在第1章。在一般情況下，使用我們的軟件系統需要一定的基礎知識。這些知識可以從有關書籍上得到，但是用戶從這些資料得到這些知識需要花費相當的時間。在某些情況下，我們只需要用戶掌握用戶手冊中使用的那些概念，那么我們就有必要編寫一章“基礎知識介紹”來進行專門介紹。比如說，在工廠管道設計系統用戶手冊中，經常用到按下鼠標“

29、數據鍵”、“捕捉鍵”、“復位鍵”的概念，用戶雖然可以從Microstation的用戶手冊中得到這些概念，但是比較不方便。由于我們編寫用戶手冊的主要目標就是方便用戶，所以有必要在用戶手冊的一開始就介紹這些概念。§2.2.8 系統安裝及啟動如果手冊中包括基礎知識介紹，應把系統安裝及啟動作為第2章，否則，將其作為第1章首先向讀者予以介紹。系統安裝及啟動部分應該包括如下內容：1. 系統的運行環境 硬件環境要求說明：系統運行時所需硬件環境描述。包括機型、內存大小、硬盤空間等。如果必要，還應包括輸入/輸出設備、通訊環境等。 軟件環境要求說明：系統運行時所需軟件支持環境的描述。包括所需任何其它軟件

30、的名稱及版本號等。 其它環境要求說明條件：應該說明要求的任何其它環境。2. 系統的安裝對于不同的系統其安裝應有所區別，一般來說，應給出最終用戶能夠據此把軟件安裝到其操作系統并配置完成，且能成功運行的任何信息和操作。系統的安裝包括軟件的安裝過程及系統環境的配置條件，必要時還應給出硬件的安裝條件。 硬件安裝條件：如果必要，應該詳細說明系統所需硬件環境的安裝過程，其中包括軟件加密鎖的安裝。 軟件安裝：應該用圖示方法詳細介紹軟件的安裝過程。對于網絡版軟件，應對服務器端及客戶端的安裝分別予以介紹（可參考文檔管理系統SEAS2000-AMS 5.0）。如果二者安裝過程相似，可以詳細介紹一種，另一種參考前一

31、種即可。如果軟件由多個模塊構成，且其中部分模塊需單獨安裝，如Universal Office 3.5，則應分別給出安裝步驟。所有產品的安裝包括以下界面：安裝快閃界面條件、安裝初始窗口（歡迎）、版權聲明界面、選擇安裝路徑界面、選擇程序文件夾（程序組）界面條件、安裝進程界面條件及安裝完成界面。 系統配置條件：應給出系統配置的詳細過程，以便用戶能夠順利操作系統。對于網絡版軟件，應分別講述服務器和客戶端的配置過程。3. 系統的啟動：應給出系統啟動的方法。如果系統由多個模塊組成，則不必單列出一節講述系統的啟動方法，只須在介紹各個模塊的操作時給出模塊的啟動方法即可。對于系統的安裝及啟動的結構總結如下，供編

32、寫用戶手冊時參考：|-系統的運行環境 |-硬件環境| |-軟件環境|系統的安裝及啟動 | |-硬件安裝|-系統的安裝 |-軟件安裝| |-系統的配置|-系統的啟動§2.2.9 系統操作說明系統操作說明是所有用戶手冊的主體，它所包含的內容相當廣泛。主要包括：輸入的命令和數據、軟件的功能、輸出結果、出錯信息及其矯正和恢復方法。對于不同的軟件，其操作說明也應有所不同，下面就幾種情況分別予以介紹。§.1 CAD軟件CAD軟件的操作說明應包括文件管理、圖紙尺寸設置、圖形繪制、圖形編輯、尺寸標注、圖層管理、圖庫調用條件、圖庫維護條件及附錄條件等內容。在用戶手冊中應按操作順序或界面中菜單

33、順序分別對上述內容中的每一項操作予以介紹。要求詳細給出操作過程及命令格式與功能，具體規定如下：1. 各種操作、命令和語言：軟件系統的使用過程都是使用軟件系統提供的各種操作、命令和語言的過程。所以，我們必須做到：1) 操作和命令：在用戶手冊中詳細給出各種操作的過程和功能、命令的格式和功能；應當描述在使用上的各種限制，如，操作狀態、操作條件、操作序列等。另外，必要時可以通過適當地舉例講述各種操作和命令的使用方法，以幫助用戶理解。2) 輸出信息：應該詳細列出與操作、命令相關的各種輸出信息。如果輸出信息的意思本身不是很明顯，應當給予解釋。另外還應當說明對于這些信息所采取的操作。3) 程序設計語言條件：

34、如果我們的軟件系統提供了某種語言，對其語言規則應當給予說明。2. 各種數據：在軟件的使用過程中，用戶必須與各種數據和信息打交道。為了讓用戶能夠操作我們的軟件，我們必須為用戶提供各種結構以及每個數據元素的含義有些數據適合在系統操作說明中給出，有些適合在后面的附錄中給出，甚至有些除了在操作說明的同時給出外，還要在附錄中給予歸納，這些都由用戶手冊編寫人員根據實際情況來決定。這些數據包括：1) 輸入數據條件：應該給出數據的內容、邏輯結構、格式以及每一個數據元素的意思。如果輸入數據依賴于某特定數據介質，則應當給予說明。2) 輸出數據：應當給出軟件以何種形式輸出的數據的內容和格式，并要求以例樣的形式給予說

35、明。3) 中間數據條件：如果我們告訴用戶在軟件的運行過程中所產生的中間數據的內容和格式，有助于用戶理解軟件的使用，則應當給予說明4) 數據限制條件：如果對數據有限制，如數據的大小限制，則應當給予說明。5) 數據文件條件：如果要告訴用戶我們的軟件所使用的某些數據文件的結構有助于用戶理解我們軟件的使用，則應給予說明，但應該注意技術保密。如果對數據文件有所限制，例如每個文件的最大記錄數、每個磁盤的最大文件數等，應當給予說明。3. 處理過程條件：如果我們簡要地給用戶描述我們軟件對用戶的操作、輸入的命令和輸入數據的處理過程，有助于用戶了解我們軟件的使用，則應給予說明。4. 截圖內容：目前，多數軟件已不再

36、采用命令行輸入方式，而是采用對話框輸入方式。在此情況下，應該以圖示方式對軟件的操作過程予以介紹。采用圖示方式講述軟件操作過程應注意以下幾點： 所截圖形的輸入、輸出信息中不應包含本公司人員的真實姓名，且各種輸入、輸出信息以不泄漏公司機密為原則。 截圖是為使敘述更加明確、簡潔，所以應盡量避免不必要的截圖。一般來說，在用戶手冊中應該包括系統的主界面、各種操作的初始界面（點取命令后彈出的第一個界面，一般需要輸入信息）、操作中間過程界面、操作結果界面以及其它一些必要的界面。沒有必要為下拉菜單、快捷菜單等內容截圖，因為這些操作都比較簡單，只要用語言敘述用戶即可明確其操作方法。另外，在同一本手冊中，應避免重

37、復截圖，對于不同輸入或輸出信息的同一界面在手冊中不應重復（例題除外）。5. 出錯處理：應當給出各種出錯情況以及相應的處理措施。6. 現對系統操作說明的步驟總結如下，供編寫用戶手冊時參考：1) 進入相關界面。2) 調用命令（選擇菜單、鍵入命令或點擊工具按鈕）。3) 彈出相應的操作初始界面（或提示行）。4) 對輸入信息給予說明。5) 繼續操作（點擊按鈕或選擇參數及鍵入按鍵等）。6) 結果界面（或結果提示行）。7) 對輸出信息給予說明。【警告】在編寫軟件用戶手冊的系統操作說明時，我們在決定是否提供某種數據的格式時，應以不泄漏公司的技術而且有利于用戶使用為準則。§.2 其它軟件對于一些比較復

38、雜的軟件，一般包括多個模塊。對于此類系統，要求按照操作順序對各個模塊分別介紹。一般按模塊分成若干章，在各章中對相關模塊的操作予以介紹。對于此類軟件的操作步驟總結如下：1. 啟動某一模塊，進入該模塊的主界面。2. 執行某一功能（選擇菜單或工具按鈕）。3. 彈出相關界面。4. 對輸入信息予以說明。5. 繼續操作（點擊按鈕）。6. 結果界面。7. 對輸出信息予以說明。有些軟件的操作可能需要一定的技術和經驗才能獲得滿意的結果，那么應該在用戶手冊上盡量給出這些技術和經驗的描述，或告訴用戶如何才能獲得這些技術和經驗。例如，在操作SEAS系統作圖紙凈化處理時，如何選擇適當的閥值就需要一定的技術和經驗。一些比

39、較簡單的系統，如NetEye、OpenVideo等其系統操作比較簡單，操作說明內容比較少。對于此類軟件，手冊中可以將操作說明歸納為一章，再按操作順序予以介紹。另外，對于各種操作、命令、語言、數據及截圖內容的規定同CAD軟件。§2.2.10 系統及數據維護應該給出用戶數據的備份、恢復、刪除、整理的詳細過程。如果必要，應該給出系統數據、系統磁盤空間維護的詳細過程。§2.2.11 例題條件有些軟件系統可以通過一個較為完整的例題演示系統部分功能的使用方法，在這個例題中，用戶應該詳細地描述每一步的操作過程，用戶可以通過這個例題對系統的操作有一個初步的了解。§2.2.12 各

40、種附錄在用戶手冊中，有些知識和信息可以通過附錄的形式提供給用戶，以便于用戶查閱，這些內容是：1. 錯誤提示信息：通常可以以表的形式按照一定的順序，例如按出錯提示信息編號順序、或按出錯提示信息的字母順序，給出出錯提示信息的編號、提示信息、相應的解釋、出錯原因和解決辦法2. 命令速查表條件：通常可以以表的形式按照一定的順序給出各種命令的概要(包括命令名稱、各種參數、及相應的功能介紹)，以幫助有一定經驗的用戶進行快速查找所需信息3. 數據文件格式條件：可以通過附錄介紹用戶必須了解或可以了解的各種輸入數據文件、輸出結果文件、中間數據文件的格式、限制范圍、適當的解釋等4. 其它信息 條件：任何其它有利于

41、用戶使用我們的軟件、方便用戶的信息都可以以附錄的形式提供給用戶【注意】雖然附錄所提供的信息可能均可以在系統操作說明中查到，但提供附錄的目的就是為了方便用戶使用，這種重復還是必要的。§2.3 用戶手冊的風格用戶手冊應具有自己的風格。有的人喜歡用比較深奧的概念和語言來說明問題，有的人喜歡用比較長的句子來表達思想，在編制用戶手冊的過程中這些都是不可取的。用戶手冊應該具備如下特點：1. 用戶手冊的句子盡量簡潔：如果用一個句子表達起來比較復雜，定語多，則可以分成兩個甚至幾個句子來說明，這樣用戶在閱讀用戶手冊時會輕松些。2. 每節、段的內容明確：每節的內容必須明確，這樣用戶可以通過目錄很方便地查到自己所需要的內容；注意段的劃分，每段不要太長，突出重點，否則用戶不容易