用戶手冊編寫規(guī)范-閱讀頁
2025-04-27 08:02本頁面
【正文】 目 錄 第一章 前言1．1 內(nèi)容簡介1．2 主要功能1．3 操作流程1．4 基本概念 第二章 功能 1 2．1 使用流程 2．2 具體描述2．2．1 進行此功能的業(yè)務介紹2．2．2 操作步驟2．2．3 功能鍵、以及項目說明2．2．4 舉例2．2．5 特殊提示及注意事項。 。 。 。 。 。 。 。 。 。 。7 / 12 第 N 章 功能 n 附錄： 附錄 1 常用功能介紹 附錄 2 技術支持2．3．1 前言提供手冊的概述,在此可以說明編寫這份手冊的目的、指出本書適用的讀者。主要功能 是對該系統(tǒng)軟件進行的簡單講解，所完成的功能介紹?；靖拍? 基本概念：說明定義的術語在本手冊的含義。如果在使用說明中有相應的解釋，應指明用戶查找的位置。使用流程描述具體功能的使用順序。具體描述描述順序是按照使用流程的每一步進行的。2）操作步驟：用鼠標選擇相應的功能,進入相應的界面,進行功能鍵以及欄8 / 12目的介紹。4）特殊提示及注意事項在使用說明中，每一部分都會歸納一些問題,需要提示用戶或者讓用戶注意，應按照以下規(guī)定的格式進行編寫：格式：字體采用仿宋字，字號采用五號字舉例如下:注意： 憑 證 制作人和憑 證 復核人不能是同一個人2．3．3 附錄對一些在正文中描述不夠詳盡的地方，可在附錄中進行補充；或是用戶經(jīng)常遇到的問題及問題解答也可放在附錄中。內(nèi)容簡介：介紹本書提供的幾個部分：簡單介紹幾個部分的大概內(nèi)容。 注意：安裝過程中特殊注意的地方。2．4．2 單機版的安裝及配制運行環(huán)境 1）硬件環(huán)境：列出運行本軟件所要求的硬設備的最小配制。 顯示器要求： 以及一些其他的設備：I/O 設備 2）軟件環(huán)境：列出運行本軟件所需要的支持軟件 操作系統(tǒng) 程序語言以及數(shù)據(jù)庫管理系統(tǒng)安裝單機版的系統(tǒng)軟件 1）簡單介紹單機版打包光盤定義以及內(nèi)容。另外，運行軟件的時候，有時會出現(xiàn)數(shù)據(jù)庫聯(lián)結不成功。2．4．3 網(wǎng)絡版的安裝及配制運行環(huán)境除了對硬件環(huán)境提出要求外，對軟件環(huán)境的要求應列出運行本軟件所需的操作系統(tǒng)、與操作系統(tǒng)兼容的網(wǎng)絡環(huán)境、程序語言以及數(shù)據(jù)庫管理系統(tǒng)。安裝網(wǎng)絡版的系統(tǒng)軟件 1）介紹該軟件單機版的安裝步驟：2）如何進行系統(tǒng)環(huán)境配置；3）數(shù)據(jù)庫的默認用戶及口令等。在此說明技術支持的幾種方式，及常見安裝疑難解答。 。第二章 網(wǎng)絡操作系統(tǒng) 網(wǎng)絡操作系統(tǒng)的操作 網(wǎng)絡操作系統(tǒng)的維護 網(wǎng)絡操作系統(tǒng)的配置 。 。 。第四章 系統(tǒng)軟件的配置 。 。 。 。 。 。 前言部分概述系統(tǒng)管理員應該完成的任務，系統(tǒng)管理員應具備的知識，一11 / 12個稱職的系統(tǒng)管理員的所具有的素質(zhì)。3．編寫原則編寫原則是指是參與文檔編寫工作的人員如何編寫文檔，編寫需具備的過程。用戶手冊是最終提供給用戶的參考資料，必須結合需求分析以及軟件的生命周期的各個過程來進行編寫。文檔計劃一般包括以下幾方面內(nèi)容：1）列出應編制文檔的目錄；2）提示編制文檔應參考的標準；3）指定文檔管理員；4）提供編制文檔所需要的條件，落實文檔編寫人員、主管和所需經(jīng)費以及編制工具等； 5）明確保證文檔質(zhì)量的方法，為了確保文檔內(nèi)容的正確性、合理性，應采取一定的措施，如評審、審稿、鑒定等；6）繪制進度表，以圖表形式列出各階段應產(chǎn)生的文檔、編制人員、編制主管、編制日期、完成日期、評審日期等。 最后，文檔編寫人員應按照編寫大綱認真編寫文檔。
公司管理相關推薦
鄂ICP備17016276號-1