《軟件工程》課件-第13章 軟件工程標(biāo)準(zhǔn)與文檔

第13章

軟件工程標(biāo)準(zhǔn)與文檔XX大學(xué)XX系XXX軟件工程教程電子科技大學(xué)出版社學(xué)習(xí)目標(biāo)l

理解軟件工程標(biāo)準(zhǔn)和文檔的定義；l

理解標(biāo)準(zhǔn)化的作用；l

理解軟件工程的國(guó)家標(biāo)準(zhǔn)；l

掌握軟件工程標(biāo)準(zhǔn)的類型、層次、制定與推行；l

掌握軟件文檔編寫的要求；l

了解軟件文檔的作用、分類、管理維護(hù)要求；l

了解軟件文檔撰寫規(guī)范指南。目錄01020304軟件工程標(biāo)準(zhǔn)軟件文檔與編寫要求軟件文檔撰寫規(guī)范指南本章小結(jié)軟件工程標(biāo)準(zhǔn)01軟件工程標(biāo)準(zhǔn)軟件工程標(biāo)準(zhǔn)化就是一種“語言”，這種語言更接近于普通話，既便于人機(jī)交互，又便于軟件開發(fā)的生存周期中，各階段工作的承上啟下以及不同人員之間的交流協(xié)作，進(jìn)而保證軟件質(zhì)量。實(shí)踐表明，采用先進(jìn)的程序設(shè)計(jì)技術(shù)既可以提高軟件的開發(fā)效率，又可以提高軟件的維護(hù)效率。隨著軟件工程學(xué)科的發(fā)展，人們對(duì)計(jì)算機(jī)軟件的認(rèn)識(shí)逐漸深入。軟件工作的范圍從只是使用程序設(shè)計(jì)語言編寫程序，擴(kuò)展到整個(gè)軟件生存期。軟件工程標(biāo)準(zhǔn)軟件工程標(biāo)準(zhǔn)的類型也是多方面的。它可能包括過程標(biāo)準(zhǔn)（如方法、技術(shù)、質(zhì)量等）、產(chǎn)品標(biāo)準(zhǔn)（如需求、設(shè)計(jì)、部件、描述、計(jì)劃、報(bào)告等）、專業(yè)標(biāo)準(zhǔn)（如職別、道德準(zhǔn)則、認(rèn)證、特許、課程等），以及記法標(biāo)準(zhǔn)（如術(shù)語、表示法、語言等）。FIPS135是美國(guó)國(guó)家標(biāo)準(zhǔn)局發(fā)布的《軟件文檔管理指南》

(National

Bureau

OfStandards，Guidelinefor

Software

Documentation

Management，F(xiàn)IPSPUB135，June1984)。軟件工程標(biāo)準(zhǔn)NSAC—39是美國(guó)核子安全分析中心發(fā)布的《安全參數(shù)顯示系統(tǒng)的驗(yàn)證與確認(rèn)》(NuclearSafetyAnalysisCenter，Verification

andValidation

forSafetyParameterDisplaySystems，NSAC-39，December1981)。ISO

5807是國(guó)際標(biāo)準(zhǔn)化組織公布(現(xiàn)已成為我國(guó)國(guó)家標(biāo)準(zhǔn))的《信息處理——數(shù)據(jù)流程圖、程序流程圖、系統(tǒng)流程圖、程序網(wǎng)絡(luò)圖和系統(tǒng)資源圖的文件編制符號(hào)及約定》。軟件工程標(biāo)準(zhǔn)軟件工程的標(biāo)準(zhǔn)化會(huì)給軟件工作帶來許多好處，比如：①可提高軟件的可靠性、可維護(hù)性和可移植性。②可提高軟件的生產(chǎn)率。③可提高軟件人員的技術(shù)水平。④可提高軟件人員之間的通信效率，減少差錯(cuò)和誤解。⑤

有利于軟件管理；有利于降低軟件產(chǎn)品的成本和運(yùn)行維護(hù)成本。⑥有利于縮短軟件開發(fā)周期。表13.3中國(guó)的軟件工程標(biāo)準(zhǔn)軟件工程標(biāo)準(zhǔn)①

GB/T

8567-2006計(jì)算機(jī)軟件文檔編制規(guī)范本標(biāo)準(zhǔn)根據(jù)GB/T

8566-2001《信息技術(shù)

