信息技術有限公司用戶手冊編制規(guī)范(編輯修改稿)
2025-05-09 05:35 本頁面
【文章內(nèi)容簡介】 以特別的提示。關于注意標志和注意事項的格式有如下規(guī)定：1. 注意標志同與之對應的標題對齊。2. 注意標志采用黑體小四號漢字。3. 注意標志段前取12磅。4. 如果注意事項只有一條，其內(nèi)容應該緊跟在注意標志的后面書寫；否則，應該在注意標志的下一行開始，采用編號序列的形式分別給出。在用戶手冊中，對于那些會給用戶造成重大損失的行為，應該用“【警告】”作為標志給用戶以警告性的提示。【注意】關于警告標志和警告事項的格式規(guī)定與關于注意標志和注意事項的格式規(guī)定一致。第2章 用戶手冊的內(nèi)容本章主要討論編寫用戶手冊所要達到的目標、軟件用戶手冊所應包含的內(nèi)容、以及在用戶手冊編寫過程中所應保持的風格。如果標有“〖條件〗”字樣，說明該部分內(nèi)容是在一定條件下所必須的。 167。 用戶手冊的目標某軟件評測中心把軟件產(chǎn)品評測測試分為兩個階段——初評安裝測試和復評測試。只有通過初評安裝測試的軟件才能進入復評測試，初評安裝測試的內(nèi)容包括：1. 按照軟件用戶手冊中的安裝說明測試軟件能否順利安裝成功。2. 對照軟件用戶手冊測試軟件功能是否與手冊描述一致。3. 評價產(chǎn)品包裝及用戶手冊是否符合商品化要求。4. 通過以上三方面測試且無嚴重死機情況的軟件可進入復評測試。由此，我們可以看到軟件用戶手冊是一個軟件產(chǎn)品的基礎，沒有合格的軟件用戶手冊就根本談不上合格的軟件產(chǎn)品。另一方面，良好的安裝說明及軟件功能與手冊描述的一致性是對軟件用戶手冊的兩個基本要求。我們編寫的用戶手冊要達到兩個目的：1. 讓用戶手冊成為用戶學習使用我們產(chǎn)品的最好教材。用戶通過閱讀用戶手冊，應該對我們產(chǎn)品的功能、操作有一定的認識；按照用戶手冊上的說明，通過實際操作，用戶應該能夠掌握我們產(chǎn)品的操作過程。2. 讓用戶手冊能夠起到降低銷售費用的作用。用戶手冊不僅應該包括我們的產(chǎn)品操作說明，而且還應該包括系統(tǒng)（軟件和必要的硬件）安裝、數(shù)據(jù)維護、出錯處理等。通過用戶手冊，就可以讓用戶掌握在使用我們軟件的過程中出現(xiàn)各種情況的處理方法。為達到這兩個目標，在一般情況下，用戶手冊應該包含如下幾個方面的內(nèi)容：1. 封面2. 二封3. 版權4. 聲明5. 前言6. 閱讀指南7. 目錄8. 基礎知識介紹〖條件〗9. 系統(tǒng)安裝(包括必要的硬件安裝)及啟動10. 系統(tǒng)操作說明11. 系統(tǒng)及數(shù)據(jù)維護12. 例題〖條件〗13. 各種附錄【注意】如果本系統(tǒng)軟件是一個大系統(tǒng)，其系統(tǒng)安裝、操作說明、系統(tǒng)及數(shù)據(jù)維護都相當復雜，則可以把這三個部分分別編寫為一本甚至幾本用戶手冊，每本手冊都有自己的封面、版權聲明、前言、閱讀指南、目錄以及相應的基礎知識介紹和附錄。 167。 用戶手冊的內(nèi)容167。 封面封面內(nèi)容應包括公司的ICON、軟件名稱及版本號、公司名稱及手冊印刷時間。167。 二封二封正面為軟件名稱及版本號、公司名稱、手冊印刷時間、公司地址及服務電話等。，其形式如下：EDD/AutoCAD R14 中科海鑫信息技術有限公司地址：沈陽市和平區(qū)三好街842號電話：(024)23841748 (024)23783000傳真：(024)23890817 (024)23782266客戶服務熱線：8008908000Email：Service@167。 版權聲明版權聲明是保護我們所開發(fā)軟件的產(chǎn)權、不使我們公司利益受到損害的一種方式。在版權聲明中應該包括以下內(nèi)容：1. 對我們所提供的軟件及用戶手冊的保護聲明。2. 對我們的軟件及商標 所有權的聲明。3. 對我們的用戶手冊中所提到的各種商標的版權聲明〖條件〗。4. 我們不對用戶因為使用我們的軟件所造成的損失負責的聲明。具體請參考本規(guī)范的版權聲明。167。 前言對于前言所應包含的內(nèi)容經(jīng)常根據(jù)用戶手冊編寫人員的習慣不同而不同，有時僅僅包含了系統(tǒng)的開發(fā)背景和目的，有時還包含了系統(tǒng)簡介，有時甚至還包含了用戶手冊的閱讀指南。為了統(tǒng)一起見，在這里我們規(guī)定前言主要包括以下內(nèi)容：1. 系統(tǒng)的開發(fā)背景和目的。2. 系統(tǒng)所能應用的領域和使用對象。3. 系統(tǒng)的功能及特性簡介。4. 如果本手冊不是該系統(tǒng)的第一個版本，還應該簡介較上一版本的改進部分。167。 閱讀指南閱讀指南是每本(套)用戶手冊必不可少的組成部分，用戶通過它可以了解到用戶手冊的基本內(nèi)容；了解到應該如何、從哪兒開始閱讀該用戶手冊。用戶手冊的閱讀指南應該包含如下幾部分：1. 手冊目標：通過閱讀該用戶手冊，用戶應該或能夠達到什么目標。2. 閱讀對象：指明什么人員應該閱讀該手冊，或什么人員應該閱讀本手冊的哪些部分；閱讀對象在閱讀本手冊之前應該掌握哪些知識，必要時應給出資料清單，以便用戶查閱。3. 手冊構成：如果本系統(tǒng)的用戶手冊(包括管理員手冊、參考手冊)由幾本組成，首先應該分別簡要介紹這些手冊的情況。最根本的是應該介紹本手冊在哪一章或哪幾章講解了什么內(nèi)容，對于較大系統(tǒng)，如Universal Office ，分別介紹每一章內(nèi)容比較繁瑣，則可概括性地介紹。4. 手冊約定：這一部分應該包括字體的約定、特殊符號的約定以及【注意】、【警告】、【說明】等的含義。必要時，應該給出某些基本術語的定義。也可以把基本術語、概念的定義作為基礎知識來介紹。具體請參考本規(guī)范的閱讀指南。167。 目錄目錄的編寫要盡量詳盡。如果用戶手冊的內(nèi)容用到小節(jié)，則目錄就應該編寫到小節(jié)；如果用戶手冊的內(nèi)容用到小小節(jié)，則目錄就應該編寫到小小節(jié)。編寫用戶手冊目錄的目的就是為了讓用戶能
公司管理相關推薦
鄂ICP備17016276號-1