董淵Dec.20,2005

(SystemSoftware&SoftwareEngineering)

DepartmentofComputerScience&Technology

TsinghuaUniversity軟件工程

標準化和文檔

軟件工程標準化軟件工程標準的層次中國的軟件標準軟件文檔的作用與分類對文檔編制的質(zhì)量要求內(nèi)容提要軟件危機的出路在于軟件開發(fā)的工程化和標準化。程序設(shè)計語言的標準化：為某一程序設(shè)計語言規(guī)定若干個標準子集，對于語言的實現(xiàn)者和用戶都帶來了很大方便。軟件過程的標準化：軟件生存期各個階段的工作建立標準或規(guī)范。軟件工程標準化軟件工程標準化的作用可提高軟件的可靠性、可維護性和可移植性；可提高軟件人員的技術(shù)水平，減少差錯和誤解；可提高軟件人員之間的通信效率，提高軟件的生產(chǎn)率；有利于軟件管理；有利于降低軟件產(chǎn)品的成本和運行維護成本；有利于縮短軟件開發(fā)周期。軟件工程標準的層次(1)國際標準由國際聯(lián)合機構(gòu)制定和公布，提供各國參考的標準。

國際標準化組織

ISO

(InternationalStandardsOrganization)

這一國際機構(gòu)有著廣泛的代表性和權(quán)威性，它所公布的標準也有較大的影響。軟件工程標準的層次國際標準化組織

ISO成立于1947年2月宗旨：在世界上促進標準化及其相關(guān)活動的發(fā)展，以便于商品和服務(wù)的國際交換，在智力、科學(xué)、技術(shù)和經(jīng)濟領(lǐng)域開展合作。117個成員組織，2856個技術(shù)機構(gòu)已制定10300多個標準編號格式ISO+標準號+[斜杠+分標準號]+冒號+發(fā)布年份

ISO建立了“計算機與信息處理技術(shù)委員會”,簡稱ISO／TC97，專門負責(zé)與計算機有關(guān)的標準化工作。

這一標準通常冠有ISO字樣，如

ISO8631－86Informationprocessing_programconstructsandconventionsfortheirrepresentation《信息處理──程序構(gòu)造及其表示法的約定》。該標準現(xiàn)已由中國收入國家標準。(2)國家標準由政府或國家級的機構(gòu)制定或批準，適用于全國范圍的標準，如：

GB──中華人民共和國國家技術(shù)監(jiān)督局公布實施的標準，簡稱“國標”?，F(xiàn)已批準了若干軟件工程標準。

ANSI(AmericanNationalStandardsInstitute)──美國國家標準協(xié)會。是美國一些民間標準化組織的領(lǐng)導(dǎo)機構(gòu)，

FIPS(NBS)｛FederalInformationProcessingStandards(NationalBureauofStandards)｝──美國商務(wù)部國家標準局聯(lián)邦信息處理標準。

BS(BritishStandard)──英國國家標準。

DIN(DeutschesInstitutfürNor-mung)──德國標準協(xié)會

JIS(JapaneseIndustrialStandard)──日本工業(yè)標準(3)行業(yè)標準由行業(yè)機構(gòu)、學(xué)術(shù)團體或國防機構(gòu)制定，適用于某個業(yè)務(wù)領(lǐng)域的標準。

IEEE(InstituteofElectricalandElectronicsEngineers)──美國電氣與電子工程師學(xué)會。

該學(xué)會有一個軟件標準分技術(shù)委員會(SESS)，負責(zé)軟件標準化活動。IEEE公布的標準常冠有ANSI的字頭。例如，ANSI／IEEEStr828－1983《軟件配置管理計劃標準》。GJB──中華人民共和國國家軍用標準。這是由中國國防科工委批準，適合于國防部門和軍隊使用的標準。例如，GJB437－88《軍用軟件開發(fā)規(guī)范》。DOD_STD(DepartmentOfDefense_STanDards)──美國國防部標準，適用于美國國防部門。MIL_S(MILitary_Standard)──美國軍用標準，適用于美軍內(nèi)部。

OMG(ObjectManagementGroup)is

anopenmembership,not-for-profitconsortiumthatproducesandmaintainscomputerindustryspecificationsforinteroperableenterpriseapplications.

UML(UnifiedModelingLanguage)(4)企業(yè)規(guī)范一些大型企業(yè)或公司，由于軟件工程工作的需要，制定適用于本部門的規(guī)范。