軟件生存周期過程》的規(guī)定，主要對(duì)軟件的開發(fā)過程和管理過程應(yīng)編制的主要文檔及其編制的內(nèi)容、格式規(guī)定了基本要求。本標(biāo)準(zhǔn)原則上適用于所有類型的軟件產(chǎn)品的開發(fā)過程和管理過程。軟件工程標(biāo)準(zhǔn)本標(biāo)準(zhǔn)參考國(guó)際標(biāo)準(zhǔn)ISO/IEC

15910：1999《信息技術(shù)軟件用戶文檔過程》等標(biāo)準(zhǔn)制定的。該標(biāo)準(zhǔn)代替GB/T8567-1988《計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南》。軟件工程標(biāo)準(zhǔn)②

GB/T

11457-2006信息技術(shù)

軟件工程術(shù)語本標(biāo)準(zhǔn)定義了軟件工程領(lǐng)域中通用的術(shù)語。本標(biāo)準(zhǔn)適用于軟件開發(fā)、使用維護(hù)、科研、教學(xué)和出版等方面。本標(biāo)準(zhǔn)規(guī)定了軟件工程領(lǐng)域中的1859個(gè)中文術(shù)語，以及每個(gè)中文術(shù)語對(duì)應(yīng)的英文詞，還對(duì)每個(gè)術(shù)語給出了一個(gè)或一個(gè)以上的定義。標(biāo)準(zhǔn)最后附有英文索引和中文索引。軟件工程標(biāo)準(zhǔn)本標(biāo)準(zhǔn)是對(duì)GB/T

11457-1995《軟件工程術(shù)語》的修訂，并代替GB/T11457-1995標(biāo)準(zhǔn)。在GB/T

11457-1995中規(guī)定了軟件工程經(jīng)常用到的545個(gè)中文術(shù)語。本標(biāo)準(zhǔn)吸收了IEEE

Std

610.12.1990IEEEStandard

Glossar

y

of

Software

EngineeringTerminology中的全部術(shù)語，并參考了軟件工程有關(guān)標(biāo)準(zhǔn)方面的部分術(shù)語。軟件工程標(biāo)準(zhǔn)③

GB/T

16260.1-2006軟件工程產(chǎn)品質(zhì)量

第1部分：質(zhì)量模型該標(biāo)準(zhǔn)描述了關(guān)于軟件產(chǎn)品質(zhì)量的兩部分模型，即a）內(nèi)部質(zhì)量和外部質(zhì)量，b）使用質(zhì)量。該標(biāo)準(zhǔn)定義的特性適用于每一類軟件，包括固件中的計(jì)算機(jī)程序和數(shù)據(jù)。這些特性為確定軟件的質(zhì)量需求和權(quán)衡軟件產(chǎn)品的能力提供了一個(gè)框架。軟件工程標(biāo)準(zhǔn)該標(biāo)準(zhǔn)等同采用國(guó)際標(biāo)準(zhǔn)ISO/IEC

9126-1：2001。該標(biāo)準(zhǔn)代替國(guó)家標(biāo)準(zhǔn)GB/T

16260-1996《信息技術(shù)

軟件產(chǎn)品評(píng)價(jià)質(zhì)量特性及其使用指南》。軟件工程標(biāo)準(zhǔn)④

GB/T

16260.2-2006軟件工程產(chǎn)品質(zhì)量

第2部分：外部度量該標(biāo)準(zhǔn)定義了依據(jù)GB/T

16260.1定義的特性和子特性來定量測(cè)量軟件外部質(zhì)量的外部度量，主要包括如何使用軟件質(zhì)量度量的解釋、每個(gè)子特性的基本度量集、在軟件產(chǎn)品生存周期內(nèi)如何使用這些度量的實(shí)例。軟件工程標(biāo)準(zhǔn)該標(biāo)準(zhǔn)可用于各種應(yīng)用軟件，主要針對(duì)軟件產(chǎn)品的需方、評(píng)價(jià)者、開發(fā)者、維護(hù)者、供方、用戶質(zhì)量管理者使用。該標(biāo)準(zhǔn)等同采用國(guó)際標(biāo)準(zhǔn)ISO/IEC

9126-2：2003。軟件工程標(biāo)準(zhǔn)⑤

GB/T

16260.3-2006軟件工程產(chǎn)品質(zhì)量

第3部分：內(nèi)部度量該標(biāo)準(zhǔn)定義了依據(jù)GB/T

