《軟件文檔管理指南》ppt課件-預(yù)覽頁(yè)
【正文】 品開發(fā)文件編制指南 ? GB/T 114571995 軟件工程術(shù)語(yǔ) 5 定義 ? 文檔 document ?一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)。 ? 文檔（集） / 文檔編制 documentation ?一個(gè)或多個(gè)相關(guān)文檔的集合。 ? 軟件產(chǎn)品 software product ?軟件開發(fā)過(guò)程的結(jié)果，并推出供用戶使用的軟件實(shí)體。 14 管理者的主要職責(zé) ? 建立編制、登記、出版系統(tǒng)文檔和軟件文檔的各種策略 ? 把文檔計(jì)劃作為整個(gè)開發(fā)工作的一個(gè)組成部分 ? 建立確定文檔質(zhì)量、測(cè)試質(zhì)量和評(píng)審質(zhì)量各種方法的規(guī)程 ? 為文檔的各個(gè)方面確定和準(zhǔn)備各種標(biāo)準(zhǔn)和指南 ? 積極支持文檔工作以形成開發(fā)中自覺(jué)編制文檔的團(tuán)隊(duì)風(fēng)氣 ? 不斷檢查已建立起來(lái)的過(guò)程，以保證符合策略和各種規(guī)程并遵守有關(guān)標(biāo)準(zhǔn)和指南 15 項(xiàng)目管理者在開發(fā)前應(yīng)決定的事項(xiàng) ? 要求哪些類型的文檔 ? 提供多少種文檔 ? 文檔包含的內(nèi)容 ? 達(dá)到何種級(jí)別的質(zhì)量水平 ? 何時(shí)產(chǎn)生何種文檔 ? 如何保存、維護(hù)文檔以及如何進(jìn)行通信 ? 如果一個(gè)軟件合同是有效的，應(yīng)要求文檔滿足所接受的標(biāo)準(zhǔn)，并規(guī)定所提供的文檔類型、每種文檔的質(zhì)量水平以及評(píng)審和通過(guò)的規(guī)程。 18 支持有效文檔策略的基本條件 ? 文檔需要覆蓋整個(gè)軟件生存期 ?在項(xiàng)目早期幾個(gè)階段就要求有文檔，而且在貫穿軟件開發(fā)過(guò)程中必須是可用的和可維護(hù)的。根據(jù)任務(wù)的執(zhí)行，他們要求不同的材料表示和不同的詳細(xì)程度。 ? 應(yīng)規(guī)定支持工具 ?工具有助于開發(fā)和維護(hù)軟件產(chǎn)品，包括文檔。 23 1. 選擇軟件生存期模型 ? 現(xiàn)有的一些軟件生存期模型，對(duì)于不同階段有不同的詞匯。相應(yīng)于特定階段生成的文檔可用作該階段的評(píng)審、通過(guò)和完成的檢驗(yàn)點(diǎn)，而這種檢驗(yàn)應(yīng)在下一階段開始前進(jìn)行。如果開發(fā)文檔丟失、不完整或過(guò)時(shí)，管理者將失去跟蹤和控制軟件項(xiàng)目的一個(gè)重要工具； ? 形成了維護(hù)人員所要求的基本的軟件支持文檔，而這些支持文檔可作為產(chǎn)品文檔的一部分； ? 記錄軟件開發(fā)的歷史。 ? 每個(gè)文檔的質(zhì)量必須在文檔計(jì)劃期間就有明確的規(guī)定。 ? 除 1級(jí)文檔提供的信息外， 2級(jí)文檔還包括程序清單內(nèi)足夠的注釋以幫助用戶安裝和使用程序。 ?文檔內(nèi)容可根據(jù)正確性、完整性和明確性來(lái)判斷 ?文檔結(jié)構(gòu)由各個(gè)組成部分的順序和總體安排的簡(jiǎn)單性來(lái)測(cè)定。 41 文檔編制計(jì)劃 ? 編制計(jì)劃的工作應(yīng)及早開始，對(duì)計(jì)劃的評(píng)審應(yīng)貫穿項(xiàng)目的全過(guò)程。 ? 文檔計(jì)劃還確定該計(jì)劃和文檔的分發(fā)，并且明確敘述與文檔工作的所有人員的職責(zé)。 49 文檔編寫注意要點(diǎn) ? 文檔編寫時(shí)間應(yīng)與軟件開發(fā)同步，在軟件生存期的每一個(gè)階段都應(yīng)完成相應(yīng)的文檔編寫工作 ? 按文檔計(jì)劃規(guī)定的文檔數(shù)量和質(zhì)量要求編寫文檔 ? 按 GB 8567或本單位指定標(biāo)準(zhǔn)內(nèi)容格式編寫相應(yīng)文檔 ? 文檔用紙的格式由各單位按有關(guān)標(biāo)準(zhǔn)規(guī)定執(zhí)行 ? 每個(gè)文檔必須裝訂成冊(cè)，并加封面和目次 ? 歸檔用的文檔還應(yīng)有扉頁(yè)，用于各責(zé)任者的簽署 50 3. 文檔編號(hào) ? 為便于管理，軟件文檔應(yīng)按編號(hào)法進(jìn)行編號(hào) ? 編號(hào)方法有十進(jìn)分類法、隸屬法等等，各單位可根據(jù)本單位實(shí)際情況確定一種編號(hào)方法 ? 不論何種方法，編號(hào)應(yīng)具有唯一性。 ? 例 : AB MX AB .005 MX 企業(yè)代號(hào) 級(jí)類型種 登記順序號(hào) 文件簡(jiǎn)號(hào) 52 隸屬編號(hào)法 ? 隸屬編號(hào) ,即按隸屬關(guān)系編號(hào) ,下級(jí)編號(hào)應(yīng)在其所屬上級(jí)的范圍內(nèi)編號(hào) 53 4. 文檔評(píng)審 ? 文檔評(píng)審十分重要，必須與技術(shù)評(píng)審結(jié)合起來(lái) ? 為了提高軟件產(chǎn)品的質(zhì)量，一個(gè)有效的方法就是在軟件開發(fā)的每個(gè)階段，對(duì)該階段所形成的文檔進(jìn)行嚴(yán)格的評(píng)審，這樣可盡早發(fā)現(xiàn)問(wèn)題，并及時(shí)采取措施予以解決，從而確保文檔內(nèi)容的正確性，避免或減少大的返工，同時(shí)為進(jìn)入下一階段的工作做好組織上和技術(shù)上的準(zhǔn)備。 ? 對(duì)所有描述開發(fā)工作和產(chǎn)品的文檔進(jìn)行評(píng)審是正規(guī)評(píng)審過(guò)程的組成部分?；趯?duì)系統(tǒng)要做些什么的共同理解，才能著手詳細(xì)設(shè)計(jì)。正規(guī)備忘錄提供一份有關(guān)所有會(huì)議的記錄。會(huì)簽僅在必要時(shí)才進(jìn)行。 61 6. 文檔歸檔與保管 ? 軟件產(chǎn)品的文檔是軟件開發(fā)過(guò)程的真實(shí)記錄 ,是重要的信息資源，因此必須實(shí)行集中統(tǒng)一管理，使之完善、安全并能有效地利用。這種非現(xiàn)場(chǎng)的保存應(yīng)儲(chǔ)藏所有開發(fā)文檔和產(chǎn)品文檔的后備副本。 64 7. 文檔維護(hù) ? 軟件產(chǎn)品在投入運(yùn)行后，往往還會(huì)有程序錯(cuò)誤、文檔錯(cuò)誤以及適應(yīng)新的環(huán)境和需求而要求增加或修改軟件及其相關(guān)文檔等情況。技術(shù)寫作和文檔技術(shù)方面的某些培訓(xùn)是必要的，也是有用的。這些可避免令人乏味地重復(fù)錄入草案材料，并且容許自動(dòng)地重新打印更新后的文檔。 ? 支持文檔編寫人員，他們使用的設(shè)備，以及文檔的保存、復(fù)制、分發(fā)和維護(hù)都需要資金，評(píng)審和更新需要花時(shí)
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1