例如，美國IBM公司通用產(chǎn)品部1984年制定的《程序設(shè)計開發(fā)指南》，僅供該公司內(nèi)部使用。(5)項目規(guī)范

由某一科研生產(chǎn)項目組織制定，為該項任務(wù)專用的軟件工程規(guī)范。中國的軟件標準

到2003年，中國全部現(xiàn)行有效的軟件工程規(guī)范國家標準共33項，并按照軟件工程標準體系的框架、結(jié)構(gòu)分為六大類：一專業(yè)基礎(chǔ)

GB/T11457-1995軟件工程術(shù)語

GB/T13702-1992計算機軟件分類與代碼

GB/T15539-1995軟件工程標準分類法二軟件過程

GB/T8566-2001信息技術(shù)軟件生存周期過程

GB/T8567-1988計算機軟件產(chǎn)品開發(fā)文件編制指南

GB/T9385-1988計算機軟件需求說明編制指南

GB/T9386-1988計算機軟件測試文件編制規(guī)范二軟件過程(續(xù))GB/T12505-1990計算機軟件配置管理計劃規(guī)范GB/T14079-1993軟件維護指南

GB/T15532-1995計算機軟件單元測試

GB/T16680-1996軟件文檔管理指南

GB/Z18493-2001信息技術(shù)軟件生存周期過程指南三軟件質(zhì)量

GB/T12504-1990計算機軟件質(zhì)量保證計劃規(guī)范

GB/T17544-1998信息技術(shù)軟件包質(zhì)量要求和測試

GB/T18491.1-2001信息技術(shù)軟件測量功能規(guī)模測量

GB/T18492-2001信息技術(shù)系統(tǒng)及軟件完整性級別四技術(shù)與管理

GB/T13423-1992工業(yè)控制用軟件評定準則第1部分：概念定義GB/T14394-1993計算機軟件可靠性和可維護性管理

GB/T16260-96信息技術(shù)軟件產(chǎn)品評價質(zhì)量特性及其使用指南

GB/T18905.1-2002軟件工程產(chǎn)品評價第1部分：概述

GB/T18905.2-2002軟件工程產(chǎn)品評價第2部分：策劃和管理四技術(shù)與管理(續(xù))

GB/T18905.3-2002軟件工程產(chǎn)品評價第3部分：開發(fā)者用的過程

GB/T18905.4-2002軟件工程產(chǎn)品評價第4部分：需方用的過程

GB/T18905.5-2002軟件工程產(chǎn)品評價第5部分：評價者用的過程

GB/T18905.6-2002軟件工程產(chǎn)品評價第6部分：評價模塊的文檔編制五工具與方法

GB/T15853-1995軟件支持環(huán)境

GB/Z18914-2002信息技術(shù)軟件工程CASE工具的采用指南

GB/T18234-2000信息技術(shù)CASE工具的評價與選擇指南六數(shù)據(jù)

GB/T1526-1989信息處理數(shù)據(jù)流程圖、程序流程圖、系統(tǒng)流程圖、程序網(wǎng)絡(luò)圖和系統(tǒng)資源圖的文件編制符號及約定

GB/T13502-1992信息處理程序構(gòu)造及其表示的約定

GB/T14085-1995信息處理系統(tǒng)計算機系統(tǒng)配置圖符號及約定

GB/T15535-1995信息處理單命中判定表規(guī)范

GB/T15697-1995信息處理按記錄組處理順序文卷的程序流程軟件文檔的作用與分類

文檔(document)是指某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。

它具有永久性，并可以由人或機器閱讀，通常僅用于描述人工可讀的東西。

在軟件工程中，文檔常常用來表示對活動、需求、過程或結(jié)果進行描述、定義、規(guī)定、報告或認證的任何書面或圖示的信息。在軟件生產(chǎn)過程中，總是產(chǎn)生和使用大量的信息。軟件文檔在產(chǎn)品的開發(fā)過程中起著重要的作用。

提高軟件開發(fā)過程的能見度。把開發(fā)過程中發(fā)生的事件以某種可閱讀的形式記錄在文檔中。

管理人員可把這些記載下來的材料作為檢查軟件開發(fā)進度和開發(fā)質(zhì)量的依據(jù)，實現(xiàn)對軟件開發(fā)的工程管理。

提高開發(fā)效率。軟件文檔的編制，使得開發(fā)人員對各個階段的工作都進行周密思考、全盤權(quán)衡、減少返工。并可在開發(fā)早期發(fā)現(xiàn)錯誤和不一致性，便于及時加以糾正。

作為開發(fā)人員在一定階段的工作成果和結(jié)束標志。