16260.1定義的特性和子特性來定量測(cè)量軟件內(nèi)部質(zhì)量的內(nèi)部度量，主要包括如何使用軟件質(zhì)量度量的解釋、每個(gè)子特性的基本度量集、在軟件產(chǎn)品生存周期內(nèi)如何使用這些度量的實(shí)例。軟件工程標(biāo)準(zhǔn)該標(biāo)準(zhǔn)可用于各種應(yīng)用軟件，主要針對(duì)軟件產(chǎn)品的需方、評(píng)價(jià)者、開發(fā)者、維護(hù)者、供方、用戶質(zhì)量管理者使用。該標(biāo)準(zhǔn)等同采用國(guó)際標(biāo)準(zhǔn)ISO/IEC

9126-3：2003。軟件工程標(biāo)準(zhǔn)⑥

GB/T

16260.4-2006軟件工程

產(chǎn)品質(zhì)量

第4部分：使用質(zhì)量的度量該標(biāo)準(zhǔn)為GB/T

16260.1中所規(guī)定的質(zhì)量特性定義了使用質(zhì)量的度量，主要包括如何使用軟件質(zhì)量度量的解釋、每個(gè)子特性的基本度量集、在軟件產(chǎn)品生存周期內(nèi)如何使用這些度量的實(shí)例。軟件工程標(biāo)準(zhǔn)該標(biāo)準(zhǔn)可用于各種應(yīng)用軟件，主要針對(duì)軟件產(chǎn)品的需方、評(píng)價(jià)者、開發(fā)者、維護(hù)者、供方、用戶質(zhì)量管理者使用。該標(biāo)準(zhǔn)等同采用國(guó)際標(biāo)準(zhǔn)ISO/IEC

9126-4：2004。軟件工程標(biāo)準(zhǔn)⑦

B/Z

20156-2006軟件工程軟件生成周期過程?用于項(xiàng)目管理的指南該標(biāo)準(zhǔn)論述的項(xiàng)目管理的各方面，它們或是“軟件特定的”，或是已知的在GB/T

8566-2001任一基本過程中引發(fā)軟件項(xiàng)目問題的，包括將GB/T

8566-2001的7.1中的管理活動(dòng)在每個(gè)基本過程中實(shí)施SPM進(jìn)行一般指導(dǎo)，軟件項(xiàng)目管理對(duì)每個(gè)基本過程的適用性，與軟件項(xiàng)目管理的范圍適當(dāng)交叉的關(guān)鍵域，針對(duì)某些管理任務(wù)為軟件項(xiàng)目經(jīng)理（PM）擴(kuò)充了指南。軟件工程標(biāo)準(zhǔn)該標(biāo)準(zhǔn)為負(fù)責(zé)管理GB/T8566-2001軟件生存周期基本過程：獲取、供應(yīng)、開發(fā)、運(yùn)作和維護(hù)的執(zhí)行的人員提供了指南。該標(biāo)準(zhǔn)修改采用國(guó)際標(biāo)準(zhǔn)ISO/IECTR16326：1999。軟件工程標(biāo)準(zhǔn)⑧

GB/T

20157-2006信息技術(shù)

軟件維護(hù)該標(biāo)準(zhǔn)比較詳細(xì)地描述GB/T8566所述的維護(hù)過程的管理；定義了各種維護(hù)類型，并且提供了在維護(hù)過程的策劃、執(zhí)行、控制、評(píng)審和評(píng)價(jià)以及結(jié)束等方面的應(yīng)用指南。本標(biāo)準(zhǔn)的范圍涉及到對(duì)于具有相同維護(hù)資源的多種軟件產(chǎn)品的維護(hù)。該標(biāo)準(zhǔn)等同采用國(guó)際標(biāo)準(zhǔn)ISO/IEC14764：1999。軟件工程標(biāo)準(zhǔn)⑨

GB/T

20158-2006信息技術(shù)

軟件生成周期過程

配置管理該標(biāo)準(zhǔn)是基于GB/T

8566的配置管理（CM）過程，規(guī)定了計(jì)算機(jī)軟件配置管理的實(shí)施要求，以用于軟件產(chǎn)品的開發(fā)、維護(hù)和運(yùn)行。軟件工程標(biāo)準(zhǔn)該標(biāo)準(zhǔn)適用于：任何形式的軟件；軟件產(chǎn)品的整個(gè)生存周期和生存周期內(nèi)的單個(gè)開發(fā)、維護(hù)和運(yùn)行項(xiàng)目，從分包商或銷售商獲得的軟件；軟件產(chǎn)品的供方和需方。適用于供、需雙方的情況，并且雙方屬于同一組織時(shí)也同樣適用。該標(biāo)準(zhǔn)等同采用國(guó)際標(biāo)準(zhǔn)ISO/IEC

