1、用戶手冊編寫規范目錄1 .用戶手冊格式的統一規定1.1 章、節標題1.2 版面設置2 .用戶手冊的內容2.1 用戶手冊的目標2.2 用戶手冊的內容2.3 用戶手冊的風格1 .用戶手冊格式的統一規定1.1 章、節標題 一般情況下，用戶手冊用章、節來劃分其內容。如果有的系統很大，其用戶手冊所包含 的內容繁多，那么請根據其內容把用戶手冊劃分為幾個分冊。每一分冊根據本規定獨立 進行章、節編號。1.1.1 章標題每章的編號用阿拉伯數字表示，采用“第1章”、“第2章”、的形式表示章的編號， 章的編號后面空一個半角的格，然后是這一章的標題。1）每一章必須另起一頁開始；2）章的編號和標題采用左對齊的格式放在行

2、的左邊；3）章的編號和標題采用黑體小三號字；4）章的編號和標題與其篇眉之間空一行，和其正文之間空三行。1.1.2節標題節的編號格式為“ § x.y”。其中，x為章的號碼，y為節的號碼，用阿拉伯數字表示。節 的編號后面空一個半角的格，然后是這一節的標題。1）每一節必須另起一頁開始；2）節的編號和標題采用左對齊的格式放在行的左邊；3）節的編號和標題采用黑體四號字；4）節的編號和標題與其篇眉、正文之間均空一行。1.1.3小節標題小節的編號格式為“ § x.y.z"。其中，x為章的號碼，y為節的號碼，z為小節號碼，用阿 拉伯數字表示。小節的編號后面空一個半角的格，然后是這

3、一小節的標題。1）不必專為小節另起一頁開始；2）小節的編號和標題從左邊開始頂格書寫；3）小節的編號和標題采用黑體小四號字；4）小節的編號和標題與其前后的正文之間均空一行。【注意】1） 一般情況下，章的下面可以劃分為節和小節，但要具體情況具體分析。如果沒有劃分 小節的必要，則可以劃分到節為止；而且，如果有必要，還可以在小節下面劃分更小的 節，我們暫且稱之為小小節。2）對于小小節的各種規定與小節一致。1.1.4其它編號1）頁編號：用戶手冊中的正文按章進行編號，其格式為“章一頁”。如，第 2章的第3頁, 編號為“2-3”。各種頁編號的形式請參考本手冊所采用的格式。2）圖、表編號：用戶手冊中的圖、表均

4、按章分別進行編號，其格式分別為“圖x-y”、“表x-y”。如，第2章的第3幅圖的編號是“圖2-3” ；第2章的第3張表格的編號是“表2-3”。在圖、表編號的編號后面空一個半角的格，然后是這一圖表的名稱。另外，還規定：表的編號與名稱放在表的頂部表的編號與名稱和表在左邊對齊，而整個表則對中放置表的編號與名稱和前面的正文之間空一行，和表之間無空行表和其后面的正文之間空一行圖的編號與名稱放圖的底部圖的編號與名稱和圖均對中放置圖的編號與名稱和前面的圖、后面的正文之間均空一行圖和其前面的正文之間空一行圖、表的編號與名稱均采用黑體五號字打印3）編號序列：在本章的1.1.3中的編號序列為無名編號序列，在本小節

5、中，帶編號的序列 為有名編號序列。在節、小節、小小節里面均可以含有編號序列。在一般情況下，節中 編號序列所含的內容比小節所含的內容少，在什么情況下用小節、小小節，在什么情況 下用編號序列，由用戶手冊的編制人員自己確定。編號序列在縮進兩個漢字位置之后開始書寫，對于有名編號序列的編號和名稱要選擇黑 體五號打印方式，其后面的內容均采用五號宋體漢字。在帶編號的序列里還容許二級編號序列，其格式規定如下：編號的格式是“ n）."，其中n為阿拉伯數字其它規定和一級序列編號一致【注意】1）用戶手冊的正文均采用宋體五號漢字。2）編寫手冊時，對于界面中的按鈕名稱，應把按鈕名稱用尖括號“”括起來，按鈕名稱

6、用黑體五號字書寫。對于下拉菜單選項的名稱，應用引號”引起來，選項名稱用黑體五號字書寫。1.2版面設置1.2.1 版面設置對于版面設置我們作如下規定：1）紙型：用戶手冊用紙統一規定為 B5。寬18.2厘米，長25厘米；2）行間距：用戶手冊中的行間距統一定為一倍半行距；3）縮進：每段的第一行縮進兩個漢字的位置；4）頁面頂部空白：頁面頂邊到正文的距離為 3厘米；5）頁面底部空白：頁面底邊到正文的距離為 2厘米；6）頁面內邊空白：頁面內邊（單號頁的左邊、雙號頁的右邊）到正文的距離為2.1厘米;7）頁面外邊空白：頁面外邊（單號頁的左邊、雙號頁的右邊）到正文的距離為1.6厘米,1.2.2 空行規定為了保持

