普通高等教育"十一五"國(guó)家級(jí)規(guī)劃教材

前言

　　軟件開(kāi)發(fā)是一個(gè)把用戶(hù)需要轉(zhuǎn)化為軟件需求，把軟件需求轉(zhuǎn)化為軟件設(shè)計(jì)，用軟件代碼來(lái)實(shí)現(xiàn)軟件設(shè)計(jì)，對(duì)軟件代碼進(jìn)行測(cè)試，交付并投入運(yùn)行的過(guò)程。在這個(gè)過(guò)程中的每一階段，都需要編寫(xiě)相應(yīng)的文檔。文檔的編寫(xiě)是軟件開(kāi)發(fā)過(guò)程中的重要工作，是工程化方法的重要體現(xiàn).符合要求的、規(guī)范化的文檔在軟件開(kāi)發(fā)中起著表達(dá)思想、傳遞信息的重要作用，是保證軟件開(kāi)發(fā)質(zhì)量、提高軟件可維護(hù)性、可靠性和可生產(chǎn)性的重要措施?！　”緯?shū)遵循國(guó)家和國(guó)際有關(guān)計(jì)算機(jī)軟件開(kāi)發(fā)文檔編制的標(biāo)準(zhǔn)和規(guī)范，從基于結(jié)構(gòu)化方法和面向?qū)ο蠓椒▋蓚€(gè)方面，從應(yīng)用的角度，詳細(xì)地探討了軟件開(kāi)發(fā)過(guò)程中《可行性研究報(bào)告》、《軟件需求規(guī)格說(shuō)明書(shū)》、《概要設(shè)計(jì)說(shuō)明書(shū)》和《詳細(xì)設(shè)計(jì)說(shuō)明書(shū)》等幾個(gè)重要文檔的編寫(xiě)要求與方法，強(qiáng)調(diào)了CASE工具在文檔編寫(xiě)過(guò)程中的作用，并給出基于CASE工具支持的文檔編寫(xiě)實(shí)例?！　∥覀兲貏e強(qiáng)調(diào)，“軟件文檔編寫(xiě)”本質(zhì)上是一門(mén)實(shí)踐性很強(qiáng)的課程。使用本書(shū)作為教材時(shí)，課堂教學(xué)和實(shí)驗(yàn)環(huán)節(jié)參考學(xué)時(shí)分配如下表所示。

內(nèi)容概要

　　《軟件文檔寫(xiě)作》遵循國(guó)家有關(guān)計(jì)算機(jī)軟件開(kāi)發(fā)文檔編制的標(biāo)準(zhǔn)和規(guī)范，從基于結(jié)構(gòu)化方法和面向?qū)ο蠓椒▋蓚€(gè)方面，介紹了可行性研究報(bào)告、軟件需求規(guī)格說(shuō)明書(shū)、概要設(shè)計(jì)說(shuō)明書(shū)、詳細(xì)設(shè)計(jì)說(shuō)明書(shū)、軟件測(cè)試說(shuō)明書(shū)等幾個(gè)重要的軟件開(kāi)發(fā)文檔的編寫(xiě)要求與方法，強(qiáng)調(diào)了CASE工具在文檔編寫(xiě)過(guò)程中的作用，并給出了軟件文檔編寫(xiě)的詳細(xì)實(shí)例?！盾浖臋n寫(xiě)作》可作為應(yīng)用型、技能型人才培養(yǎng)的各類(lèi)教育相關(guān)專(zhuān)業(yè)“軟件工程”、“軟件文檔寫(xiě)作”課程的教學(xué)用書(shū)，也可供參加各類(lèi)培訓(xùn)的人員、計(jì)算機(jī)從業(yè)人員和愛(ài)好者參考。

書(shū)籍目錄

