一位經(jīng)驗(yàn)豐富的老師談文檔的作用
文檔是否重要取決于文檔是干什么用的。在項(xiàng)目組與用戶交流的時(shí)候,項(xiàng)目組成員與用戶關(guān)于軟件最后的功能、數(shù)據(jù)和流程必須達(dá)成一致的意見,換句話說,確保項(xiàng)目組成員對用戶的理解沒有偏差或很小。
這時(shí)候,僅憑口頭表述是不夠的:一是將來可能項(xiàng)目組與用戶可能扯皮,因?yàn)榭谡f無憑;二是項(xiàng)目組有很多人,不可能對需求的理解完全一致,必須以某種形式共享。這就需要需求的文檔(包括功能說明書),它可以是文字,可以是靜態(tài)網(wǎng)頁組成的原型,可以使用例,根據(jù)不同的項(xiàng)目而定。
需求確定后,數(shù)據(jù)庫要按照需求進(jìn)行設(shè)計(jì)。
作為數(shù)據(jù)庫設(shè)計(jì)者,希望有一個(gè)記錄數(shù)據(jù)庫所有信息的文檔,并跟蹤可能的修改;
作為程序設(shè)計(jì)和編碼者,希望不僅知道數(shù)據(jù)庫的表和字段名,而且要有這些東西的說明。這就需要數(shù)據(jù)庫設(shè)計(jì)文檔。
設(shè)計(jì)者和實(shí)際編碼者之間同樣需要交流,這就有詳細(xì)設(shè)計(jì)文檔。
測試者要明確應(yīng)該測試的東西已全部測試并且是按照規(guī)定的流程和數(shù)據(jù)進(jìn)行測試的,這就要測試計(jì)劃、測試用例和測試報(bào)告。
最后,項(xiàng)目組要培訓(xùn)使用者,這就要使用手冊。當(dāng)然,這些文檔的另一個(gè)重要作用是將來軟件維護(hù)時(shí),可以作為參考。在項(xiàng)目組中途換人時(shí),前人留下的文檔可以很快讓后來者進(jìn)入角色。
激情與創(chuàng)新 盡在Blue Kiss
posted on 2008-09-18 01:13 Blue Kiss開發(fā)團(tuán)隊(duì) 閱讀(630) 評論(2) 編輯 收藏