7、版面清晰，在用戶手冊的正文中要保留一定的空行，規定如下：1）章標題和其正文之間保留3行空白；2）節標題之后留一空行；3）小節標題、小小節的前后均留一空行；4）表的編號與名稱和前面的正文之間空一行，和表之間無空行；5）表和其后面的正文之間空一行；6）圖的編號與名稱和前面的圖、后面的正文之間均空一行；7）圖和其前面的正文之間空一行；8）各正文段之間空一行。1.2.3 關于頁眉的規定頁眉位于用戶手冊每一頁的頂部，對頁眉的規定如下：1）版權中明、前言、閱讀指南、目錄均無篇眉；2）章編號和名稱所在頁的篇眉為一行有50%填充的邊框；3）對于單號頁，頁眉的內容是當前章的標題名，要求打印在紙的右上角；4）對于

8、雙號頁，頁眉的內容是用戶手冊的名稱，要求打印在紙的左上角；5）紙的頂邊與頁眉的距離是2.3厘米；6）頁眉所采用的是昆侖細圓小五號字。1.2.4 關于頁腳的規定頁腳位于用戶手冊每一頁的底部，對頁腳的規定如下：1）頁腳的內容是當前頁的頁編號，具體編號方式請參考本手冊；2）頁編號的字體采用宋體五號；3）紙的底邊與頁腳的距離是1.3厘米1.2.5 注意與警告在用戶手冊中，對于那些需要用戶特別注意的事項，應該用“【注意】”作為標志給用 戶以特別的提示。關于注意標志和注意事項的格式有如下規定：1）注意標志靠左頂格書寫；2）注意標志采用的是黑體小四號漢字；3）注意標志和其前面的正文之間應該有一個空行；4）如

9、果注意事項只有一條，其內容應該緊跟在注意標志的后面書寫；否則，應該在注意 標志的下一行開始，采用編號序列的形式分別給出。在用戶手冊中，對于那些會給用戶造成重大損失的行為，應該用“【警告】”作為標志 給用戶以警告性的提示。對于一個好的軟件系統來說，這種警告性的提示應少一些，但 如果必要，還是應該存在。【注意】關于警告標志和警告事項的格式規定與關于注意標志和注意事項的格式規定一 致。2用戶手冊的內容規定用戶手冊所要達到的目標、包含的內容、以及編寫的風格。如果標題后跟有“ K條件R ”字樣，說明該標題下正文所要求的內容是在一定條件下所 必須的。2.1 用戶手冊的目標1）讓用戶手冊成為用戶學習使用我們

10、產品的最好教材。2）讓用戶手冊能夠起到降低銷售費用的作用。【注意】如果本系統軟件是一個大系統，其系統安裝、操作說明、系統及數據維護都相 當復雜，則可以把這三個部分分別編寫為一本甚至幾本用戶手冊，每本手冊都有自己的 封面、版權聲明、前言、閱讀指南、目錄以及相應的基礎知識介紹和附錄。2.2 用戶手冊的內容2.2.1 版權聲明版權聲明是保護我們所開發軟件的產權、不使我們公司利益受到損害的一種方式。在版 權聲明中應該包括以下內容：1）對我們所提供的軟件及用戶手冊的保護聲明；2）對我們的軟件及商標 東大阿爾派®所有權的聲明；3）對我們的用戶手冊中所提到的各種商標的版權聲明；4）我們不對用戶因為

11、使用我們的軟件所造成的損失負責的聲明。2.2.2 前言前言主要包括以下內容：1）系統的開發背景和目的；2）系統所能應用的領域和使用對象；3）系統的功能及特性簡介；4）如果本手冊不是該系統的第一個版本，還應該簡介較上一版本的改進部分。2.2.3 閱讀指南應該包含如下幾部分：1）手冊目標：通過閱讀該用戶手冊，用戶應該或能夠達到什么目標。2）閱讀對象：指明什么人員應該閱讀該手冊，或什么人員應該閱讀本手冊的哪些部分； 閱讀對象在閱讀本手冊之前應該掌握哪些知識，必要時應給出資料清單，以便用戶查閱。3）手冊構成：如果本系統的用戶手冊（包括管理員手冊、參考手冊）由幾本組成，首先應 該分別簡要介紹這些手冊的情

12、況。最根本的是應該介紹本手冊在哪一章或哪幾章講解了 什么內容。4）手冊約定：這一部分應該包括字體的約定、特殊符號的約定。必要時，應該給出某些 基本術語的定義。也可以把基本術語、概念的定義作為基礎知識來介紹。2.2.4 目錄目錄的編寫要盡量詳盡。如果用戶手冊的內容用到小節，則目錄就應該編寫到小節；如 果用戶手冊的內容用到小小節，則目錄就應該編寫到小小節。編寫用戶手冊目錄的目的 就是為了讓用戶能夠根據它很快地找到想要的內容。2.2.5 基礎知識介紹K條件用戶手冊編寫人員應該根據實際情況確定是否需要這一部分。在一般情況下，使用我們的軟件系統需要一定的基礎知識。這些知識可以從有關書籍上 得到，但是用戶

