軟件公司用戶手冊(cè)編制規(guī)范-資料下載頁
2025-07-13 18:17本頁面
【導(dǎo)讀】程人員、文檔編制人員以及其他參與文檔工作的成員。
【正文】 ： 以及一些其他的設(shè)備： I/O設(shè)備 2）軟件環(huán)境：列出運(yùn)行本軟件所需要的支持軟件 操作系統(tǒng) 程序語言以及數(shù)據(jù)庫管理系統(tǒng) 安裝單機(jī)版的系統(tǒng)軟件 1） 簡單介紹單機(jī)版打包光盤定義以及內(nèi)容。 2） 介紹該軟件單機(jī)版 的安裝步驟： 安裝后的系統(tǒng)配置 介紹該軟件安裝完之后對(duì)配置信息的查看，以確定是否需要改動(dòng)、是否是最優(yōu)配置；介紹系統(tǒng)配置的路徑、以及在何處可以用得上系統(tǒng)配置。 另外，運(yùn)行軟件的時(shí)候，有時(shí)會(huì)出現(xiàn)數(shù)據(jù)庫聯(lián)結(jié)不成功。在這部分介紹會(huì)有幾種原因，并分別簡述。 2． 4． 3 網(wǎng)絡(luò)版的安裝及配制 運(yùn)行環(huán)境 除了對(duì)硬件環(huán)境提出要求外，對(duì)軟件環(huán)境的要求應(yīng)列出運(yùn)行本軟件所需的操作系統(tǒng)、與操作系統(tǒng)兼容的網(wǎng)絡(luò)環(huán)境、程序語言以及數(shù)據(jù)庫管理系統(tǒng)。 另外，還應(yīng)簡單介紹一下安裝網(wǎng)絡(luò)和數(shù)據(jù)庫所需注意事項(xiàng)和可參考的工具書。 安裝網(wǎng)絡(luò)版的系統(tǒng)軟件 1） 介紹該軟件單機(jī)版的安裝步驟： 2） 如何進(jìn)行系統(tǒng)環(huán)境配置； 3） 數(shù)據(jù)庫的默認(rèn)用戶及口令等。 安裝后的系統(tǒng)配置 2． 4． 3 附錄 附錄 1 安裝過程提供的技術(shù)支持。在此說明技術(shù)支持的幾種方式，及常見安裝疑難解答。 附錄 2 參考資料，應(yīng)寫上書名、作者、出版社 中國最大的管理資源中心 第 12 頁 共 13 頁 2． 5 系統(tǒng)管理員手冊(cè)編制大綱 目錄 前言 第一章 硬件知識(shí)概述 網(wǎng)卡的安裝與配置 網(wǎng)絡(luò)問題的診斷 站點(diǎn)增加時(shí)的操作 。 第二章 網(wǎng)絡(luò)操作系統(tǒng) 網(wǎng)絡(luò)操作系統(tǒng)的操作 網(wǎng)絡(luò)操作系統(tǒng)的維護(hù) 網(wǎng)絡(luò)操作系統(tǒng)的配置 。 第三章 數(shù)據(jù)庫管理 數(shù)據(jù)庫的安裝及維護(hù) 數(shù)據(jù)庫的配置 。 第四章 系統(tǒng)軟件的配置 。 。 前言部分概述系統(tǒng)管理員應(yīng)該完成的任務(wù)，系統(tǒng)管理員應(yīng)具備的知識(shí)，一個(gè)稱職的系統(tǒng)管理員的所具有的素質(zhì)。 參考資料：應(yīng)注明都參 考了那些資料，寫上書名、作者及出版社。 3．編寫原則 編寫原則是指是參與文檔編寫工作的人員如何編寫文檔，編寫需具備的過程。 軟件的形成過程是經(jīng)過需求分析、軟件設(shè)計(jì)階段、編程階段、測(cè)試階段、運(yùn)行與維護(hù)階段，各個(gè)階段都必須有相應(yīng)的文檔編制。用戶手冊(cè)是最終提供給用戶的參考資料，必須結(jié)合需求分析以及軟件的生命周期的各個(gè)過程來進(jìn)行編寫。 首先，文檔編寫主管應(yīng)在文檔編制需求提出后編寫文檔計(jì)劃 (文檔編制需求 )并把它分發(fā)給全體相關(guān)人員，作為文檔重要性的具體依據(jù)和管理部門文檔工作責(zé)任的備忘錄。文檔計(jì)劃一般包括以下幾方面內(nèi)容： 1） 列出應(yīng)編制文檔的目錄； 2） 提示編制文檔應(yīng)參考的標(biāo)準(zhǔn)； 3） 指定文檔管理員； 4） 提供編制文檔所需要的條件，落實(shí)文檔編寫人員、 主管和 所需經(jīng)費(fèi)以及編制工具等； 5） 明確保證文檔質(zhì)量的方法，為了確保文檔內(nèi)容的正確性、合理性，應(yīng)采取一定的措施，如評(píng)審、審稿、鑒定等； 中國最大的管理資源中心 第 13 頁 共 13 頁 6） 繪制進(jìn)度表，以圖表形式列出各階段應(yīng)產(chǎn)生的文檔、編制人員、編制 主管、編制日期、完成日期、評(píng)審日期等。 其次文檔編寫人員應(yīng)有一定的文字表達(dá)能力，而且應(yīng)明確用戶的真正需求，真正從用戶的角度考慮問題；文檔編寫人員還應(yīng)與程序員有相應(yīng)的交流，弄清程序員的編寫步驟，各個(gè)功能的 使用順序，弄清各個(gè)功能對(duì)應(yīng)的業(yè)務(wù)。 最后，文檔編寫人員應(yīng)按照編寫大綱認(rèn)真編寫文檔。 4．審核鑒定 保證文檔的質(zhì)量以及文檔內(nèi)容的正確性、合理性，應(yīng)對(duì)用戶手冊(cè)進(jìn)行評(píng)審和鑒定工作，提出改進(jìn)意見，以利整個(gè)文檔質(zhì)量的提高。
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1