15846：1998。軟件工程標(biāo)準(zhǔn)軟件工程標(biāo)準(zhǔn)的類型也是多方面的，根據(jù)中國(guó)國(guó)家標(biāo)準(zhǔn)GB/T15538－1995《軟件工程標(biāo)準(zhǔn)分類法》給出軟件工程標(biāo)準(zhǔn)的分類，涉及過程管理、產(chǎn)品管理、資源管理，以及確認(rèn)與驗(yàn)證。軟件工程標(biāo)準(zhǔn)的類型如下：”（1）過程標(biāo)準(zhǔn)。如方法、技術(shù)、度量等。（2）產(chǎn)品標(biāo)準(zhǔn)。如需求、設(shè)計(jì)、部件、描述、計(jì)劃、報(bào)告等。（3）專業(yè)標(biāo)準(zhǔn)。如職別、道德準(zhǔn)則、認(rèn)證、特許、課程等。（4）記法標(biāo)準(zhǔn)。如術(shù)語、表示法、語言等。軟件工程標(biāo)準(zhǔn)根據(jù)軟件工程標(biāo)準(zhǔn)制定的機(jī)構(gòu)和標(biāo)準(zhǔn)適用的范圍有所不同，它可分為五個(gè)級(jí)別，即國(guó)際標(biāo)準(zhǔn)、國(guó)家標(biāo)準(zhǔn)、行業(yè)標(biāo)準(zhǔn)、企業(yè)(機(jī)構(gòu))標(biāo)準(zhǔn)及項(xiàng)目(課題)標(biāo)準(zhǔn)。以下分別對(duì)五級(jí)標(biāo)準(zhǔn)的標(biāo)識(shí)符和標(biāo)準(zhǔn)制定(或批準(zhǔn))的機(jī)構(gòu)做一簡(jiǎn)要說明：”（1）國(guó)際標(biāo)準(zhǔn)由國(guó)際聯(lián)合機(jī)構(gòu)制定和公布，提供各國(guó)參考的標(biāo)準(zhǔn)。如ISO(InternationalStandards

Organization)──國(guó)際標(biāo)準(zhǔn)化組織。該標(biāo)準(zhǔn)現(xiàn)已由中國(guó)收入國(guó)家標(biāo)準(zhǔn)。軟件工程標(biāo)準(zhǔn)（2）國(guó)家標(biāo)準(zhǔn)由政府或國(guó)家級(jí)的機(jī)構(gòu)制定或批準(zhǔn)，適用于全國(guó)范圍的標(biāo)準(zhǔn)，如：①GB──中華人民共和國(guó)國(guó)家技術(shù)監(jiān)督局是中國(guó)的最高標(biāo)”準(zhǔn)化機(jī)構(gòu)，它所公布實(shí)施的標(biāo)準(zhǔn)簡(jiǎn)稱為“國(guó)標(biāo)”?，F(xiàn)已批準(zhǔn)了若干個(gè)軟件工程標(biāo)準(zhǔn)。②ANSI(AmericanNationalStandards

Institute)──美國(guó)國(guó)家標(biāo)準(zhǔn)協(xié)會(huì)。這是美國(guó)一些民間標(biāo)準(zhǔn)化組織的領(lǐng)導(dǎo)機(jī)構(gòu)，具有一定的權(quán)威性。軟件工程標(biāo)準(zhǔn)③

FIPS(NBS)

(Federal

Information

ProcessingStandards(National

Bureau

of

Standards))──美國(guó)商務(wù)部國(guó)家標(biāo)準(zhǔn)局聯(lián)邦信息處理標(biāo)準(zhǔn)。它所公布的標(biāo)”準(zhǔn)均冠有FIPS字樣。如1987年發(fā)表的FIPS

PUB132－87Guidelineforvalidationandverificationplanof

computersoftware

(軟件確認(rèn)與驗(yàn)證計(jì)劃指南)。軟件工程標(biāo)準(zhǔn)④BS(BritishStandard)──英國(guó)國(guó)家標(biāo)準(zhǔn)。⑤

