【正文】 上將軟件文檔大致分成兩類：軟件開發(fā)過程中需要填寫的各種圖表，及應(yīng)編制的各種技術(shù)文件或管理資料。 軟件文檔根據(jù)其產(chǎn)生和使用的范圍，主要劃分為 3 大類：開發(fā)文檔、用戶文檔和管理文檔。 一、開發(fā)文檔： 《功能要求》 來源于客戶要求和市場調(diào)查，是軟件開發(fā)中最早期的一個環(huán)節(jié)?？蛻籼岢鲆粋€模糊的功能概念，或者要求解決一個實(shí)際問題，或者參照同類軟件的一個功能。有軟件經(jīng)驗(yàn)的客戶還會提供比較詳細(xì)的技術(shù)規(guī)范書，把他們的要求全部列表書 寫在文檔中，必要時加以圖表解說。這份文檔是需求分析的基礎(chǔ)。 《投標(biāo)方案》 根據(jù)用戶的功能要求，經(jīng)過與招標(biāo)方溝通和確認(rèn)。 .《需求分析》 包括產(chǎn)品概述、主要概念、操作流程、功能列表和解說、注意事項(xiàng)、系統(tǒng)環(huán)境等。 《技術(shù)分析》 包括技術(shù)選型、技術(shù)比較、開發(fā)人員、關(guān)鍵技術(shù)問題的解決、技術(shù)風(fēng)險、技術(shù)升級方向、技術(shù)方案評價，競爭對手技術(shù)分析等。以《需求分析》為基礎(chǔ)，進(jìn)行詳細(xì)的技術(shù)分析，列出本項(xiàng)目需要使用什么技術(shù)方案，有哪些技術(shù)問題要解決 ，估計(jì)開發(fā)期間會碰到什么困難，技術(shù)方案以后如何升級， 對本項(xiàng)目的技術(shù)有什么評價等。 .《系統(tǒng)分析》 包括功能實(shí)現(xiàn)、模塊組成、功能流程圖、函數(shù)接口、數(shù)據(jù)字典、軟件開發(fā)需要考慮的各種問題等。以《需求分析》為基礎(chǔ)，進(jìn)行詳細(xì)的系統(tǒng)分析 (產(chǎn)品的開發(fā)和實(shí)現(xiàn)方法 )，估計(jì)開發(fā)期間需要把什么問題說明白，程序員根據(jù)《系統(tǒng)分析》，開始在項(xiàng)目主管的帶領(lǐng)下進(jìn)行編碼。 .《數(shù)據(jù)庫文檔》 包括數(shù)據(jù)庫名稱、表名、字段名、字段類型、字段說明、備注、字段數(shù)值計(jì)算公式等。以《系統(tǒng)分析》為基礎(chǔ)，進(jìn)行詳細(xì)的數(shù)據(jù)庫設(shè)計(jì)。必要時可以用圖表解說，特別是關(guān)系數(shù)據(jù)庫。 .《功能函數(shù)文檔》 包括變量名、變量初植、功能，函數(shù)名，參數(shù)，如何調(diào)用、遼 寧 工 業(yè) 大 學(xué) 綜 合 實(shí) 訓(xùn) 說 明 書（論 文） 3 備注、注意事項(xiàng)等。以《系統(tǒng)分析》為基礎(chǔ)，進(jìn)行詳細(xì)的說明，列出哪個功能涉及多少個函數(shù)，以便以后程序員修改、接手和擴(kuò)展。 .《界面文檔》 包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這里與軟件完成后的運(yùn)行界面是一致的。 《編譯手冊》 包括服務(wù)器編譯環(huán)境、操作系統(tǒng)、編譯工具、 GNU 的 C++編譯器版本信息、目錄說明、程序生成、源程序文件列表、 Makefile 配置及其相關(guān)程序的對應(yīng)關(guān)系列表。 《 QA 文檔 》 包括產(chǎn)品簡介、產(chǎn)品原理、產(chǎn)品功能列表、功能描述、功能流程、執(zhí)行結(jié)果、數(shù)據(jù)庫結(jié)構(gòu)、測試要求等，提供給軟件測試人員使用。 《項(xiàng)目總結(jié)》 包括項(xiàng)目簡介、項(xiàng)目參與人員和開發(fā)時間、項(xiàng)目風(fēng)險管理過程、項(xiàng)目功能列表、項(xiàng)目結(jié)構(gòu)特點(diǎn)、技術(shù)特點(diǎn)、對項(xiàng)目的升級建議、對以后的項(xiàng)目的建議、人員素質(zhì)情況等。 二、用戶文檔： 《產(chǎn)品簡介》 包括公司背景、產(chǎn)品概念、適用范圍、產(chǎn)品功能、功能特點(diǎn)、運(yùn)行要求和公司聯(lián)系地址。 《產(chǎn)品演示》 包括公司簡介、產(chǎn)品背景、產(chǎn)品描述、產(chǎn)品特點(diǎn)、產(chǎn)品作用、適用范圍、使 用分析、功能模塊、解決問題、合作伙伴、成功案例等。一般用 Power、point 或者 VCD 錄制軟件實(shí)現(xiàn)。 《疑問解答》 列出用戶關(guān)心的問題和處理方法。用于解答軟件的操作功能和解決用戶的疑難問題。 《功能介紹》 以《需求分析》為書寫基礎(chǔ)，包括軟件介紹、軟件結(jié)構(gòu)、功能列表、功能描述和公司聯(lián)系地址。 《技術(shù)白皮書》 以《技術(shù)分析》為書寫基礎(chǔ)，包括功能實(shí)現(xiàn)、技術(shù)選型、關(guān)鍵技術(shù)問題的解決、技術(shù)方案特點(diǎn)、技術(shù)升級方向等。 《評測報(bào)告》 第三方權(quán)威評測報(bào)告。包括評測目的、評測范圍、 評測環(huán)境、評測內(nèi)容、實(shí)測數(shù)據(jù)、性能表現(xiàn)、結(jié)果分析和評測總結(jié)等。 三、管理文檔： 《安裝手冊》 包括系統(tǒng)環(huán)境、運(yùn)行平臺、產(chǎn)品安裝過程、初始環(huán)境設(shè)置、安裝記錄等。 《使用手冊》 包括產(chǎn)品簡介、功能列表、功能描述和解釋、功能操作、客戶服務(wù)和聯(lián)系方式等。 《維護(hù)手冊》 包括產(chǎn)品簡介、系統(tǒng)須知、初始環(huán)境設(shè)置、系統(tǒng)配置、數(shù)據(jù)管理和備份、技術(shù)問題解答和聯(lián)系方式等。 《用戶報(bào)告》 包括產(chǎn)品簡介、購買時間、使用目的、使用時間、使用地點(diǎn)、實(shí)施過程、出現(xiàn)問題和解決、產(chǎn)品總結(jié)和建議等。 遼 寧 工 業(yè) 大 學(xué) 綜 合 實(shí) 訓(xùn) 說 明 書（論 文） 4 《銷售培訓(xùn)》 包括項(xiàng)目簡介、產(chǎn)品功能、產(chǎn)品特點(diǎn)、商業(yè)優(yōu)勢、系統(tǒng)運(yùn)行環(huán)境、適用范圍、目標(biāo)客戶等。 軟件文檔所采用的標(biāo)準(zhǔn) 參照其它工程領(lǐng)域?qū)こ虡?biāo)準(zhǔn)劃分的方法，軟件工程標(biāo)準(zhǔn)主要有兩種劃分方法：按標(biāo)準(zhǔn)的類型劃分和按標(biāo)準(zhǔn)的范圍劃分。 按標(biāo)準(zhǔn)的類型劃分： 按標(biāo)準(zhǔn)的類型劃分主要有過程標(biāo)準(zhǔn)、產(chǎn)品標(biāo)準(zhǔn)、行業(yè)標(biāo)準(zhǔn)、記法標(biāo)準(zhǔn)等。過程標(biāo)準(zhǔn)與開發(fā)一個產(chǎn)品或從事一項(xiàng)服務(wù)的一系列活動或操作有關(guān)。過程標(biāo)準(zhǔn)使用一組方法、工具和技術(shù)，給出“誰來做”、“做什么”、“如何做”、“何時做”、“何地做”及在軟件工程活動中進(jìn)行的 不同層次工作的過程模型。產(chǎn)品標(biāo)準(zhǔn)則涉及軟件工程事務(wù)的格式和內(nèi)容。軟件開發(fā)和維護(hù)活動文檔化的結(jié)果就是軟件產(chǎn)品，軟件文檔是軟件工程活動進(jìn)一步開展的基礎(chǔ)。軟件開發(fā)作為一種行業(yè)，其行業(yè)標(biāo)準(zhǔn)涉及軟件工程的所有方面，如職業(yè)認(rèn)證、職業(yè)培訓(xùn)、產(chǎn)品許可等。行業(yè)標(biāo)準(zhǔn)可以等同于行業(yè)行為規(guī)范。記法標(biāo)準(zhǔn)規(guī)定了在軟件工程行業(yè)范圍內(nèi)，以唯一的方式進(jìn)行交流的方法，如術(shù)語、表示法、語言等。它其實(shí)是一種語境規(guī)范。 按標(biāo)準(zhǔn)的范圍劃分： 按標(biāo)準(zhǔn)的范圍劃分主要是根據(jù)軟件的任務(wù)功能和軟件生存期進(jìn)行比較、判定、評價和確定軟件工程標(biāo)準(zhǔn)的范圍和內(nèi) 容。任務(wù)功能可以表示軟件工程過程，可以劃分為產(chǎn)品工程功能、驗(yàn)證與確認(rèn)功能以及技術(shù)管理功能 3 個部分。產(chǎn)品工程功能包括定義、生產(chǎn)和支持最終產(chǎn)品所必須的過程。驗(yàn)證和確認(rèn)功能是檢查產(chǎn)品質(zhì)量的活動。技術(shù)管理功能是構(gòu)造和控制產(chǎn)品工程的過程。這 3 個部分并不集中在單個的軟件生存周期里，而是并行進(jìn)行的生產(chǎn)、檢查和控制活動。 軟件文檔的主要內(nèi)容 我所做的軟件文檔是人力資源管理系統(tǒng)軟件文檔。人力資源管理系統(tǒng)軟件文檔包括人力資源管理系統(tǒng)操作手冊、人力資源管理系統(tǒng)測試計(jì)劃、人力資源管理系統(tǒng)概要設(shè)計(jì)說明書、人力資源管理系統(tǒng)可行 性分析報(bào)告、人力資源系統(tǒng)管理系統(tǒng)需求說明書、人力資源管理系統(tǒng)詳細(xì)設(shè)計(jì)說明書、人力資源管理系統(tǒng)項(xiàng)目計(jì)劃、人力資源管理系統(tǒng)項(xiàng)目總結(jié)報(bào)告、人力資源管理系統(tǒng)用戶手冊。 人力資源管理系統(tǒng)（ HRM）分為以下六大模塊：人事管理、工資管理、職位變更管理、離職管理、培訓(xùn)管理、輔助系統(tǒng)，各模塊的基本功能如下：