1、軟件開發(fā)中文檔的編寫是一個(gè)不可缺少的環(huán)節(jié)，常見的如需求分析概要分析數(shù)據(jù)庫設(shè)計(jì)等在“軟件人”的陣營里向來存在兩種觀點(diǎn)，注重文檔還是關(guān)心代碼我這里寫一個(gè)用戶信息模塊的概要設(shè)計(jì)文檔，只列舉主。

2、1需求分析 需求分析的結(jié)果通常需要使用需求說明文檔來描述，目前主流的需求描述方法包括用戶例圖用戶故事等方式這些方式有所不同的側(cè)重，其核心思想就是描述清楚用戶的使用場景2功能設(shè)計(jì) 對(duì)于主要是用戶界面的軟件項(xiàng)目。

3、2模塊開發(fā)情況表 3功能說明 扼要說明本模塊或本組模塊的功能，主要是輸入要求的處理輸出可以從系統(tǒng)設(shè)計(jì)說明書中摘錄同時(shí)列出在軟件需求說明書中對(duì)這些功能的說明的章條款4設(shè)計(jì)說明 說明本模塊或本組模。

4、2概要設(shè)計(jì)產(chǎn)生軟件概要設(shè)計(jì)說明書，說明系統(tǒng)模塊劃分選擇的技術(shù)路線等，整體說明軟件的實(shí)現(xiàn)思路并且需要指出關(guān)鍵技術(shù)難點(diǎn)等3詳細(xì)設(shè)計(jì)產(chǎn)生軟件詳細(xì)設(shè)計(jì)說明書，對(duì)概要設(shè)計(jì)的進(jìn)一步細(xì)化，一般由各部分的擔(dān)當(dāng)人員依據(jù)。

5、開發(fā)文檔 1 功能要求 來源于客戶要求和市場調(diào)查，是軟件開發(fā)中最早期的一個(gè)環(huán)節(jié)客戶提出一個(gè)模糊的功能概念，或者要求解決一個(gè)實(shí)際問題，或者參照同類軟件的一個(gè)功能有軟件經(jīng)驗(yàn)的客戶還會(huì)提供比較詳細(xì)的技術(shù)規(guī)范。

6、軟件文檔中概要設(shè)計(jì)也稱“總體設(shè)計(jì)”，是開發(fā)人員在明確用戶需求要什么后對(duì)系統(tǒng)的一個(gè)總體考慮明確系統(tǒng)目標(biāo)設(shè)計(jì)原則，初步考慮數(shù)據(jù)庫設(shè)計(jì)和功能設(shè)計(jì)，國家關(guān)于這方面有相關(guān)標(biāo)準(zhǔn)概要設(shè)計(jì)說明書GB856788在。

7、* 注釋若干行，并寫入 javadoc 文檔注釋要簡單明了String userName = null 用戶名邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性在必要的地方注釋，注釋量要適中注釋的內(nèi)容要清楚明了，含義準(zhǔn)確，防止。

8、近來學(xué)校的一些科研項(xiàng)目又在申報(bào)了，一些學(xué)弟開始Q我一些軟件工程上書面的問題大概的總結(jié)了下，寫到這里本文涉及到的是需求分析部分的書寫，主要是根據(jù)國家標(biāo)準(zhǔn)文檔中的要求來的 在互聯(lián)網(wǎng)公司或者一些敏捷開發(fā)的公司里，其實(shí)大家都是。

9、在軟件項(xiàng)目開發(fā)過程中，應(yīng)該按軟件開發(fā)要求撰寫十三類文檔，文檔編制要求具有針對(duì)性精確性清晰性完整性靈活性可追溯性需求階段 1可行性分析報(bào)告說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上經(jīng)濟(jì)上和社會(huì)因素上的可行性。

10、編輯本段基本信息 軟件工程一直以來都缺乏一個(gè)統(tǒng)一的定義，很多學(xué)者組織機(jī)構(gòu)都分別給出了自己的定義 軟件工程1BarryBoehm運(yùn)用現(xiàn)代科學(xué)技術(shù)知識(shí)來設(shè)計(jì)并構(gòu)造計(jì)算機(jī)程序及為開發(fā)運(yùn)行和維護(hù)這些程序所必需的相關(guān)文件資料 2。

11、并分配開發(fā)人員交互設(shè)計(jì)師可以通過需求文檔來設(shè)計(jì)交互細(xì)節(jié)需求文檔是項(xiàng)目啟動(dòng)之前，必須要通過評(píng)審確定的最重要文檔產(chǎn)品的概況 介紹項(xiàng)目的背景 介紹產(chǎn)品定位 那些人會(huì)用到本軟件 項(xiàng)目可能涉及的角色。

12、設(shè)計(jì)文檔肯定包括功能模塊的簡述，子模塊的功能描述，包括基礎(chǔ)平臺(tái)描述，數(shù)據(jù)庫鏈接描述權(quán)限設(shè)計(jì)描述等等，需要模板的話請(qǐng)向ITJOB老師索取下。

13、中國版權(quán)保護(hù)中心接收登記的文檔包含兩種操作說明書或設(shè)計(jì)說明書設(shè)計(jì)說明書適合沒有界面的嵌入式軟件，插件軟件，后臺(tái)運(yùn)行軟件以及游戲軟件一般包含結(jié)構(gòu)圖，軟件流程圖，函數(shù)說明，模塊說明，數(shù)據(jù)接口，出錯(cuò)設(shè)計(jì)等操作說明。

14、1引言 編寫目的說明編寫這份詳細(xì)設(shè)計(jì)說明書的目的，指出預(yù)期的讀者范圍2背景說明 待開發(fā)的軟件系統(tǒng)的名稱， 列出本項(xiàng)目的任務(wù)提出者開發(fā)者用戶以及將運(yùn)行該項(xiàng)軟件的單位3定義列出本文件中用到的專門術(shù)語的。

15、軟件開發(fā)的畢業(yè)論文主要寫的是你開發(fā)軟件的整個(gè)過程可行性分析，需求分析，總體設(shè)計(jì)，詳細(xì)設(shè)計(jì)，編碼，文檔，測試等都要寫的主要寫的還是前五項(xiàng)是很重要的文檔也很重要，文檔也是驗(yàn)證是不是一個(gè)全面的完整的，好的軟件。

16、middot在開發(fā)過程中，由需求及設(shè)計(jì)不正確不完整所導(dǎo)致的問題是項(xiàng)目進(jìn)度拖延失敗的一個(gè)主要因素，而軟件系統(tǒng)的一個(gè)重要特性就是需求和設(shè)計(jì)的不斷構(gòu)建和改進(jìn)，在寫詳細(xì)設(shè)計(jì)文檔過程中，詳細(xì)設(shè)計(jì)實(shí)際上是對(duì)系統(tǒng)的一次邏輯。