記錄開發(fā)過程中有關(guān)信息，便于協(xié)調(diào)以后的軟件開發(fā)、使用和維護。

提供對軟件的運行、維護和培訓(xùn)的有關(guān)信息，便于管理人員、開發(fā)人員、操作人員、用戶之間的協(xié)作、交流和了解。使軟件開發(fā)活動更科學(xué)、更有成效。

便于潛在用戶了解軟件的功能、性能等各項指標，為他們選購符合自己需要的軟件提供依據(jù)。文檔的橋梁作用計算機軟件開發(fā)人員項目管理人員用戶軟件維護人員從某種意義上來說，文檔是軟件開發(fā)規(guī)范的體現(xiàn)和指南。按規(guī)范要求生成一整套文檔的過程，就是按照軟件開發(fā)規(guī)范完成一個軟件開發(fā)的過程。所以，在使用工程化的原理和方法來指導(dǎo)軟件的開發(fā)和維護時，應(yīng)當充分注意軟件文檔的編制和管理。文檔的分類軟件文檔從形式上可分為兩類：

一類是開發(fā)過程中填寫的各種圖表，稱之為工作表格；

一類是應(yīng)編制的技術(shù)資料或技術(shù)管理資料，稱之為文檔或文件。軟件文檔的編制，可以用自然語言，特別設(shè)計的形式語言，介于兩者之間的半形式語言(結(jié)構(gòu)化語言)，各類圖形表示、表格來編制文檔。文檔可以書寫，也可以在計算機支持系統(tǒng)中產(chǎn)生，但必須可閱讀。按照文檔產(chǎn)生和使用的范圍，軟件文檔大致可分為三類：

開發(fā)文檔

軟件需求說明書

數(shù)據(jù)要求說明書

概要設(shè)計說明書

詳細設(shè)計說明書

可行性研究報告

項目開發(fā)計劃

管理文檔

項目開發(fā)計劃

測試計劃

測試報告

開發(fā)進度月報

項目開發(fā)總結(jié)

用戶文檔

用戶手冊

操作手冊

維護修改建議

軟件需求說明書軟件文檔的工作1988年發(fā)布了GB/T8567-1988計算機軟件產(chǎn)品開發(fā)文件編制指南作為軟件開發(fā)人員工作的準則和規(guī)程。它們基于軟件生存期方法，把軟件產(chǎn)品從形成概念開始，經(jīng)過開發(fā)、使用和不斷增補修訂，直到最后被淘汰的整個過程應(yīng)提交的文檔歸于以下十三種。可行性研究報告

說明該軟件項目的實現(xiàn)在技術(shù)上、經(jīng)濟上和社會因素上的可行性;

評述為合理地達到開發(fā)目標可供選擇的各種可能的實現(xiàn)方案;

說明并論證所選定實施方案的理由。項目開發(fā)計劃

為軟件項目實施方案制定出的具體計劃。它包括

各部分工作的負責(zé)人員

開發(fā)的進度

開發(fā)經(jīng)費的概算

所需的硬件和軟件資源等

項目開發(fā)計劃應(yīng)提供給管理部門，并作為開發(fā)階段評審的基礎(chǔ)。軟件需求說明書

對目標軟件的功能、性能、用戶界面及運行環(huán)境等作出詳細的說明。

它是用戶與開發(fā)人員雙方對軟件需求取得共同理解基礎(chǔ)上達成的協(xié)議，也是實施開發(fā)工作的基礎(chǔ)。數(shù)據(jù)要求說明書

給出數(shù)據(jù)邏輯描述和數(shù)據(jù)采集的各項要求,為生成和維護系統(tǒng)的數(shù)據(jù)文件做好準備。概要設(shè)計說明書

該說明書是概要設(shè)計工作階段的成果。它應(yīng)當說明

系統(tǒng)的功能分配

模塊劃分

程序的總體結(jié)構(gòu)

輸入輸出及接口設(shè)計

運行設(shè)計

數(shù)據(jù)結(jié)構(gòu)設(shè)計

出錯處理設(shè)計等

為詳細設(shè)計奠定基礎(chǔ)。詳細設(shè)計說明書

著重描述每一個模塊是如何實現(xiàn)的，包括實現(xiàn)算法、邏輯流程等。用戶手冊

詳細描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。操作手冊

為操作人員提供軟件各種運行情況的有關(guān)知識，特別是操作方法細節(jié)。測試計劃

針對組裝測試和確認測試，需要為組織測試制定計劃。計劃應(yīng)包括

