软件工程文档
軟件工程文檔
文檔是軟件開發(fā)使用和維護(hù)當(dāng)中必備的資料，文檔主要是管理人員、開發(fā)人員、操作人員、用戶人員之間進(jìn)行協(xié)商溝通的橋梁。
1.可行性分析文檔
- 主要是說明軟件在經(jīng)濟(jì)上，技術(shù)上和市場情景等方面的可行性。
- 根據(jù)這個文檔，公司判斷軟件能否實現(xiàn)，客戶要考慮是否把項目給公司，公司考慮是否要接這個項目。
2.需求文檔
- 用戶與開發(fā)人員進(jìn)行交流，開發(fā)人員根據(jù)和用戶不斷地進(jìn)行交流，把用戶的需求寫成文檔。需求文檔是用戶和需求人員溝通的橋梁，需求人員根據(jù)用戶的要求來變更需求文檔。
- 需求文檔對所開發(fā)軟件的功能、性能、用戶界面以及運行環(huán)境等作出詳細(xì)的說明。也就是說，需求文檔主要是寫明軟件有什么功能，性能，誰用這軟件等內(nèi)容。
3.數(shù)據(jù)庫設(shè)計文檔
- 數(shù)據(jù)庫設(shè)計文檔，有些公司是由DBA（數(shù)據(jù)庫管理員）設(shè)計的，有些公司是由架構(gòu)師設(shè)計的，有些是由程序員設(shè)計的。該文檔給出數(shù)據(jù)邏輯描述和數(shù)據(jù)采集的各項要求，為生成和維護(hù)系統(tǒng)的數(shù)據(jù)文件做好準(zhǔn)備。
4.概要設(shè)計文檔
- 由公司的架構(gòu)師，項目經(jīng)理來完成。
- 概要設(shè)計文檔說明系統(tǒng)的功能分配、模塊劃分、程序的總體結(jié)構(gòu)、輸入輸出及接口設(shè)計、運行設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等，為詳細(xì)設(shè)計奠定基礎(chǔ)。
- ?架構(gòu)師根據(jù)需求文檔設(shè)計系統(tǒng)的整體架構(gòu)，項目經(jīng)理列出開發(fā)計劃，架構(gòu)師完成概要設(shè)計之后，就開始給程序員分配任務(wù)，進(jìn)行下一階段。
5.詳細(xì)設(shè)計分檔
- 程序員拿著架構(gòu)師設(shè)計出來的概要設(shè)計文檔，開始編寫詳細(xì)設(shè)計文檔，所以一個項目里面會有很多份詳細(xì)設(shè)計文檔，因為每一個程序員負(fù)責(zé)一部分的功能，每個人寫出來的詳細(xì)設(shè)計文檔都不一樣。
- 詳細(xì)設(shè)計文檔，詳細(xì)的列出開發(fā)的方式，如何編寫代碼等內(nèi)容，著重描述功能模塊是如何實現(xiàn)的，包括算法和邏輯流程等。
6.單元測試文檔
- 一般由程序員完成，這個文檔因公司而異，有些公司寫，有些公司不寫。單元測試文檔主要是從代碼級別來測試系統(tǒng)（寫單元測試，測試自己寫的代碼），也叫白盒測試。
7.測試計劃：
- 測試計劃由公司的測試部門的測試人員進(jìn)行測試，主要是在文檔中列出測試的方案，測試的結(jié)果等。
- 測試計劃主要是站在客戶的角度對系統(tǒng)的功能進(jìn)行測試，也叫黑盒測試。
8.測試分析報告
- 測試完成后，有些公司會寫一個測試分析報告，把一些共性的問題挑出來，為以后的開發(fā)做個經(jīng)驗的積累。
9.項目開發(fā)總結(jié)報告
- 一般是系統(tǒng)部署后，由項目經(jīng)理對系統(tǒng)進(jìn)行一個大的總結(jié)，看系統(tǒng)實際完成的情況與系統(tǒng)計劃實施的情況有什么差異？包括進(jìn)度，資金、人力的投入情況等，總結(jié)出經(jīng)驗和教訓(xùn)。
10.用戶手冊
- 詳細(xì)描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。用戶手冊就相當(dāng)于我們平時看的說明書一樣，說明你的系統(tǒng)如何使用。
11.操作手冊
- 針對的對象主要是操作員，為操作員了解軟件的運行情況和操作方法知識。
12.開發(fā)進(jìn)度月報
- 由公司的項目經(jīng)理根據(jù)當(dāng)前開發(fā)系統(tǒng)的進(jìn)度填寫。
?
posted on 2013-01-19 20:05 雨落天涯 閱讀(...) 評論(...) 編輯 收藏轉(zhuǎn)載于:https://www.cnblogs.com/mingxuanyun/archive/2013/01/19/3084233.html
總結(jié)
- 上一篇： 搜索分布式
- 下一篇： netapp存储常用命令