Joel On Software---輕松寫(xiě)就功能規(guī)格說(shuō)明書(shū)
Posted on 2007-07-06 11:39 tanzek 閱讀(613) 評(píng)論(0) 編輯 收藏此節(jié)為第一部分的第六節(jié):
輕松寫(xiě)就功能規(guī)格說(shuō)明書(shū) 第2節(jié):什么是規(guī)格說(shuō)明書(shū)?
下面是JOEL在規(guī)格說(shuō)明書(shū)中都要給出的一些內(nèi)容:
1、事先聲明。這純粹是出于自我保護(hù)目的。通常可以說(shuō):“該規(guī)格說(shuō)明書(shū)還沒(méi)有完成”。
2、作者。人們應(yīng)該擁有他們說(shuō)明的事物的責(zé)任權(quán)與所有權(quán)。如果規(guī)格說(shuō)明書(shū)出了錯(cuò),那么就應(yīng)該有一個(gè)專(zhuān)門(mén)指派的規(guī)格說(shuō)明書(shū)所有人,他的名字就印在規(guī)格說(shuō)明書(shū)上,由他負(fù)責(zé)對(duì)規(guī)格說(shuō)明書(shū)進(jìn)行修訂。
3、情節(jié)。反映你心目中設(shè)想的人們將如何使用產(chǎn)品的真實(shí)生活情節(jié)。這就是要放內(nèi)容的地方。情節(jié)越生動(dòng)越真實(shí),那么你在為實(shí)際的或者虛構(gòu)的用戶設(shè)計(jì)產(chǎn)品時(shí)會(huì)做得越好。
4、非構(gòu)建目標(biāo)。其實(shí)就是不打算去做的事情,很可能就是產(chǎn)品將來(lái)沒(méi)有的特性,確認(rèn)“我們不打算去做”。
5、概觀。規(guī)格說(shuō)明書(shū)目錄,使閱讀者形成大體印象,讓細(xì)節(jié)變得有意義。
6、細(xì)節(jié),細(xì)節(jié),細(xì)節(jié)。每一條細(xì)節(jié)都應(yīng)該有處理細(xì)節(jié)的決定,規(guī)格明書(shū)需要以文檔的形式描述出決定。
7、未盡事宜。對(duì)于規(guī)格說(shuō)明書(shū)的第一個(gè)版本留下一些未盡事宜是允許的,這些需要描述出來(lái)以讓程序員知道并在實(shí)現(xiàn)代碼時(shí)進(jìn)行考慮。
8、旁注。對(duì)于規(guī)格說(shuō)明書(shū),可能會(huì)有各種不同類(lèi)型的讀者,考慮那些僅僅對(duì)團(tuán)體中的某一類(lèi)人帶來(lái)幫助的有用仿真陳述。
9、規(guī)格說(shuō)明書(shū)需要保持時(shí)時(shí)更新的狀態(tài)。隨著產(chǎn)品的開(kāi)發(fā)與新決定的做出,規(guī)格說(shuō)明書(shū)的更新應(yīng)該是不斷地持續(xù)下去的。規(guī)格說(shuō)明書(shū)總是反映我們大家針對(duì)產(chǎn)品將如何工作而紀(jì)念品出的最佳理解。
JOEL通常在服備器的某個(gè)位置保存一份當(dāng)前版本,一般而言是用帶有修訂標(biāo)記的規(guī)格說(shuō)明書(shū)副本,而非是重新的規(guī)格說(shuō)明書(shū)版本來(lái)讓各位成員進(jìn)行參考。