優(yōu)秀軟件文檔的必備要素

字號(hào):

當(dāng)你拼命地試圖回憶當(dāng)初的需求會(huì)議的時(shí)候,你的反應(yīng)只能是可憐說(shuō)當(dāng)初在項(xiàng)目開(kāi)始階段團(tuán)隊(duì)理解出現(xiàn)了問(wèn)題。
     當(dāng)然,這是一個(gè)很極端的例子,但是卻是在項(xiàng)目開(kāi)發(fā)中經(jīng)常出現(xiàn)。你可以將這個(gè)問(wèn)題歸結(jié)到需求管理之上。我將這個(gè)過(guò)程描述為一個(gè)包含五個(gè)階段的反復(fù)過(guò)程,其目標(biāo)是在項(xiàng)目的生命周期中管理項(xiàng)目開(kāi)發(fā)的捕獲、文檔、跟蹤和交付。下面是這五個(gè)階段的一個(gè)簡(jiǎn)單描述:
     第一階段:初始化
     這個(gè)階段從項(xiàng)目請(qǐng)求開(kāi)始,到項(xiàng)目被核準(zhǔn)結(jié)束。這個(gè)階段的目標(biāo)是確定項(xiàng)目是否值得開(kāi)發(fā),與別的項(xiàng)目相比其優(yōu)先級(jí)別如何。其步驟包括:
     初始項(xiàng)目請(qǐng)求。
     IT區(qū)域回顧。
     概要成本估算,CBA,或者預(yù)計(jì)的ROI。
     第二階段:確定或啟發(fā)
     這個(gè)步驟是指詳細(xì)需求的組織化的和結(jié)構(gòu)化。它包括:
     最初的項(xiàng)目請(qǐng)求的回顧。
     項(xiàng)目風(fēng)險(xiǎn)承擔(dān)人的初步確定。
     啟發(fā)計(jì)劃的完成。
     反復(fù)地執(zhí)行需求啟發(fā)步驟,包括會(huì)見(jiàn)、交流或其它技術(shù)。
     初步需求列表。
     商業(yè)規(guī)則的確定。
     文檔,包括使用案例、上下文圖表及其它更多內(nèi)容。
     功能和非功能需求的正式創(chuàng)建。
     和大多數(shù)同行一樣,我明白軟件文檔的重要性。不幸的是,在任務(wù)開(kāi)始前我很少閱讀文檔。相反,我常常像視線不清的父母一樣,在裝配好他們孩子的自行車之后,還落下一兩個(gè)零部件沒(méi)裝上。