軟件文檔管理指南(2)

申請(qǐng)免費(fèi)試用、咨詢電話：400-8352-114

　　歷史檔案。軟件文檔可用作未來項(xiàng)目的一種資源。通常文檔記載系統(tǒng)的開發(fā)歷史，可使有關(guān)系統(tǒng)結(jié)構(gòu)的基本思想為以后的項(xiàng)目利用。系統(tǒng)開發(fā)人員通過審閱以前的系統(tǒng)以查明什么部分已試驗(yàn)過了，什么部分運(yùn)行得很好，什么部分因某種原因難以運(yùn)行而被排除。良好的系統(tǒng)文檔管理有助于把程序移植和轉(zhuǎn)移到各種新的系統(tǒng)環(huán)境中。

　　管理者的作用。管理者嚴(yán)格要求軟件開發(fā)人員和編制組完成文檔編制，并且在策略、標(biāo)準(zhǔn)、規(guī)程、資源分配和編制計(jì)劃方面給予支持。

　　制訂文檔編制策略：文檔策略是由上級(jí)(資深)管理者新任務(wù)并支持的，對(duì)下級(jí)開發(fā)單位或開發(fā)人員提供指導(dǎo)。策略規(guī)定主要的方向不是做什么或如何做的詳細(xì)說明。

　　選擇軟件生存期模型。現(xiàn)有的一些軟件生存期模型，對(duì)于不同的階段有不同的詞匯，從軟件文檔的觀點(diǎn)來看，采用哪種模型都無關(guān)緊要，只要階段和相應(yīng)的文檔是清晰定義的、已計(jì)劃的，并且對(duì)于任何具體軟件項(xiàng)目是能遵循的。因此，管理者應(yīng)選擇一個(gè)軟件生存期模型并保證該模型在他們機(jī)構(gòu)內(nèi)是適用的。

　　規(guī)定文檔類型和內(nèi)容。軟件文檔歸入如下三種類別：開發(fā)文檔——描述開發(fā)過程本身;產(chǎn)品文檔——描述開發(fā)過程的產(chǎn)物;管理文檔——記錄項(xiàng)目管理的信息。

　　開發(fā)文檔。是描述軟件開發(fā)過程，包括軟件需求、軟件設(shè)計(jì)、軟件測試、保證軟件質(zhì)量的一類文檔，開發(fā)文檔也包括軟件的詳細(xì)技術(shù)描述(程序邏輯、程序間相互關(guān)系、數(shù)據(jù)格式和存儲(chǔ)等)。開發(fā)文檔起到如下五種作用：它們是軟件開發(fā)過程中包含的所有階段之間的通信工具，它們記錄生成軟件需求、設(shè)計(jì)、編碼和測試的詳細(xì)規(guī)定和說明;它們描述開發(fā)小組的職責(zé)。通過規(guī)定軟件、主題事項(xiàng)、文檔編制、質(zhì)量保證人員以及包含在開發(fā)過程中任何其他事項(xiàng)的角色來定義做直截了當(dāng)、如何做和何時(shí)做;它們用作檢驗(yàn)點(diǎn)而允許管理者評(píng)定開發(fā)進(jìn)度。如果開發(fā)文檔丟失、不完整或過時(shí)，管理者將失去跟蹤和控制軟件項(xiàng)目的一個(gè)重要工具;它們形成了維護(hù)人員所要求的基本的軟件支持文檔。而這些支持文檔可作為產(chǎn)品文檔的一部分;它們記錄軟件開發(fā)的歷史。

　　基本的開發(fā)文檔是：可行性研究和項(xiàng)目任務(wù)書;需求規(guī)格說明;功能規(guī)格說明;設(shè)計(jì)規(guī)格說明，包括程序和數(shù)據(jù)規(guī)格說明;開發(fā)計(jì)劃;軟件集成和測試計(jì)劃;質(zhì)量保證計(jì)劃、標(biāo)準(zhǔn)、進(jìn)度;安全和測試信息。

　　產(chǎn)品。規(guī)定關(guān)于軟件產(chǎn)品的使用、維護(hù)、增強(qiáng)、轉(zhuǎn)換和傳輸?shù)男畔?。產(chǎn)品的文檔起到如下三種作用：為使用和運(yùn)行軟件產(chǎn)品的任何人規(guī)定培訓(xùn)和參考信息;使得那些未參加開發(fā)本軟件的程序員維護(hù)它;促進(jìn)軟件產(chǎn)品的市場流通或提高可接受性。

　　產(chǎn)品文檔用于下列類型的讀者：用戶;運(yùn)行者;維護(hù)人員。

　　產(chǎn)品文檔包括如下內(nèi)容：用于管理者的指南和資料，他們監(jiān)督軟件的使用;宣傳資料通告軟件產(chǎn)品的可用性并詳細(xì)說明它的功能、運(yùn)行環(huán)境等;般信息 對(duì)任何有興趣的人描述軟件產(chǎn)品。

　　基本的產(chǎn)品文檔包括：培訓(xùn)手冊(cè);參考手冊(cè)和用戶指南;軟件支持手冊(cè);產(chǎn)品手冊(cè)和信息廣告。

　　管理文檔。這種文檔建立在項(xiàng)目管理信息的基礎(chǔ)上，諸如：開發(fā)過程的每個(gè)階段的進(jìn)度和進(jìn)度變更的記錄;軟件變更情況的記錄;相對(duì)于開發(fā)的判定記錄職責(zé)定義。

　　確定文檔的質(zhì)量等級(jí)。僅僅依據(jù)規(guī)章、傳統(tǒng)的做法或合同的要求去制作文檔是不夠的。管理者還必須確定文檔的質(zhì)量要求以及如何達(dá)到和保證質(zhì)量要求。質(zhì)量要求的確定取決于可得到的資源、項(xiàng)目的大小和風(fēng)險(xiǎn)，可以對(duì)該產(chǎn)品的每個(gè)文檔的格式及詳細(xì)程度作出明確的規(guī)定。每個(gè)文檔的質(zhì)量必須在文檔計(jì)劃期間就有明確的規(guī)定。文檔的質(zhì)量可以按文檔的形式和列出的要墳劃分為四級(jí)。最低限度文檔(1級(jí)文檔);內(nèi)部文檔(2級(jí)文檔);工作文檔(3級(jí)文檔);正式文檔(4級(jí)文檔)。

　　文檔編制計(jì)劃。文檔計(jì)劃可以是整個(gè)項(xiàng)目計(jì)劃的一部分或是一個(gè)獨(dú)立的文檔。應(yīng)該編寫文檔計(jì)劃并把它分發(fā)給全體開發(fā)組成員，作為文檔重要性的具體依據(jù)和管理部門文檔工作責(zé)任的備忘錄。文檔計(jì)劃一般包括以下幾方面內(nèi)容：列出應(yīng)編制文檔的目錄;提示編制文檔應(yīng)參考的標(biāo)準(zhǔn);指定文檔管理員;提供編制文檔所需要的條件，落實(shí)文檔編寫人員、所需經(jīng)費(fèi)以及編制工具等;明確保證文檔質(zhì)量的方法，為了確保文檔內(nèi)容的正確性、合理性，應(yīng)采取一定的措施，如評(píng)審、鑒定等。