DIN(DeutschesInstitut

für

Normung)──”德國(guó)標(biāo)準(zhǔn)協(xié)會(huì)。⑥

JIS(Japanese

Industrial

Standard)──日本工業(yè)標(biāo)準(zhǔn)。軟件工程標(biāo)準(zhǔn)（3）行業(yè)標(biāo)準(zhǔn)由行業(yè)機(jī)構(gòu)、學(xué)術(shù)團(tuán)體或國(guó)防機(jī)構(gòu)制定，并適用于某個(gè)業(yè)務(wù)領(lǐng)域的標(biāo)準(zhǔn)，如：”①

IEEE(Institute

of

Electrical

andElectronics

Engineers)──美國(guó)電氣與電子工程師學(xué)會(huì)。軟件工程標(biāo)準(zhǔn)②

GJB──中華人民共和國(guó)國(guó)家軍用標(biāo)準(zhǔn)。這是由中國(guó)國(guó)防科學(xué)技術(shù)工業(yè)委員會(huì)批準(zhǔn)，適合于國(guó)防部門和軍隊(duì)使用的標(biāo)準(zhǔn)。例如，1988年實(shí)施的GJB437－88《軍用軟件開發(fā)規(guī)范》；GJB438－88《軍用軟件文檔編制規(guī)范》?！雹?/p>

D

O

D

_

S

T

D

(

D

e

p

a

r

t

m

e

n

t

O

fDefense_STanDards)──美國(guó)國(guó)防部標(biāo)準(zhǔn)，適用于美國(guó)國(guó)防部門。④

MIL_S(MILitary_Standard)──美國(guó)軍用標(biāo)準(zhǔn)，適用于美軍內(nèi)部軟件工程標(biāo)準(zhǔn)（4）企業(yè)規(guī)范一些大型企業(yè)或公司，由于軟件工程工作的需要，制定適用于本部門的規(guī)范。例如，美國(guó)”IBM公司通用產(chǎn)品部(General

ProductsDivision)1984年制定的《程序設(shè)計(jì)開發(fā)指南》，僅供該公司內(nèi)部使用。軟件工程標(biāo)準(zhǔn)（5）項(xiàng)目規(guī)范由某一科研生產(chǎn)項(xiàng)目組織制定，且為該項(xiàng)”任務(wù)專用的軟件工程規(guī)范。例如，計(jì)算機(jī)集成制造系統(tǒng)(CIMS)的軟件工程規(guī)范。軟件工程標(biāo)準(zhǔn)軟件工程標(biāo)準(zhǔn)的制定與推行通常要經(jīng)歷一個(gè)環(huán)狀的生存周期,如圖13.1所示。最初，制定一”項(xiàng)標(biāo)準(zhǔn)僅僅是初步設(shè)想，經(jīng)發(fā)起后沿著環(huán)狀生存周期，順時(shí)針進(jìn)行要經(jīng)歷以下的步驟。軟件工程標(biāo)準(zhǔn)（1）建議——擬定初步的建議方案。（2）開發(fā)——制定標(biāo)準(zhǔn)的具體內(nèi)容。（3）咨詢——征求并吸取有關(guān)人員的意見?！保?）審批——由管理部門決定能夠推出。（5）公布——公開發(fā)布，使標(biāo)準(zhǔn)生效。軟件工程標(biāo)準(zhǔn)（6）培訓(xùn)——為推行標(biāo)準(zhǔn)準(zhǔn)備人員條件。（7）實(shí)施——投入使用，須經(jīng)歷相當(dāng)期限。（8）審核——檢驗(yàn)實(shí)施效果，決定修改還是”撤銷。（9）修訂——修改其中不適當(dāng)?shù)牟糠?，形成?biāo)準(zhǔn)的新版本，進(jìn)入新的周期。”圖13.1軟件工程標(biāo)準(zhǔn)的環(huán)狀生存期軟件工程標(biāo)準(zhǔn)為使標(biāo)準(zhǔn)逐步成熟，可能在換環(huán)狀生存周期上循環(huán)若干圈，需要做大量的工作。事實(shí)上，軟件工程標(biāo)準(zhǔn)在制定和推行的過程中還會(huì)遇到許多實(shí)際問”題。其中影響軟件工程標(biāo)準(zhǔn)順利實(shí)施的一些不利因素應(yīng)當(dāng)特別引起重視，這些影響因素可能有：（1）標(biāo)準(zhǔn)制定得有缺陷，或是存在不夠合理，不夠恰當(dāng)?shù)牟糠?。軟件工程?biāo)準(zhǔn)（2）標(biāo)準(zhǔn)文本編寫得有缺點(diǎn)。如文字?jǐn)⑹隹勺x性差、難于理解、缺少實(shí)例供讀者參閱。（3）主管部門未能堅(jiān)持大力推行，在實(shí)施過”程中遇到問題又未能及時(shí)加以解決。（4）未能及時(shí)做好宣傳、培訓(xùn)和實(shí)施指導(dǎo)。（5）未能及時(shí)修訂和更新。軟件文檔與編寫要求02軟件文檔與編寫要求軟件文檔在整個(gè)軟件生存周期的各個(gè)階段起到了重要的橋梁作用，可以說，沒有文檔”就沒有現(xiàn)代的軟件工程，我們必須高度重視軟件文檔技術(shù)的作用。軟件文檔與編寫要求（1）文檔的概念文檔是指某種數(shù)據(jù)媒體和其中記錄的數(shù)據(jù)。它具有永久性，并可以由人或機(jī)器閱讀?！蔽臋n也是軟件產(chǎn)品的一部分，沒有文檔的軟件就不稱其為軟件。軟件文檔的編址在軟件開發(fā)工作中占有突出的地位和相當(dāng)大的工作量。軟件文檔與編寫要求（2）文檔的作用軟件文檔在產(chǎn)品的開發(fā)生產(chǎn)過程中有重要的作用，具體如下：”①提高軟件開發(fā)過程的能見度。②提高開發(fā)效率。③

