【文章內(nèi)容簡介】 情況進(jìn)行設(shè)置，人員分工應(yīng)盡可能明確 ? 團(tuán)隊(duì)精神的重要性 ? 注重實(shí)用性 ? 持續(xù)的軟件過程改進(jìn) ? 軟件過程能力的不斷提高 ? 規(guī)范的建立與日益完善 ? 管理與技術(shù)水平的逐步提升 ? 其他 …… 軟件文檔體系 ? 軟件文檔與軟件文檔體系 ? 軟件文檔的作用 ? 軟件文檔標(biāo)準(zhǔn)化 ? 軟件文檔的分類 ? 軟件文檔的批準(zhǔn)與發(fā)布 ? 建議使用的文檔 ? 文檔編制誤區(qū)及應(yīng)對(duì)策略 軟件文檔體系 ? 什么是軟件文檔？ ? 指在軟件開發(fā)過程中，用來表示對(duì)活動(dòng)、需求、過程或結(jié)果進(jìn)行描述、定義、規(guī)定、報(bào)告的任何書面的文字或圖示信息的文檔。 ? 什么是軟件文檔體系？ ? 與軟件開發(fā)、應(yīng)用、維護(hù)等相關(guān)的所有文檔管理的 流程、規(guī)范與制度 。它管理的重點(diǎn)在于和軟件相關(guān)的文檔。 ? 常見誤區(qū) ? 文檔體系就是文檔類型描述或者文檔內(nèi)容格式 軟件文檔體系 ? 軟件文檔的作用 ? 是相關(guān)人員 溝通 工作的橋梁 ? 提高軟件開發(fā)過程的能見度 ? 提高開發(fā)效率 ? 可以作為階段性的 工作成果 提交，作為本階段結(jié)束的標(biāo)志 ? 執(zhí)行下階段工作的參考與依據(jù) ? 檢驗(yàn)與驗(yàn)收工作成果的標(biāo)準(zhǔn) ? 有利于后期的調(diào)試、維護(hù)工作的進(jìn)行 ? 有利于用戶了解軟件的功能、性能等各項(xiàng)指標(biāo)，成為用戶購買或驗(yàn)收的重要依據(jù) ? 是軟件開發(fā)組織的 財(cái)富 軟件文檔體系 ? 軟件文檔標(biāo)準(zhǔn)化 ? 為什么要使用標(biāo)準(zhǔn)？ ? 經(jīng)驗(yàn)的總結(jié)、規(guī)范化、交流的基礎(chǔ)、有效性 ? 文檔編制過程的相關(guān)標(biāo)準(zhǔn) ? ISO/IEC 軟件文檔管理指南 TR92942022 技術(shù)報(bào)告 ? GB 計(jì)算機(jī)軟件文檔編制規(guī)范 85672022 軟件文檔管理指南 166801996 ? GJB 軍用計(jì)算機(jī)軟件文檔編制格式和內(nèi)容 GJB 15661992 ? 美軍標(biāo) ? RUP的文檔體系 ? CMM/CMMI的文檔體系 軟件文檔體系 ? GB85672022中的文檔體系 ? 可行性分析（研究）報(bào)告 ? 軟件開發(fā)計(jì)劃 ? 軟件測試計(jì)劃 ? 軟件安裝計(jì)劃 ? 軟件移交計(jì)劃 ? 運(yùn)行概念說明 ? 系統(tǒng) /子系統(tǒng)需求規(guī)格說明 ? 接口需求規(guī)格說明 ? 系統(tǒng) /子系統(tǒng)設(shè)計(jì)（結(jié)構(gòu)設(shè)計(jì)）說明 ? 接口設(shè)計(jì)說明 ? 軟件需求規(guī)格說明 ? 數(shù)據(jù)需求說明 軟件文檔體系 ? 軟件（結(jié)構(gòu)）設(shè)計(jì)說明 ? 數(shù)據(jù)庫（頂層）設(shè)計(jì)說明 ? 軟件測試說明 ? 軟件測試報(bào)告 ? 軟件配置管理計(jì)劃 ? 軟件質(zhì)量保證計(jì)劃 ? 開發(fā)進(jìn)度月報(bào) ? 項(xiàng)目開發(fā)總結(jié)報(bào)告 ? 軟件產(chǎn)品規(guī)格說明 ? 軟件版本說明 ? 軟件用戶手冊(cè) ? 計(jì)算機(jī)操作手冊(cè) ? 計(jì)算機(jī)編程手冊(cè) 軟件文檔體系 ? 標(biāo)準(zhǔn)規(guī)范的特點(diǎn) ? 建議性、規(guī)范性、標(biāo)準(zhǔn)型 ? 大而全、泛化，缺乏針對(duì)性、偏重于技術(shù)文檔 ? 使用標(biāo)準(zhǔn)規(guī)范的重點(diǎn) ? 不要盲目完成所有要求的文檔內(nèi)容 ? 選擇最有效益的文檔形成本組織的文檔內(nèi)容 ? 不要為完成文檔而完成文檔 ? 標(biāo)準(zhǔn)是用來參考的，不是用來迷信的 ? 選擇標(biāo)準(zhǔn)規(guī)范的原則 ? 適用、適度、有效、可行、裁剪（針對(duì)文檔類型和文檔內(nèi)容，并非只剪不增） 軟件文檔體系 ? 文檔類型 —— 按產(chǎn)生和使用范圍分 ? 管理文檔 ? 項(xiàng)目管理制度、評(píng)審流程等 ? 技術(shù)文檔 ? 項(xiàng)目開發(fā)計(jì)劃、配置管理計(jì)劃、質(zhì)量保證計(jì)劃、軟件測試計(jì)劃 ? 可行性分析報(bào)告、需求說明、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)、界面設(shè)計(jì)、數(shù)據(jù)庫設(shè)計(jì) ? 測試報(bào)告、缺陷報(bào)告、實(shí)施報(bào)告 ? 用戶文檔 ? 使用手冊(cè)、操作手冊(cè) ? 文檔類型 —— 按軟件生命周期分 ? 需求文檔、設(shè)計(jì)文檔、測試文檔、驗(yàn)收文檔、管理文檔 軟件文檔體系 ? 軟件文檔的批準(zhǔn)與發(fā)布 ? 獲取文檔規(guī)范 ：命名、模板、范例、更新的通報(bào)機(jī)制 ? 編寫 ：遵守規(guī)范、無歧義、一致性（縱向一致、橫向一致，如需求變更 —設(shè)計(jì)變更 —測試變更 —用戶手冊(cè)變更） ? 評(píng)審 ：檢查格式與內(nèi)容、在里程碑處進(jìn)行，也可根據(jù)情況隨時(shí)進(jìn)行 ? 發(fā)布 ：權(quán)限控制、可訪問性、穩(wěn)定性（納入基線管理）、變更應(yīng)及時(shí)通報(bào) ? 文檔變更 ? 變更申請(qǐng) —變更評(píng)審 —變更記錄 —變更通知 —關(guān)聯(lián)性變更的完整性 ? 要保持文檔的一致性 ? 文檔與文檔之間、文檔與軟件之間 軟件文檔體系 ? 建議采納的文檔 ? 管理性文檔 ——將前述的管理規(guī)范形成文件 ? 開發(fā)規(guī)范 開發(fā)過程、編程規(guī)范等 ? 項(xiàng)目管理規(guī)范 計(jì)劃監(jiān)控、工作報(bào)告制度、相關(guān)工具等 ? 配置管理規(guī)范 配置管理流程、相關(guān)工具等 ? 質(zhì)量管理規(guī)范 軟件測試流程、缺陷管理流程、技術(shù)評(píng)審流程、質(zhì)量保證規(guī)范、相關(guān)工具等 ? 文檔管理規(guī)范 命名規(guī)范、文檔管理流程等 軟件文檔體系 ? 技術(shù)性文檔（續(xù)） ? 管理及過程文檔： 項(xiàng)目開發(fā)計(jì)劃 、 配置管理計(jì)劃 、質(zhì)量保證計(jì)劃 、 軟件測試計(jì)劃 、 項(xiàng)目計(jì)劃變更控制報(bào)告 、需求變更控制報(bào)告 、 項(xiàng)目會(huì)議記錄 ? 開發(fā)文檔 ? 需求文檔： 用戶需求說明書 、 軟件需求規(guī)格說明書 ? 設(shè)計(jì)文檔： 概要設(shè)計(jì)說明書 、 詳細(xì)設(shè)計(jì)說明書 、 數(shù)據(jù)庫設(shè)計(jì)說明書 ? 測試文檔： 測試用例 、 測試報(bào)告 、缺陷報(bào)告（可由缺陷管理系統(tǒng)自動(dòng)生成） ? 安裝、使用文檔： 用戶使用手冊(cè) 、 系統(tǒng)維護(hù)報(bào)告 軟件文檔體系 ? 文檔編制過程中的常見誤區(qū) ? 文檔中都是一些套話，缺乏有用的內(nèi)容 ? 寫文檔太花費(fèi)時(shí)間，得不償失 ? 文檔格式中很多項(xiàng)都不知道什么意思，不會(huì)寫 ? 想寫的內(nèi)容在文檔格式中找不到相應(yīng)的位置 ? 與其看文檔，不如直接找相關(guān)人員咨詢 ? 文檔誰寫的都一樣 ? 編寫文檔就是浪費(fèi)時(shí)間，就是應(yīng)付領(lǐng)導(dǎo)和用戶 ? 習(xí)慣于補(bǔ)文檔，而不是寫文檔 ? 技術(shù)文檔比管理文檔重要的多 軟件文檔體系 ? 文檔誤區(qū)應(yīng)對(duì)策略 ? 提高對(duì)文檔的認(rèn)識(shí)和理解 ? 創(chuàng)建有效的文檔體系結(jié)構(gòu) ? 制定合理的文檔結(jié)構(gòu) ? 提高文檔編制人員的能力 ? 有效的輔助工具 ? 良好的企業(yè)文化 ? 文檔格式標(biāo)準(zhǔn)化、文檔管理規(guī)范化 問 題 ? 您所在的軟件開發(fā)組織： ? 與雙軟認(rèn)定的要求有差距嗎？差距大嗎？ ? 軟件開發(fā)過程有沒有規(guī)范化？ ? 有沒有一套適合自己的軟件過程管理體系？健全嗎