軟件公司用戶手冊編制規(guī)范-全文預(yù)覽
【正文】 目 錄 第一章 前言 1． 1 內(nèi)容簡介 1． 2 使用約定 第二章 單機(jī)版的安裝及配置 2． 1 運(yùn)行環(huán)境 2． 2 系統(tǒng)軟件的安裝 2． 3 安裝后的系統(tǒng)配置 第三章 網(wǎng)絡(luò) 版的安裝及配置 2． 1 運(yùn)行環(huán)境 2． 2 系統(tǒng)軟件的安裝 2． 3 安裝后的系統(tǒng)配置 附錄 附錄 1 安裝過程提供的技術(shù)支持 附錄 2 參考資料 2． 4． 1 前言 指明編制該手冊的目的，指明預(yù)期的讀者，簡介該系統(tǒng)軟件的操作系統(tǒng)，數(shù)據(jù)庫，c/s 體系結(jié)構(gòu)，界面特點(diǎn)，以及技術(shù)特色。 警告：指出危險動作或狀態(tài)，不注意這些，會對你的安裝造成破壞。 2） 介紹該軟件單機(jī)版 的安裝步驟： 安裝后的系統(tǒng)配置 介紹該軟件安裝完之后對配置信息的查看，以確定是否需要改動、是否是最優(yōu)配置；介紹系統(tǒng)配置的路徑、以及在何處可以用得上系統(tǒng)配置。 另外，還應(yīng)簡單介紹一下安裝網(wǎng)絡(luò)和數(shù)據(jù)庫所需注意事項(xiàng)和可參考的工具書。 附錄 2 參考資料，應(yīng)寫上書名、作者、出版社 中國最大的管理資源中心 第 12 頁 共 13 頁 2． 5 系統(tǒng)管理員手冊編制大綱 目錄 前言 第一章 硬件知識概述 網(wǎng)卡的安裝與配置 網(wǎng)絡(luò)問題的診斷 站點(diǎn)增加時的操作 。 參考資料：應(yīng)注明都參 考了那些資料，寫上書名、作者及出版社。 首先，文檔編寫主管應(yīng)在文檔編制需求提出后編寫文檔計劃 (文檔編制需求 )并把它分發(fā)給全體相關(guān)人員，作為文檔重要性的具體依據(jù)和管理部門文檔工作責(zé)任的備忘錄。 4．審核鑒定 保證文檔的質(zhì)量以及文檔內(nèi)容的正確性、合理性，應(yīng)對用戶手冊進(jìn)行評審和鑒定工作，提出改進(jìn)意見，以利整個文檔質(zhì)量的提高。 其次文檔編寫人員應(yīng)有一定的文字表達(dá)能力，而且應(yīng)明確用戶的真正需求，真正從用戶的角度考慮問題；文檔編寫人員還應(yīng)與程序員有相應(yīng)的交流，弄清程序員的編寫步驟，各個功能的 使用順序，弄清各個功能對應(yīng)的業(yè)務(wù)。 軟件的形成過程是經(jīng)過需求分析、軟件設(shè)計階段、編程階段、測試階段、運(yùn)行與維護(hù)階段，各個階段都必須有相應(yīng)的文檔編制。 第三章 數(shù)據(jù)庫管理 數(shù)據(jù)庫的安裝及維護(hù) 數(shù)據(jù)庫的配置 。 安裝后的系統(tǒng)配置 2． 4． 3 附錄 附錄 1 安裝過程提供的技術(shù)支持。在這部分介紹會有幾種原因，并分別簡述。 中國最大的管理資源中心 第 11 頁 共 13 頁 微機(jī)要求包括型號，內(nèi)存，硬盤。 使用約定 提示：提供安裝過程的一些好的方法。 3） 舉例：針對某一功能 ,對于一些比較難的問題 ,應(yīng)該進(jìn)行舉例說明。 如果功能之中有分類，比如，有些功能用戶用不到，有些用得到，就要分開寫流程。 步驟說明：針對操作流程的每一步進(jìn)行說明。 內(nèi)容簡介 簡單地介紹編寫的背景，系統(tǒng)適用的用戶。 作用：使系統(tǒng)管理員對系統(tǒng)有一個大概的了解，提高系統(tǒng)管理員的工作效率，減少系統(tǒng)出錯機(jī)率；減少服務(wù)人員的工作量。 安裝手冊 目的：用戶能正確地安裝軟件。 4） 正文的頁眉 用五號宋體，格式如下： 章節(jié)名稱 正文頁碼設(shè)置：位置為頁面底端（頁腳），對齊方式為外側(cè)。 3
公司管理相關(guān)推薦
鄂ICP備17016276號-1