13、從這些資料得到這些知識需要花費相當的時間。在某些情況下，我們只 需要用戶掌握用戶手冊中使用的那些概念，那么我們就有必要編寫一章“基礎知識介紹” 來進行專門介紹。2.2.6 系統安裝系統安裝部分應該包括如下內容：1）硬件環境要求說明：系統運行時所需硬件環境描述，包括機型、內存大小、硬盤空間等。如果需要，還應該包括輸入/輸出設備、通迅環境等。2）軟件環境要求說明：系統運行時所需軟件支持環境描述，包括所需其它軟件的名稱及 版本號等。3）其它環境要求說明K條件R :應該說明要求的任何其它環境。4）硬件安裝K條件：如果必要，應該詳細說明系統所需硬件環境的安裝過程。5）建立軟件備份K條件R :如果條件容許

14、，應該告訴用戶如何作系統原介質上軟件系統的備份，同時要求用戶把系統的原介質作穩妥的保存，用系統的備份介質作系統安裝。6）系統安裝過程：這里要求給出最終用戶能夠據此把我們的軟件系統安裝到其操作環境的任何必要信息和操作。例如，環境變量的設置、系統配置描述格式等。2.2.7 系統操作說明系統操作說明是用戶手冊的主體，主要包括系統起動、輸入的命令和數據、軟件的功能、輸出結果、出錯信息及其矯正和恢復方法。1）系統起動：應給出系統起動的詳細過程。2）各種操作、命令和語言：軟件系統的使用過程都是使用軟件系統提供的各種操作、命 令和語言的過程。操作和命令：在用戶手冊中詳細給出各種操作的過程和功能、命令的格式和

15、功能；應 當描述在使用上的各種限制，如，操作狀態、操作條件、操作序列等。另外，必要時 可以通過適當的舉例講述各種操作和命令的使用方法，以幫助用戶理解。輸出信息：應該詳細列出與操作、命令相關的各種輸出信息。如果輸出信息的意思本 身不是很明顯，應當給予解釋。另外還應當說明對于這些信息所采取的操作。程序設計語言K條件R ：如果我們的軟件系統提供了某種語言，對其語言規則應當給予說明。關于程序設計語言的用戶手冊的內容，其詳細說明我們以后補充。3）各種數據：在軟件的使用過程中，用戶必須與各種數據和信息打交道。為了讓用戶能夠操作我們的軟件，我們必須為用戶提供各種結構以及每個數據元素的含義。有些數據適合在系統

16、操作說明中給出，有些適合在后面的附錄中給出，甚至有些除了在操作說明的同時給出外，還要在附錄中給予歸納，這些都由用戶手冊編寫人員根據實際況來決定。這些數據包括：輸入數據K條件R ：應該給出數據的內容、邏輯結構、格式以及每一個數據元素的意 思。如果輸入數據依賴于某特定數據介質，則應當給予說明。輸出數據：應當給出軟件以何種形式輸出的數據的內容和格式，并要求以例樣的形式給予說明。中間數據K條件R ：如果我們告訴用戶在軟件的運行過程中所產生的中間數據的內容 和格式，有助于用戶理解軟件的使用，則應當給予說明。數據限制K條件R ：如果對數據有限制，如數據的大小限制，則應當給予說明。數據文件K條件R ：如果要

17、告訴用戶我們的軟件所使用的某些數據文件的結構有助于 用戶理解我們軟件的使用，則應給予說明，但應該注意技術保密。如果對數據文件有 所限制，例如每個文件的最大記錄數、每個磁盤的最大文件數等，應當給予說明。4）處理過程K條件R ：如果我們簡要地給用戶描述我們軟件對用戶的操作、輸入的命令 和輸入數據的處理過程，有助于用戶了解我們軟件的使用，則應給予說明。5）出錯處理：應當給出各種出錯情況以及相應的處理措施。6）操作技術K條件R ：有些軟件的操作可能需要一定的技術和經驗，才能獲得滿意的結 果，那么應該在用戶手冊上盡量給出這些技術和經驗的描述，或告訴用戶如何才能獲得 這些技術和經驗。例如，在操作SEAS系

18、統作圖紙凈化處理時，如何選擇適當的閥值就是 需要一定的技術和經驗的問題。【警告】在編寫軟件用戶手冊的系統操作說明時，我們在決定是否提供某種數據的格式 時，應以不泄漏公司的技術而且有利于用戶使用為準則。2.2.8 系統及數據維護應該給出用戶數據的后備、恢復、刪除、整理的詳細過程。如果必要，應該給出系統數 據、系統磁盤空間維護的詳細過程。2.2.9 例題K條件有些軟件系統可以通過一個較為完整的例題演示系統的大部分功能的使用方法，在這個 例題中，用戶應該詳細地描述每一步的操作過程，用戶可以通過這個例題對系統的操作 有一個初步的了解。2.2.10 各種附錄在用戶手冊中，有些知識和信息可以通過附錄的形式提供給用戶，以便于用戶查閱，這 些內容是：1）錯誤提示信息：通常可以以表的形式按照一定的順序， 例如按出錯提示信息編號順序、 或按出錯提示信息的字母順序，給出出錯提示信息的編號、提示信息、相應的解釋、出 錯原因和解決辦法。2）命令速查表K條件1:通常