-
文檔編制
鎖定
文檔編制要求
如果不重視文檔編寫工作,或是對文檔編寫工作的安排不當,就不可能得到高質量的文檔。質量差的文檔不僅使讀者難於理解,給使用者造成許多不便,而且會削弱對軟件的管理(難以確認和評價開發工作的進展情況),提高軟件成本(一些工作可能被迫返工),甚至造成更加有害的後果(如誤操作等)。
文檔編制針對性
文檔編制以前應分清讀者對象。按不同的類型、不同層次的讀者,決定怎樣適應他們的需要。例如,管理文檔主要是面向管理人員的,用户文檔主要是面向用户的,這兩類文檔不應像開發文檔(面向開發人員)那樣過多使用軟件的專用術語。
文檔編制精確性
文檔編制清晰性
文檔編寫應力求簡明,如有可能,配以適當的圖表,以增強其清晰性。
文檔編制完整性
文檔編制靈活性
各個不同軟件項目,其規模和複雜程度有着許多實際差別,能一律看待。
文檔編制文檔種類
應根據具體的軟件開發項目,決定編制的文檔種類。軟件開發的管理部門應該根據本單位承擔的應用軟件的專業領域和本單位的管理能力,制定一個對文檔編制要求的實施規定。主要是:在不同條件下,應該形成哪些文檔?這些文檔的詳細程度?該開發單位每一個項目負責人都應當認真執行這個實施規定。對於一個具體的應用軟件項目,項目負責人應根據上述實施規定,確定一個文檔編制計劃。其中包括:應該編制哪幾種文檔,詳細程度如何。各個文檔的編制負責人和進度要求。審查、批准的負責人和時間進度安排。在開發時期內文檔的維護、修改和管理的負責人,以及批准手續。有關的開發人員必須嚴格執行這個文檔編制計劃。
文檔編制文檔編寫
當所開發的軟件系統非常大時,一種文檔可以分成幾卷編寫。例如,項目開發計劃可分寫為:質量保證計劃、配置管理計劃、用户培訓計劃、安裝實施計劃等。系統設計説明書可分寫為:系統設計説明書、子系統設計説明書。程序設計説明書可分寫為:程序設計説明書、接口設計説明書、版本説明。操作手冊可分為:操作手冊、安裝實施過程。測試計劃可分寫為:測試計劃、測試設計説明、測試規程。報告可分寫為:綜合測試報告、驗收測試報告。項目開發總結報告也可分寫成:項目開發總結報告、資源環境統計。
文檔編制其他信息
2.對國標GB8567—88《計算機軟件產品開發文件編制指南》所建議的所有條款都可以擴展,進一步細分,以適應需要;反之,如果條款中有些細節並非必需,也可以根據實際情況壓縮合並。
4.對於文檔的表現形式,沒有規定或限制。可以使用自然語言、也可以使用形式化的語言。
5.當國標《計算機軟件產品開發文件編制指南》中所規定的文檔種類不能滿足某些應用部門的特殊需要時,可以建立一些特殊的文檔種類要求。這些要求可以包含在本單位的文檔編制實施規定中。
b.把衡量所得的各個因素的值相加,得總和之值。
c.根據總和之值,對錶表進行查找,確定應編制的文檔的種類。
(6)可追溯性:
- 詞條統計
-
- 瀏覽次數:次
- 編輯次數:12次歷史版本
- 最近更新: Lemon西厢