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

前言

　　軟件開發(fā)是一個把用戶需要轉(zhuǎn)化為軟件需求，把軟件需求轉(zhuǎn)化為軟件設計，用軟件代碼來實現(xiàn)軟件設計，對軟件代碼進行測試，交付并投入運行的過程。在這個過程中的每一階段，都需要編寫相應的文檔。文檔的編寫是軟件開發(fā)過程中的重要工作，是工程化方法的重要體現(xiàn).符合要求的、規(guī)范化的文檔在軟件開發(fā)中起著表達思想、傳遞信息的重要作用，是保證軟件開發(fā)質(zhì)量、提高軟件可維護性、可靠性和可生產(chǎn)性的重要措施?！　”緯裱瓏液蛧H有關計算機軟件開發(fā)文檔編制的標準和規(guī)范，從基于結構化方法和面向?qū)ο蠓椒▋蓚€方面，從應用的角度，詳細地探討了軟件開發(fā)過程中《可行性研究報告》、《軟件需求規(guī)格說明書》、《概要設計說明書》和《詳細設計說明書》等幾個重要文檔的編寫要求與方法，強調(diào)了CASE工具在文檔編寫過程中的作用，并給出基于CASE工具支持的文檔編寫實例。　　我們特別強調(diào)，“軟件文檔編寫”本質(zhì)上是一門實踐性很強的課程。使用本書作為教材時，課堂教學和實驗環(huán)節(jié)參考學時分配如下表所示。

內(nèi)容概要

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

書籍目錄

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

章節(jié)摘錄

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

編輯推薦

　 其他版本請見：《普通高等教育“十一五”國家級規(guī)劃教材：軟件文檔編寫》

圖書封面

圖書標簽Tags

無

評論、評分、閱讀與下載

---

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

---