此节为第一部分的第六节:
轻松写就功能规格说明书 第2节:什么是规格说明书?
下面是JOEL在规格说明书中都要给出的一些内容:
1、事先声明。这纯粹是出于自我保护目的。通常可以说:“该规格说明书还没有完成”。
2、作者。人们应该拥有他们说明的事物的责任权与所有权。如果规格说明书出了错,那么就应该有一个专门指派的规格说明书所有人,他的名字就印在规格说明书上,由他负责对规格说明书进行修订。
3、情节。反映你心目中设想的人们将如何使用产品的真实生活情节。这就是要放内容的地方。情节越生动越真实,那么你在为实际的或者虚构的用户设计产品时会做得越好。
4、非构建目标。其实就是不打算去做的事情,很可能就是产品将来没有的特性,确认“我们不打算去做”。
5、概观。规格说明书目录,使阅读者形成大体印象,让细节变得有意义。
6、细节,细节,细节。每一条细节都应该有处理细节的决定,规格明书需要以文档的形式描述出决定。
7、未尽事宜。对于规格说明书的第一个版本留下一些未尽事宜是允许的,这些需要描述出来以让程序员知道并在实现代码时进行考虑。
8、旁注。对于规格说明书,可能会有各种不同类型的读者,考虑那些仅仅对团体中的某一类人带来帮助的有用仿真陈述。
9、规格说明书需要保持时时更新的状态。随着产品的开发与新决定的做出,规格说明书的更新应该是不断地持续下去的。规格说明书总是反映我们大家针对产品将如何工作而纪念品出的最佳理解。
JOEL通常在服备器的某个位置保存一份当前版本,一般而言是用带有修订标记的规格说明书副本,而非是重新的规格说明书版本来让各位成员进行参考。