軟件文檔寫作教程

前言

　　眾所周知，軟件文檔是整個軟件開發(fā)工作的基礎(chǔ)，現(xiàn)代工程化的軟件開發(fā)離不開軟件文檔。軟件文檔體系的建立與軟件開發(fā)階段密切相關(guān)，是軟件開發(fā)整個生命周期中必不可少的一部分，軟件生命周期始于軟件文檔，軟件文檔貫穿著整個軟件生命周期?！　∽髡邚氖萝浖こ痰慕虒W(xué)和研究已有數(shù)年的歷史，從長期的工作經(jīng)驗(yàn)中發(fā)現(xiàn)，無論是相關(guān)專業(yè)的學(xué)生還是研究開發(fā)人員，對軟件文檔的寫作都越來越重視，同時對軟件文檔寫作的寫作規(guī)范缺乏相應(yīng)的基礎(chǔ)，國內(nèi)有關(guān)軟件文檔寫作的教材也比較少，而且缺乏實(shí)際案例的分析。軟件文檔寫作是一門實(shí)踐性比較強(qiáng)的課程，必須結(jié)合實(shí)際的軟件開發(fā)案例進(jìn)行教學(xué)。我們在總結(jié)多年的教學(xué)和研究經(jīng)驗(yàn)的基礎(chǔ)上，參考國內(nèi)外最新版本的教材和論文，結(jié)合作者多年來跟蹤國際上相關(guān)領(lǐng)域的最新研發(fā)方向的成果編寫了這本書?！　”緯煌谝话愕能浖臋n寫作教材，不僅講述軟件文檔寫作的基本內(nèi)容和方法，而且根據(jù)軟件工程領(lǐng)域的最新發(fā)展，結(jié)合典型開發(fā)案例，力求系統(tǒng)地描述可行性研究報告、項目建議書、招投標(biāo)文件、需求分析書、概要設(shè)計書、詳細(xì)設(shè)計書、項目驗(yàn)收報告和項目總結(jié)報告等文檔的寫作規(guī)范和技巧。以數(shù)個典型的軟件系統(tǒng)開發(fā)項目為案例，重點(diǎn)講述項目建議書，需求分析書、概要設(shè)計書、詳細(xì)設(shè)計書和項目驗(yàn)收總結(jié)報告的內(nèi)容、要求、寫作技巧和注意事項，指導(dǎo)學(xué)生如何書寫軟件開發(fā)過程中的相關(guān)文檔。　　本書包括以下13章。　　第1章是緒論。主要介紹軟件文檔的意義、作用和分類等相關(guān)知識?！　〉?章介紹軟件文檔的寫作規(guī)范。其主要內(nèi)容包括可行性研究報告、項目建議書、招投標(biāo)文件的寫作規(guī)范，需求分析書寫作規(guī)范，概要設(shè)計書寫作規(guī)范，詳細(xì)設(shè)計書寫作規(guī)范，項目驗(yàn)收總結(jié)報告寫作規(guī)范?！　〉?章通過典型案例——某市軌道交通突發(fā)事件實(shí)時應(yīng)急集成指揮系統(tǒng)開發(fā)過程中的軟件文檔，講述軟件項目立項階段項目建議書的內(nèi)容、要求、寫作技巧和注意事項?！　〉?章通過典型案例——研究生教務(wù)管理系統(tǒng)開發(fā)過程中的軟件文檔，講述需求分析書的內(nèi)容、要求、寫作技巧和注意事項?！　〉?章通過典型案例——奧運(yùn)綜合服務(wù)系統(tǒng)開發(fā)過程中的軟件文檔，進(jìn)一步講述需求分析書的內(nèi)容、要求、寫作技巧和注意事項?！　〉?章通過典型案例——地鐵綜合信息查詢系統(tǒng)開發(fā)過程中的軟件文檔，講述企業(yè)實(shí)際項目的需求設(shè)計書的內(nèi)容、要求、寫作技巧和注意事項。

內(nèi)容概要