第1章 軟件工程標(biāo)準(zhǔn)化與軟件文檔1.1 軟件生存周期與軟件文檔1.2 軟件文檔的作用1.3 軟件文檔分類(lèi)1.3.1 開(kāi)發(fā)文檔1.3.2 產(chǎn)品文檔1.3.3 管理文檔1.4 軟件工程標(biāo)準(zhǔn)化1.4.1 軟件工程標(biāo)準(zhǔn)化的意義1.4.2 軟件工程標(biāo)準(zhǔn)的層次1.4.3 中國(guó)的軟件標(biāo)準(zhǔn)1.4.4 五種常見(jiàn)的國(guó)際軟件標(biāo)準(zhǔn)1.5 軟件文檔編寫(xiě)要求1.5.1 軟件文檔的編寫(xiě)原則1.5.2 文檔編寫(xiě)的靈活性1.5.3 制定文檔編寫(xiě)策略1.5.4 建立企業(yè)的文檔標(biāo)準(zhǔn)1.5.5 制訂文檔編寫(xiě)計(jì)劃1.5.6 建立文檔管理規(guī)程1.5.7 軟件文檔的質(zhì)量要求1.6 項(xiàng)目開(kāi)發(fā)的文檔化本章小結(jié)習(xí)題第2章 CASE工具與軟件文檔編寫(xiě)2.1 CAsE概述2.2 CAsE支持下的軟件建模和文檔編寫(xiě)工具2.2.1 ProccssAnalYst和DataArchitcCt2.2.2 SoDA自動(dòng)化文檔設(shè)計(jì)和生成2.2.3 P!ayCASE本章小結(jié)習(xí)題第3章 可行性研究報(bào)告3.1 可行性研究概述3.1.1 可行性研究的任務(wù)3.1.2 可行性研究的步驟3.2 可行性研究報(bào)告的內(nèi)容要求與編寫(xiě)指南3.2.1 可行性研究報(bào)告的引言3.2.2 可行性研究的前提3.2.3 對(duì)現(xiàn)有系統(tǒng)的分析3.2.4 對(duì)所建議系統(tǒng)的分析3.2.5 可行性分析3.2.6 可行性分析結(jié)論3.3 可行性研究報(bào)告編寫(xiě)示例本章小節(jié)習(xí)題實(shí)訓(xùn)第4章 基于結(jié)構(gòu)化方法的軟件文檔4.1 軟件需求規(guī)格說(shuō)明書(shū)4.1.1 需求分析概述4.1.2 軟件需求規(guī)格說(shuō)明書(shū)的目的和編寫(xiě)要求4.1.3 軟件需求規(guī)格說(shuō)明書(shū)的內(nèi)容要求與編寫(xiě)指南4.1.4 軟件需求規(guī)格說(shuō)明書(shū)示例4.2 概要設(shè)計(jì)說(shuō)明書(shū)4.2.1 概要設(shè)計(jì)概述4.2.2 概要設(shè)計(jì)說(shuō)明書(shū)的內(nèi)容要求與編寫(xiě)指南4.2.3 概要設(shè)計(jì)說(shuō)明書(shū)示例4.3 詳細(xì)設(shè)計(jì)說(shuō)明書(shū)4.3.1 詳細(xì)設(shè)計(jì)概述4.3.2 詳細(xì)設(shè)計(jì)說(shuō)明書(shū)的內(nèi)容要求和編寫(xiě)指南4.3.3 詳細(xì)設(shè)計(jì)說(shuō)明書(shū)示例本章小結(jié)習(xí)題實(shí)訓(xùn)第5章 基于面向?qū)ο蠓椒ǖ能浖枨笠?guī)格說(shuō)明書(shū)5.1 面向?qū)ο蟮能浖枨蠓治龈攀?.2 軟件需求規(guī)格說(shuō)明書(shū)的內(nèi)容要求與編寫(xiě)指南5.2.1 引言5.2.2 項(xiàng)目概述5.2.3 需求規(guī)定5.3 用例說(shuō)明書(shū)的內(nèi)容及編寫(xiě)要點(diǎn)5.4 基于面向?qū)ο蠓椒ǖ能浖枨笠?guī)格說(shuō)明書(shū)示例本章小結(jié)習(xí)題實(shí)訓(xùn)第6章 基于面向?qū)ο蠓椒ǖ能浖O(shè)計(jì)說(shuō)明書(shū)6.1 面向?qū)ο筌浖O(shè)計(jì)概述6.2 面向?qū)ο蟮能浖O(shè)計(jì)說(shuō)明書(shū)的內(nèi)容要求和編寫(xiě)指南6.2.1 類(lèi)報(bào)告6.2.2 用例實(shí)現(xiàn)報(bào)告6.2.3 設(shè)計(jì)模型報(bào)告6.3 面向?qū)ο笤O(shè)計(jì)文檔的編寫(xiě)示例本章小結(jié)實(shí)訓(xùn)第7章 程序代碼的文檔化7.1 程序代碼規(guī)范7.2 Doxygen應(yīng)用基礎(chǔ)7.2.1 安裝Doxygen7.2.2 設(shè)置項(xiàng)目的Doxygen配置文件模板7.2 ‘3編寫(xiě)正確格式的注釋7.2.4 制作說(shuō)明文件7.2.5 Doxygen使用步驟及范例本章小結(jié)習(xí)題實(shí)訓(xùn)第8章 面向?qū)ο鬁y(cè)試文檔8.1 面向?qū)ο鬁y(cè)試概述8.1.1 面向?qū)ο鬁y(cè)試的具體任務(wù)8.1.2 面向?qū)ο鬁y(cè)試的步驟8.2 面向?qū)ο鬁y(cè)試文檔8.2.1 測(cè)試計(jì)劃8.2.2 測(cè)試用例8.2.3 測(cè)試報(bào)告8.3 面向?qū)ο鬁y(cè)試文檔的內(nèi)容要求和編寫(xiě)指南8.3.1 引言8.3.2 項(xiàng)目背景8.3.3 質(zhì)量目標(biāo)8.3.4 測(cè)試資源8.3.5 測(cè)試策略8.3.6 測(cè)試計(jì)劃本章小結(jié)習(xí)題實(shí)訓(xùn)參考文獻(xiàn)

章節(jié)摘錄