作為開發(fā)人員在一定階段的工作成果和結(jié)束標(biāo)志。軟件文檔與編寫要求④

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

提供對(duì)軟件的運(yùn)行、維護(hù)和培訓(xùn)的有關(guān)信息，便于管理人員、開發(fā)人員、操作人員、用”戶之間的協(xié)作、交流和了解。⑥

便于潛在用戶了解軟件的功能、性能等各項(xiàng)指標(biāo)，為他們選購符合自己需要的軟件提供依據(jù)。軟件文檔與編寫要求軟件文檔從形式上來看，大致可以分為兩類：一類是開發(fā)過程中填寫的各種圖表，可稱”之為工作表格；另一類是應(yīng)編制的技術(shù)資料或技術(shù)管理資料，可稱之為文檔或文件。軟件文檔與編寫要求①

開發(fā)文檔。這類文檔是在軟甲開發(fā)過程中，作為軟件開發(fā)人員前一階段工作成果的體現(xiàn)和后一階段工作依據(jù)的文檔。包括軟件啊需”求說明書、數(shù)據(jù)要求說明書、總體設(shè)計(jì)說明書、詳細(xì)設(shè)計(jì)說明書、可行性研究報(bào)告、項(xiàng)目開發(fā)計(jì)劃。軟件文檔與編寫要求②

管理文檔。這類文檔是在軟甲開發(fā)過程中，由軟件開發(fā)人員制定的需提交管理人員的一些工作計(jì)劃或工作報(bào)告。使管理人員能夠通過這些”文檔了解軟件開發(fā)項(xiàng)目安排、進(jìn)度、資源使用和成果等。包括項(xiàng)目開發(fā)計(jì)劃、測(cè)試計(jì)劃、測(cè)試報(bào)告、開發(fā)進(jìn)度月報(bào)及項(xiàng)目開發(fā)總結(jié)。軟件文檔與編寫要求③

用戶文檔。這類文檔是軟甲開發(fā)人員為用戶準(zhǔn)備的有關(guān)該軟件使用、操作、維護(hù)的資”料。包括用戶手冊(cè)、操作手冊(cè)、維護(hù)修改建議、軟件需求說明書。表13.4各類文檔內(nèi)容及軟件生存周期表13.4各類文檔內(nèi)容及軟件生存周期軟件文檔與編寫要求高質(zhì)量的文檔應(yīng)體現(xiàn)在以下幾個(gè)方面：（1）針對(duì)性。文檔編制以前應(yīng)分清讀者對(duì)象?！保?）精確性。文檔的行文應(yīng)當(dāng)十分確切，不能出現(xiàn)多義性的描述。軟件文檔與編寫要求（3）清晰性。文檔的編寫應(yīng)力求簡(jiǎn)明，如有可能，配以適當(dāng)?shù)膱D表，以增強(qiáng)其清晰性?！保?）完整性。任何一個(gè)文檔都應(yīng)當(dāng)是完整的、獨(dú)立的，它應(yīng)自成體系。軟件文檔與編寫要求（5）靈活性。各個(gè)不同軟件項(xiàng)目，其規(guī)模和復(fù)雜程度有著許多實(shí)際差別，不能一律看待。（6）