　　不同于一般的軟件文檔寫作教材，不僅講述軟件文檔寫作的基本內(nèi)容和方法，而且根據(jù)軟件工程領(lǐng)域的最新發(fā)展，結(jié)合典型開發(fā)案例，力求系統(tǒng)地描述可行性研究報告、項目建議書、招投標(biāo)文件、需求分析書、概要設(shè)計書、詳細(xì)設(shè)計書、項目驗(yàn)收報告和項目總結(jié)報告等文檔的寫作規(guī)范和技巧。以數(shù)個典型的軟件系統(tǒng)開發(fā)項目為案例，重點(diǎn)講述項目建議書，需求分析書、概要設(shè)計書、詳細(xì)設(shè)計書和項目驗(yàn)收總結(jié)報告的內(nèi)容、要求、寫作技巧和注意事項，指導(dǎo)學(xué)生如何書寫軟件開發(fā)過程中的相關(guān)文檔。《軟件文檔寫作教程》可作為軟件工程，計算機(jī)科學(xué)與技術(shù)等專業(yè)本科生及研究生的參考書，也可作為相關(guān)研究開發(fā)人員的參考書和工具書。

書籍目錄

第1章　緒論	1.1　軟件文檔的意義	1.2　軟件文檔的作用	1.3　軟件文檔的分類	1.4　軟件文檔必備的條件	1.5　軟件文檔的管理	本章小結(jié)	參考文獻(xiàn)	第2章　軟件文檔的寫作規(guī)范	2.1　項目立項階段文檔的寫作規(guī)范	2.2　需求分析書的寫作規(guī)范	2.3　概要設(shè)計書的寫作規(guī)范	2.4　詳細(xì)設(shè)計書的寫作規(guī)范	2.5　項目結(jié)束階段文檔的寫作規(guī)范	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第3章　軟件項目立項階段文檔寫作案例分析——某市軌道交通突發(fā)事件實(shí)時應(yīng)急集成指揮系統(tǒng)案例分析	3.1　項目的目的和意義	3.2　國內(nèi)外研究開發(fā)現(xiàn)狀和發(fā)展趨勢	3.3　項目現(xiàn)有工作基礎(chǔ)	3.4　項目實(shí)施目標(biāo)	3.5　主要研究開發(fā)內(nèi)容	3.6　社會經(jīng)濟(jì)效益分析和風(fēng)險分析	3.7　年度目標(biāo)和年度實(shí)施計劃	3.8　預(yù)期主要成果	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第4章　需求分析書案例分析一——研究生教務(wù)管理系統(tǒng)案例分析	4.1　引言	4.2　任務(wù)概述	4.3　需求規(guī)定	4.4　運(yùn)行環(huán)境規(guī)定	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第5章　需求分析書案例分析二——奧運(yùn)綜合服務(wù)系統(tǒng)案例分析	5.1　系統(tǒng)概述	5.2　功能和非功能需求	5.3　數(shù)據(jù)需求	5.4　接口需求	5.5　環(huán)境需求	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第6章　需求分析書案例分析三——地鐵綜合信息查詢系統(tǒng)案例分析	6.1　概述	6.2　系統(tǒng)需求	6.3　總體結(jié)構(gòu)	6.4　用戶培訓(xùn)	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第7章　概要設(shè)計書案例分析一——研究生教務(wù)管理系統(tǒng)案例分析	7.1　引言	7.2　總體設(shè)計	7.3　接口設(shè)計	7.4　運(yùn)行設(shè)計	7.5　系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計	7.6　系統(tǒng)出錯處理設(shè)計	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第8章　概要設(shè)計書案例分析二——辦公自動化系統(tǒng)案例分析	8.1　引言	8.2　概要設(shè)計	8.3　各子系統(tǒng)概要設(shè)計	8.4　接口設(shè)計	8.5　系統(tǒng)出錯處理設(shè)計	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第9章　概要設(shè)計書案例分析三——某企業(yè)建筑業(yè)信息化系統(tǒng)案例分析	9.1　軟件體系結(jié)構(gòu)的確立	9.2　框架選型	9.3　軟件開發(fā)模型選擇	9.4　總體設(shè)計	9.5　數(shù)據(jù)庫設(shè)計	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第10章　詳細(xì)設(shè)計書案例分析一——研究生教務(wù)管理系統(tǒng)案例分析	10.1　引言	10.2　程序系統(tǒng)的結(jié)構(gòu)	10.3　程序設(shè)計說明	10.4　算法	10.5　接口	10.6　存儲分配	10.7　注釋設(shè)計	10.8　限制條件	10.9　測試計劃	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第11章　詳細(xì)設(shè)計書案例分析二——中國教育信息化系統(tǒng)案例分析	11.1　案例分析	11.2　詳細(xì)設(shè)計的工具	11.3　詳細(xì)設(shè)計書的注意事項	11.4　詳細(xì)設(shè)計的評審	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第12章　軟件項目結(jié)束階段文檔寫作案例分析——校園博客系統(tǒng)案例分析	12.1　測試概述	12.2　測試計劃執(zhí)行情況	12.3　測試總結(jié)	12.4　綜合評價	本章小結(jié)	參考文獻(xiàn)	習(xí)題	第13章　總結(jié)