　　雖然軟件工程生存周期規(guī)定每一階段都要生成高質(zhì)量的文檔，但人們常常認(rèn)為軟件就是程序而不是文檔。這是很多人對(duì)軟件的一種誤解，這種誤解有其根深蒂固的生長(zhǎng)土壤。人們確實(shí)將軟件看成是一種產(chǎn)品，它們具有與其他產(chǎn)品一樣的共性。但是，與其他產(chǎn)品相比，軟件畢竟是一種邏輯的而不是物理的系統(tǒng)成分。軟件開(kāi)發(fā)不像加工一個(gè)機(jī)械零件那樣看得見(jiàn)、摸得著。由于不存在物理上的損傷和磨損用壞等問(wèn)題，所以在軟件的開(kāi)發(fā)過(guò)程中，人們往往不易或不愿意像開(kāi)發(fā)機(jī)器產(chǎn)品、建造房屋那樣有計(jì)劃、有步驟、按規(guī)范進(jìn)行。直至現(xiàn)在，還常常有人喜歡按照自己的一套來(lái)“編程序”，拿到一個(gè)軟件開(kāi)發(fā)項(xiàng)目后，在沒(méi)有搞好需求分析、結(jié)構(gòu)設(shè)計(jì)等工作的情況下，就急急忙忙動(dòng)手編寫(xiě)代碼。表面看來(lái)，這是趕進(jìn)度，節(jié)省了時(shí)間，但欲速則不達(dá)。由于急于求成，編寫(xiě)程序時(shí)也往往忽略好的編碼風(fēng)格，這些都給以后的軟件開(kāi)發(fā)和維護(hù)工作帶來(lái)潛在的隱患和很大的困難，也許過(guò)了一段時(shí)間才會(huì)意識(shí)到，但為時(shí)已晚。應(yīng)該說(shuō)，這只是在寫(xiě)程序（即代碼），而不是在開(kāi)發(fā)軟件。對(duì)于這樣的人，我們寧愿稱(chēng)其為程序工人而非軟件工程師。軟件發(fā)展歷史上的“力拔山兮氣蓋世”的個(gè)人英雄主義時(shí)代已經(jīng)過(guò)去。毋庸諱言，單槍匹馬、自以為是、孤芳自賞的作坊式作風(fēng)仍然是制約我國(guó)軟件產(chǎn)業(yè)發(fā)展的嚴(yán)重問(wèn)題?！　≤浖_(kāi)發(fā)是一個(gè)把用戶(hù)需要轉(zhuǎn)化為軟件需求，把軟件需求轉(zhuǎn)化為軟件設(shè)計(jì)，用軟件代碼來(lái)實(shí)現(xiàn)軟件設(shè)計(jì)，對(duì)軟件代碼進(jìn)行測(cè)試，交付并投入運(yùn)行的過(guò)程。在這個(gè)過(guò)程中的每一階段，都應(yīng)該包含有相應(yīng)的文檔編制工作。在建造一幢大樓時(shí)，各種各樣的相關(guān)的設(shè)計(jì)和施工圖紙貫穿于大樓建造的始終。我們很難想象，如果沒(méi)有這些設(shè)計(jì)圖和施工圖，高質(zhì)量的樓宇如何能拔地而起。同理，在軟件開(kāi)發(fā)過(guò)程中，沒(méi)有充分的分析、合理的設(shè)計(jì)、實(shí)現(xiàn)，這樣開(kāi)發(fā)出的軟件產(chǎn)品必然經(jīng)不起實(shí)際的考驗(yàn)。常常有人認(rèn)為，軟件項(xiàng)目成功的標(biāo)志是交出能夠正確運(yùn)行的程序，文檔是可有可無(wú)的，如果一定要寫(xiě)，也只是在程序本身完成之后再補(bǔ)上。這種僅僅為了交差才補(bǔ)寫(xiě)的文檔往往和實(shí)際開(kāi)發(fā)的程序存在很大差距，難以發(fā)揮其應(yīng)有的作用。符合要求的、規(guī)范化的文檔在軟件開(kāi)發(fā)中的作用就如同零件圖紙?jiān)诋a(chǎn)品開(kāi)發(fā)中的作用一樣，是表達(dá)思想、傳遞信息的重要途徑，是保證軟件開(kāi)發(fā)質(zhì)量、提高軟件可維護(hù)性、可靠性和可生產(chǎn)性的重要措施?！　∫虼?，軟件絕不是程序的同義詞。軟件是與計(jì)算機(jī)系統(tǒng)的操作有關(guān)的程序及文檔的集合。　　文檔的編寫(xiě)是軟件開(kāi)發(fā)過(guò)程中的重要工作，是工程化方法的重要體現(xiàn)。具體說(shuō)來(lái)，軟件文檔具有以下幾方面的作用。

編輯推薦

　 其他版本請(qǐng)見(jiàn)：《普通高等教育“十一五”國(guó)家級(jí)規(guī)劃教材：軟件文檔編寫(xiě)》

圖書(shū)封面

圖書(shū)標(biāo)簽Tags

無(wú)

評(píng)論、評(píng)分、閱讀與下載

---

    普通高等教育"十一五"國(guó)家級(jí)規(guī)劃教材 PDF格式下載

---