測試的內(nèi)容

進度安排

條件

人員

測試用例的選取原則

測試結(jié)果允許的偏差范圍等測試分析報告

測試工作完成后，應(yīng)提交測試計劃執(zhí)行情況的說明。對測試結(jié)果加以分析，并提出測試的結(jié)論性意見。開發(fā)進度月報

該月報是軟件人員按月向管理部門提交的項目進展情況的報告。報告應(yīng)包括進度計劃與實際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。項目開發(fā)總結(jié)報告

軟件項目開發(fā)完成之后，應(yīng)當與項目實施計劃對照，總結(jié)實際執(zhí)行的情況，如進度、成果、資源利用、成本和投入的人力。

還需對開發(fā)工作作出評價，總結(jié)經(jīng)驗和教訓(xùn)。維護修改建議

軟件產(chǎn)品投入運行之后，可能有修正、更改等問題。應(yīng)當對存在的問題、修改的考慮以及修改的影響估計等做詳細的描述，寫成維護修改建議，提交審批。以上軟件文檔是在軟件生存期中，隨著各個階段工作的開展適時編制的。其中，有的僅反映某一個階段的工作，有的則需跨越多個階段。軟件生存期各階段與文檔關(guān)系文檔最終要向軟件管理部門，或向用戶回答下列問題

What

哪些需求要被滿足；

Where

軟件在什么環(huán)境中實現(xiàn)，所需信息從哪里來；

When

開發(fā)時間如何安排；

Who

開發(fā)(或維護)工作打算由誰來做；

How

需求應(yīng)如何實現(xiàn)；

Why

為什么要進行這些軟件開發(fā)或維護修改工作。文檔要回答的問題對文檔編制的質(zhì)量要求如果不重視文檔編寫工作，或是對文檔編寫工作的安排不當，就不可能得到高質(zhì)量的文檔。質(zhì)量差的文檔

使讀者難理解，給使用造成許多不便;

會削弱對軟件的管理（難以確認和評價開發(fā)工作的進展情況)，提高軟件成本(一些工作可能被迫返工);

造成誤操作;對編制高質(zhì)量文檔的要求(1)針對性

文檔編制以前應(yīng)分清讀者對象。按不同的類型、不同層次的讀者，決定怎樣適應(yīng)他們的需要。

管理文檔主要面向管理人員

用戶文檔主要面向用戶

這兩類文檔不應(yīng)像開發(fā)文檔(面向開發(fā)人員)那樣過多使用軟件的專用術(shù)語。(2)精確性

文檔的行文應(yīng)當十分確切，不能出現(xiàn)多義性的描述。同一課題幾個文檔的內(nèi)容應(yīng)當是協(xié)調(diào)一致，沒有矛盾的。(3)清晰性

文檔編寫應(yīng)力求簡明，如有可能，配以適當?shù)膱D表，以增強其清晰性。(4)完整性

任何一個文檔都應(yīng)當是完整的、獨立的，它應(yīng)自成體系。例如，前言部分應(yīng)做一般性介紹，正文給出中心內(nèi)容，必要時還有附錄，列出參考資料等。

同一課題的幾個文檔之間可能有些部分內(nèi)容相同，這種重復(fù)是必要的。

不要在文檔中出現(xiàn)轉(zhuǎn)引其它文檔內(nèi)容的情況。如，一些段落沒有具體描述，用“見××文檔××節(jié)”的方式.(5)靈活性 各個不同軟件項目，其規(guī)模和復(fù)雜程度有著許多實際差別，不能一律看待。應(yīng)根據(jù)具體的軟件開發(fā)項目，決定編制的文檔種類。

管理部門應(yīng)根據(jù)本單位承擔(dān)的應(yīng)用軟件的專業(yè)領(lǐng)域和本單位的管理能力，制定對文檔編制要求的實施規(guī)定。

對于一個具體的應(yīng)用軟件項目，項目負責(zé)人應(yīng)根據(jù)上述實施規(guī)定，確定一個文檔編制計劃。其中包括：

編制哪幾種文檔，詳細程度如何

各文檔的編制負責(zé)人和進度要求

審查/批準負責(zé)人和時間進度安排

在開發(fā)時期內(nèi)各文檔的維護、修改和管理的負責(zé)人，以及批準手續(xù)

有關(guān)的開發(fā)人員必須嚴格執(zhí)行這個文檔編制計劃。當所開發(fā)的軟件系統(tǒng)非常大時，一種文檔可以分成幾卷編寫。例如，