章節(jié)摘錄

　　1.設(shè)計各模塊的實(shí)現(xiàn)方法　　如果十個人看著概要設(shè)計書進(jìn)行編碼，對于同一個功能模塊，也很可能會產(chǎn)生十個不同的實(shí)現(xiàn)方法，其中有效率高的最優(yōu)算法，也有基本實(shí)現(xiàn)功能的可行算法。為了使我們的系統(tǒng)具有效率高、性能穩(wěn)定、容錯性強(qiáng)等優(yōu)點(diǎn)，也必須在編碼之前確定最優(yōu)的算法，避免日后因?yàn)檫_(dá)不到前期確定的性能要求而返工。于是我們必須在詳細(xì)設(shè)計階段確定模塊功能實(shí)現(xiàn)中的最優(yōu)算法，預(yù)見技術(shù)難點(diǎn)，分析數(shù)據(jù)流等，這些問題不應(yīng)該留待編碼遇到的時候才考慮。　　2.成為編碼人員的指揮棒　　我們心目中最理想的詳細(xì)設(shè)計書是這樣的，即使是一個對本系統(tǒng)一無所知的編程人員，按照詳細(xì)設(shè)計書中包含的內(nèi)容，也能很好的完成這部分的編碼任務(wù)。換句話說，從詳細(xì)設(shè)計書到編碼的工作應(yīng)僅僅是一個翻譯工作，而不應(yīng)存在任何的設(shè)計工作，所有設(shè)計工作應(yīng)在編碼之前完成?！　?.成為單元測試的依據(jù)　　方法是系統(tǒng)中最小的功能單位，單元測試的著眼點(diǎn)就是這些方法。在詳細(xì)設(shè)計書中寫著這些方法的輸人參數(shù)，輸出結(jié)果，測試用例就可以根據(jù)這些輸入?yún)?shù)進(jìn)行組合，考慮正常值、臨界值、無效值，從而形成單元測試的測試用例?！　?.4.2 詳細(xì)設(shè)計書的基本要求　　1.全面　　如果說概要設(shè)計書的全面是針對整個軟件系統(tǒng)的全面，那么詳細(xì)設(shè)計書的全面就是針對整個模塊的全面。整個系統(tǒng)只需要撰寫一份概要設(shè)計書，但是詳細(xì)設(shè)計書卻必須有多份，因?yàn)槲覀冃枰獮槊總€模塊單獨(dú)撰寫詳細(xì)設(shè)計書，即使是簡單的功能模塊也必須寫詳細(xì)設(shè)計書，哪怕是簡單地描述該模塊的實(shí)現(xiàn)，一方面是為了對付人類遺忘的天性，另一方面是為了與下一個接手這個軟件系統(tǒng)的人進(jìn)行平滑的交接。不將所有模塊的詳細(xì)設(shè)計都寫在一個文檔中，這樣做避免了文檔過大，而且易于查找。詳細(xì)設(shè)計書中應(yīng)該詳盡地寫下本模塊的處理流程，至于模塊的輸入、輸出、異常處理、響應(yīng)速度等方方面面也要考慮周全?！　∷哉f，全面，既是指對于該軟件系統(tǒng)所有功能模塊都要進(jìn)行詳細(xì)設(shè)計，又是指對于某個模塊的設(shè)計要全面。

圖書封面

圖書標(biāo)簽Tags

無

評論、評分、閱讀與下載

---

    軟件文檔寫作教程 PDF格式下載

---