技术和function规格模板
所以基本上我正在寻找一个好的模板来编写技术和function规格的项目或工作要求。
你用什么? 在写规格的时候有多深? 任何额外的一般技巧,你可以提供将不胜感激。
我的公司需要这些。 我为承包商工作,现在我们根本不使用这些文件。
编辑:我已经阅读乔尔的无痛规格 ,我真的很喜欢它,但有没有其他意见:)
一般提示;
我们正在实施一个过程
1)业务需求声明(BRS)
2)function规格
3)技术规格
BRS涵盖了业务问题,以及解决scheme,testing,安全性,可靠性和交付方面的要求。 这定义了什么可以成功解决问题。
function规格详述了需要什么,应该如何看,应该有多长的字段等等。
技术规格详细说明数据来自何处,可能需要考虑任何棘手的代码。
客户拥有这些要求。 开发人员拥有技术规格,function规格是中间地带。 根据技术规格(通常是unit testing)进行testing,然后根据function规格(通常是系统testing)进行testing,然后根据要求(UAT)进行testing。
这个(我们正在努力的)的重要部分是开发人员仍然需要交付function规格,以及原来的业务需求。 实际上,function和技术规格只是为了清晰起见。
总之,我的主要build议是首先解决你希望实施的过程。 然后,寻求您所提议的stream程中涉及的各方的同意,然后在模板上进行调整。 模板本身只是你想要改变的一小部分。
不是一个模板,但Joel写了一些关于编写function规范的文章 。 他也有样品在这里 。
你可以从ieee和其他地方购买模板,但我总是最终做出自己的模板。
对于技术规范,史蒂夫·麦克唐纳的“ 代码完整 ”有一个很好的清单,你可以从中得到一些信息。 在我上一份工作中,我只是从他的部分标题中创build了一个模板,并从那里调整了它。
就function规格而言,重要的是要定义所有的接口:
- UI(屏幕实体模型)
- 软件界面(插件等)
- 硬件接口(如果适用)
- 通信接口(服务,电子邮件,消息等)
业务规则也应该有一个部分,这些部分在function上是非常重要的,而且在任何接口定义中都没有涉及。
如果您想购买一本书, 卡尔·维格斯的软件需求(Software Requirements)由附录提供了几个文档的模板。 不幸的是,我在工作,这本书是在家里。 如果有人把它派上用场,他们或许能够证实这一点。
我碰巧喜欢这个,其中包括: ReadySet 。
他也出售一个专业版。
这是我find的最好的: http : //www.jiludwig.com/templates/FRDTemplate.doc
从简单的开始,从那里开始工作。 由于这是您的第一次使用这个工作的经验,请使用带有项目符号的word文档。 写下来,重新阅读,并提供足够的细节,这是有道理的。 对于技术规范,您可能希望引导开发人员寻求解决scheme,但是对于function规范,“如何”应该完全没有。
我build议在这里看看Roberston的Volere模板。 他们是大西洋系统协会的一部分,与汤姆·德马科(Tom DeMarco)和蒂莫西·李斯特(Timothy Lister)这样的“Peopleware”成名的人一起。
由于模板的版权,我不会在这里重现,但给你一些主标题:
- 项目的目的
- 利益相关者
- 授权限制
- 命名约定和术语
- 相关的事实和假设
- 工作的范围
- 商业数据模型和数据字典
- 产品的范围
- function要求
- 外观和感觉要求…
还有更多,但这应该给你一个想法。 模板中最有趣的部分是需求shell,它列出了一种提示卡的function要求。 再次受版权保护,但真正有价值。
在这里看第9章。