信息技術(shù)有限公司用戶手冊編制規(guī)范-預(yù)覽頁
【正文】 節(jié)的編號和標(biāo)題采用左對齊的格式放在行的左邊，左縮進(jìn)為0。 小節(jié)標(biāo)題的設(shè)置小節(jié)的編號格式為“167。1. 小節(jié)不必另起一頁開始打印?！咀⒁狻?. 如果有必要，還可以在小節(jié)下面劃分更小的節(jié)，我們暫且稱之為小小節(jié)。4. 用戶手冊中，行距均取最小值、12磅。2) 編號的格式是“n.”，其中n為阿拉伯?dāng)?shù)字。6) 其它規(guī)定和一級編號序列一致。2) 項(xiàng)目符號的格式是“?”，其中“?”字體為Wingdings，五號字。漢字字體取宋體五號。頁編號放在頁腳中，具體設(shè)置方法詳見“頁眉、頁腳設(shè)置”。另外，還規(guī)定：1) 表的編號與名稱放在表的頂部。5) 圖的編號與名稱和圖均居中放置。 167。2) 對于界面中的按鈕名稱，應(yīng)把按鈕名稱用“〈〉”括起來，按鈕名稱用黑體五號字書寫。2. 段落排版：1) 。2) 對于尺寸較大的圖片，可使圖片的高度和寬度按同比例適當(dāng)縮小。6) 在屏幕截圖時(shí)，圖片中輸入的數(shù)據(jù)不能包含本公司員工的真實(shí)姓名。 版面設(shè)置對于版面設(shè)置作如下規(guī)定：1. 紙張大小：用戶手冊用紙統(tǒng)一規(guī)定為16開。167。4) 對于雙號頁，頁眉的內(nèi)容是用戶手冊的名稱，要求打印在紙的左上角。2) 頁編號的字體采用Arial五號字。 注意與警告在用戶手冊中，對于那些需要用戶特別注意的事項(xiàng)，應(yīng)該用“【注意】”作為標(biāo)志給用戶以特別的提示。4. 如果注意事項(xiàng)只有一條，其內(nèi)容應(yīng)該緊跟在注意標(biāo)志的后面書寫；否則，應(yīng)該在注意標(biāo)志的下一行開始，采用編號序列的形式分別給出。如果標(biāo)有“〖條件〗”字樣，說明該部分內(nèi)容是在一定條件下所必須的。2. 對照軟件用戶手冊測試軟件功能是否與手冊描述一致。另一方面，良好的安裝說明及軟件功能與手冊描述的一致性是對軟件用戶手冊的兩個(gè)基本要求。用戶手冊不僅應(yīng)該包括我們的產(chǎn)品操作說明，而且還應(yīng)該包括系統(tǒng)（軟件和必要的硬件）安裝、數(shù)據(jù)維護(hù)、出錯(cuò)處理等。 用戶手冊的內(nèi)容167。其形式如下：EDD/AutoCAD R14 中科海鑫信息技術(shù)有限公司地址：沈陽市和平區(qū)三好街842號電話：(024)23841748 (024)23783000傳真：(024)23890817 (024)23782266客戶服務(wù)熱線：8008908000Email：Service167。3. 對我們的用戶手冊中所提到的各種商標(biāo)的版權(quán)聲明〖條件〗。 前言對于前言所應(yīng)包含的內(nèi)容經(jīng)常根據(jù)用戶手冊編寫人員的習(xí)慣不同而不同，有時(shí)僅僅包含了系統(tǒng)的開發(fā)背景和目的，有時(shí)還包含了系統(tǒng)簡介，有時(shí)甚至還包含了用戶手冊的閱讀指南。4. 如果本手冊不是該系統(tǒng)的第一個(gè)版本，還應(yīng)該簡介較上一版本的改進(jìn)部分。2. 閱讀對象：指明什么人員應(yīng)該閱讀該手冊，或什么人員應(yīng)該閱讀本手冊的哪些部分；閱讀對象在閱讀本手冊之前應(yīng)該掌握哪些知識，必要時(shí)應(yīng)給出資料清單，以便用戶查閱。必要時(shí)，應(yīng)該給出某些基本術(shù)語的定義。 目錄目錄的編寫要盡量詳盡。167。這些知識可以從有關(guān)書籍上得到，但是用戶從這些資料得到這些知識需要花費(fèi)相當(dāng)?shù)臅r(shí)間。167。如果必要，還應(yīng)包括輸入/輸出設(shè)備、通訊環(huán)境等。2. 系統(tǒng)的安裝對于不同的系統(tǒng)其安裝應(yīng)有所區(qū)別，一般來說，應(yīng)給出最終用戶能夠據(jù)此把軟件安裝到其操作系統(tǒng)并配置完成，且能成功運(yùn)行的任何信息和操作。對于網(wǎng)絡(luò)版軟件，應(yīng)對服務(wù)器端及客戶端的安裝分別予以介紹（可參考文檔管理系統(tǒng)SEAS2000AMS ）。? 系統(tǒng)配置〖條件〗：應(yīng)給出系統(tǒng)配置的詳細(xì)過程，以便用戶能夠順利操作系統(tǒng)。對于系統(tǒng)的安裝及啟動的結(jié)構(gòu)總結(jié)如下，供編寫用戶手冊時(shí)參考：|系統(tǒng)的運(yùn)行環(huán)境 |硬件環(huán)境| |軟件環(huán)境|系統(tǒng)的安裝及啟動 | |硬件安裝|系統(tǒng)的安裝 |軟件安裝| |系統(tǒng)的配置||系統(tǒng)的啟動167。167。所以，我們必須做到：1) 操作和命令：在用戶手冊中詳細(xì)給出各種操作的過程和功能、命令的格式和功能；應(yīng)當(dāng)描述在使用上的各種限制，如，操作狀態(tài)、操作條件、操作序列等。另外還應(yīng)當(dāng)說明對于這些信息所采取的操作。這些數(shù)據(jù)包括：1) 輸入數(shù)據(jù)〖條件〗：應(yīng)該給出數(shù)據(jù)的內(nèi)容、邏輯結(jié)構(gòu)、格式以及每一個(gè)數(shù)據(jù)元素的意思。5) 數(shù)據(jù)文件〖條件〗：如果要告訴用戶我們的軟件所使用的某些數(shù)據(jù)文件的結(jié)構(gòu)有助于用戶理解我們軟件的使用，則應(yīng)給予說明，但應(yīng)該注意技術(shù)保密。在此情況下，應(yīng)該以圖示方式對軟件的操作過程予以介紹。沒有必要為下拉菜單、快捷菜單等內(nèi)容截圖，因?yàn)檫@些操作都比較簡單，只要用語言敘述用戶即可明確其操作方法。2) 調(diào)用命令（選擇菜單、鍵入命令或點(diǎn)擊工具按鈕）。6) 結(jié)果界面（或結(jié)果提示行）。 其它軟件對于一些比較復(fù)雜的軟件，一般包括多個(gè)模塊。2. 執(zhí)行某一功能（選擇菜單或工具按鈕）。6. 結(jié)果界面。一些比較簡單的系統(tǒng)，如NetEye、OpenVideo等其系統(tǒng)操作比較簡單，操作說明內(nèi)容比較少。 系統(tǒng)及數(shù)據(jù)維護(hù)應(yīng)該給出用戶數(shù)據(jù)的備份、恢復(fù)、刪除、整理的詳細(xì)過程。167。有的人喜歡用比較深奧的概念和語言來說明問題，有的人喜歡用比較長的句子來表達(dá)思想，在編制用戶手冊的過程中這些都是不可取的。4. 用戶不一定是計(jì)算機(jī)專家：用戶手冊編寫人員應(yīng)該牢牢記住這一點(diǎn)，我們的大多數(shù)用戶都不是學(xué)計(jì)算機(jī)的，手冊中應(yīng)該盡量不使用較深奧的計(jì)算機(jī)術(shù)語。
公司管理相關(guān)推薦
鄂ICP備17016276號-1