需求文檔評(píng)審實(shí)例

1、附加：需求文檔評(píng)審實(shí)例,軟件的開(kāi)發(fā)文檔質(zhì)量一般只能通過(guò)評(píng)審來(lái)進(jìn)行保證，如何有效發(fā)現(xiàn)文檔中的問(wèn)題，是一個(gè)令許多人頭疼的問(wèn)題。先看一段關(guān)于日志文件的需求描述：“軟件要將所有的訪問(wèn)者都記錄下來(lái)，對(duì)每次訪問(wèn)要記錄訪問(wèn)開(kāi)始時(shí)間、訪問(wèn)結(jié)束時(shí)間、訪問(wèn)者的IP地址這三個(gè)信息作為一條日志記錄。要求以天為單位每天生成一個(gè)訪問(wèn)記錄日志文件。”,在這段需求描述中，要發(fā)現(xiàn)問(wèn)題的話，首先要想象自己是日志模塊的開(kāi)發(fā)者，根據(jù)這段需求描述，是否能夠開(kāi)發(fā)出日志模塊來(lái)呢？

2、日志文件要記錄的信息內(nèi)容上面都提到了：訪問(wèn)開(kāi)始時(shí)間、結(jié)束時(shí)間、IP地址。初一看好像可以根據(jù)這個(gè)需求描述進(jìn)行開(kāi)發(fā)。,附加：需求文檔評(píng)審實(shí)例,如果用元素分析法來(lái)分析一下這段需求的話，就會(huì)發(fā)現(xiàn)并不是想象的那樣樂(lè)觀。先找出需求中涉及的三個(gè)顯性元素：◆訪問(wèn)者◆訪問(wèn)記錄◆日志文件,首先對(duì)訪問(wèn)者和訪問(wèn)記錄這兩個(gè)元素進(jìn)行分析，先看訪問(wèn)者有那些屬性，除了描述中提及的訪問(wèn)時(shí)間和IP地址外，訪問(wèn)者還有那些屬性呢？顯然訪問(wèn)者的訪問(wèn)內(nèi)容是最重要的屬性，僅記

3、錄訪問(wèn)時(shí)間和訪問(wèn)者的IP地址是否足夠呢，從日志能分析出什么有用的信息呢？從時(shí)間信息上最多只能看出哪段時(shí)間訪問(wèn)的人數(shù)較多，得到用戶的時(shí)間分布規(guī)律，很難對(duì)用戶的行為有深入的分析，只有知道訪問(wèn)者在訪問(wèn)哪些內(nèi)容才能得到更有價(jià)值的信息。象Web服務(wù)器軟件要記錄下訪問(wèn)的URL（統(tǒng)一資源定位符）信息以便知道訪問(wèn)者訪問(wèn)的內(nèi)容，所以訪問(wèn)記錄中遺漏了關(guān)于訪問(wèn)內(nèi)容的信息。,附加：需求文檔評(píng)審實(shí)例,從訪問(wèn)記錄這個(gè)元素來(lái)分析，訪問(wèn)記錄主要屬性是記錄格式，每條記錄

4、是以什么格式來(lái)記錄呢？沒(méi)有描述出來(lái)。有經(jīng)驗(yàn)的開(kāi)發(fā)者就知道日志記錄格式是一個(gè)很重要的問(wèn)題，因?yàn)槿罩居涗浀姆治鲆话闶切枰褂脤ｉT的分析軟件或者寫專門的分析程序來(lái)分析的。如何設(shè)計(jì)合理的記錄格式以便利用已有的日志分析軟件來(lái)進(jìn)行分析是首要考慮的問(wèn)題。,再對(duì)日志文件這個(gè)元素進(jìn)行分析，先看看日志文件有哪些屬性，首先日志文件具有文件名，還有存放位置，文件格式，文件內(nèi)容、文件創(chuàng)建時(shí)間、文件大小、文件權(quán)限等屬性。,需求描述中提到了每天要生成一個(gè)日志文件，從

5、文件創(chuàng)建時(shí)間屬性來(lái)看，每天有24小時(shí)，到底從什么時(shí)候開(kāi)始創(chuàng)建文件，從0點(diǎn)開(kāi)始還是從幾點(diǎn)開(kāi)始，沒(méi)有描述出來(lái)。,附加：需求文檔評(píng)審實(shí)例,從文件名屬性來(lái)看，如何命名日志文件，需求中也沒(méi)有提及。從存放位置屬性來(lái)看，日志文件存放在什么地方也沒(méi)有說(shuō)明。是不是所有的日志文件都存放在應(yīng)用程序同一子目錄下？,從文件格式屬性來(lái)看，首先日志文件是以文本方式存儲(chǔ)還是以二進(jìn)制格式存儲(chǔ)？再者，文件的內(nèi)容是以何種格式記錄，每條訪問(wèn)記錄間如何分隔，是以回車換行作為分隔

6、還是以其他字符作為分隔？都沒(méi)有描述。,從文件內(nèi)容屬性來(lái)分析，除了存放上述描述的內(nèi)容外，是否還可以保存其他內(nèi)容，如果不能保存其他內(nèi)容的話，需求描述中應(yīng)該加上一句“日志文件中只能存儲(chǔ)訪問(wèn)記錄信息，不得儲(chǔ)存其他記錄信息”。,附加：需求文檔評(píng)審實(shí)例,從文件大小屬性來(lái)分析，日志文件的大小有沒(méi)有限制？如果某天處于訪問(wèn)高峰期，訪問(wèn)特別多，是否需要將日志文件分拆成多個(gè)，是一個(gè)需要考慮的問(wèn)題。,從文件權(quán)限屬性來(lái)分析，日志文件是否機(jī)器上的所有用戶都可以訪問(wèn)

7、還是只有特定的用戶可以訪問(wèn)？文件是否需要設(shè)置權(quán)限，也是一個(gè)需要考慮的問(wèn)題。,所以通過(guò)元素分析法對(duì)上述需求描述進(jìn)行分析后，你會(huì)發(fā)現(xiàn)需求描述中有很多的問(wèn)題沒(méi)有描述清楚。也許有人會(huì)有疑問(wèn)，如果將所有上面說(shuō)到的問(wèn)題都描述出來(lái)的話，會(huì)不會(huì)工作量太大了？?jī)H從需求分析的角度來(lái)講，需求規(guī)格描述得較細(xì)，確實(shí)會(huì)增大很多工作量，但從整個(gè)開(kāi)發(fā)過(guò)程來(lái)看，需求描述完整，后續(xù)階段的開(kāi)發(fā)產(chǎn)生歧義和遺漏的可能性就很小，實(shí)際上后續(xù)階段節(jié)約的時(shí)間會(huì)大大超過(guò)需求所多花的時(shí)間。