可追溯性。由于各開發(fā)階段編制的文檔與”各個(gè)階段完成的工作有密切的關(guān)系，前后兩個(gè)階段生成的文檔，隨著開發(fā)工作的逐步延伸，具有一定的繼承關(guān)系，在一個(gè)項(xiàng)目各開發(fā)階段之間提供的文檔必定存在著可追溯的關(guān)系。軟件文檔與編寫要求在整個(gè)軟件生存期中，各種文檔作為半成品或是最終產(chǎn)品，會(huì)不斷生成、修改或補(bǔ)充。為了”最終得到高質(zhì)量的產(chǎn)品，達(dá)到上面提出的質(zhì)量要求，必須按下面的要求加強(qiáng)對(duì)文檔的管理。軟件文檔與編寫要求（1）軟件開發(fā)小組應(yīng)設(shè)一位文檔保管員，負(fù)責(zé)集中保管本項(xiàng)目已有文檔的兩套主文本。這兩套主文本的內(nèi)容完全一致。其中一套可按一定手續(xù)辦理借閱?！保?）軟件開發(fā)小組的成員可根據(jù)工作需要在自己手中保存一些個(gè)人文檔。這些一般都應(yīng)是主文本的復(fù)制件，并注意與主文本保持一致，在做必要的修改時(shí)，也應(yīng)先修改主文本。軟件文檔與編寫要求（3）開發(fā)人員個(gè)人只保存著主文本中與他工作有關(guān)的部分文檔。（4）在新文檔取代舊文檔時(shí)，管理人員應(yīng)及”時(shí)注銷舊文檔。在文檔的內(nèi)容有更動(dòng)時(shí)，管理人員應(yīng)隨時(shí)修訂主文本，使其及時(shí)反映更新了的內(nèi)容。軟件文檔與編寫要求（5）項(xiàng)目開發(fā)結(jié)束時(shí)，文檔管理人員應(yīng)收回開發(fā)人員的個(gè)人文檔。發(fā)現(xiàn)個(gè)人文檔與主文檔有差別時(shí)，應(yīng)立即著手解決。這往往是在開發(fā)過程中沒有及時(shí)修訂主文本造成的?！保?）在軟件開發(fā)過程中，可能發(fā)現(xiàn)需要修改已完成的文檔。修改以前要充分估計(jì)修改可能帶來的影響，并且要按照如下步驟加以嚴(yán)格的控制：提議→評(píng)議→審核→批準(zhǔn)→實(shí)施。軟件文檔撰寫規(guī)范指南03軟件文檔撰寫規(guī)范指南在項(xiàng)目開發(fā)過程中，應(yīng)該按要求編寫好十三種文檔，文檔編制要求具有針對(duì)性、精確性、清晰性、完整性、靈活性、可追溯性。(文檔的模板看書)（1）可行性分析報(bào)告。說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會(huì)因素上的可行性，評(píng)述為了合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實(shí)施方案，說明并論證所選定實(shí)施方案的理由。軟件文檔撰寫規(guī)范指南（2）項(xiàng)目開發(fā)計(jì)劃。為軟件項(xiàng)目實(shí)施方案制訂出具體計(jì)劃，應(yīng)該包括各部分工作的負(fù)責(zé)人員、開發(fā)的進(jìn)度、開發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等。（3）軟件需求說明書（軟件規(guī)格說明書）。對(duì)所開發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說明。它是在用戶與開發(fā)人員雙方對(duì)軟件需求取得共同理解并達(dá)成協(xié)議的條件下編寫的，也是實(shí)施開發(fā)工作的基礎(chǔ)。該說明書應(yīng)給出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項(xiàng)要求，為生成和維護(hù)系統(tǒng)數(shù)據(jù)文件做好準(zhǔn)備。軟件文檔撰寫規(guī)范指南（4）概要設(shè)計(jì)說明書。該說明書是概要實(shí)際階段的工作成果，它應(yīng)說明