技术和功能规格模板[关闭]

Question

所以基本上我正在寻找用于在项目或工作请求上编写技术和功能规范的良好模板。

你用什么？ 在编写规范时你有多深？ 您可以提供的任何其他一般提示将不胜感激。

我的公司非常需要这些。 我为承包商工作，现在我们根本不使用这些文件。

编辑：我已经阅读了Joel对无痛规范的看法，我真的很喜欢它，但还有其他意见:)

Answer 1

一般提示;

我们正在实施一个过程

1）业务要求声明（BRS）

2）功能规范

3）技术规格

BRS涵盖了业务问题，以及解决方案，测试，安全性，可靠性和交付的要求。 这定义了什么是成功的解决方案。

功能规范详细说明了所需的内容，外观应该是多少，字段应该是多长等等。

数据来自的技术规范详细信息，可能需要考虑的任何棘手的代码。

客户拥有这些要求。 开发人员拥有技术规范，功能规范是一个中间立场。 测试是针对技术规范（通常是单元测试），然后针对功能规范（通常是系统测试），然后针对需求（UAT）。

这一点的重要部分（我们正在努力）是开发人员仍然需要提供功能规范和原始业务需求。 实际上，功能和技术规格只是为了清晰起见。

简而言之，我的主要建议是首先确定您希望实施的流程。 然后寻求参与您提议的流程的所有各方的协议，然后处理适合的模板。 模板本身只是您想要进行的更改的一小部分。

Answer 2

不是模板，但Joel撰写了几篇关于编写功能规范的文章 。 他也有样品 。

Answer 3

你可以从ieee和其他地方购买模板，但我总是最终制作自己的模板。

对于技术规范，Steve McDonnell的“ Code Complete ”有一个很好的清单，你可以从中得到一些信息。 在我上一份工作中，我只是从他的章节标题中制作了一个模板，并从那里调整了它。

就功能规范而言，重要的是定义所有接口：

1. UI（屏幕样机）
2. 软件界面（插件等）
3. 硬件接口（如果适用）
4. 通信接口（服务，电子邮件，消息等）

还应该有一个业务规则部分，这些部分在功能上很重要，在任何接口定义中都没有涉及。

Answer 4

如果您想购买一本书， Karl Wiegers的软件要求包含一些文档的模板作为附录。 不幸的是，我在工作，那本书就在家里。 如果有人方便，他们可能会证实这一点。

Answer 5

这是我发现的最好的一个： http ： //www.jiludwig.com/templates/FRDTemplate.doc

Answer 6

我碰巧喜欢这个，其中包括： ReadySet 。

他也销售专业版。

Answer 7

从简单开始，从那里开始工作。 由于这是您第一次使用此功能，因此请使用带有项目符号的word文档。 写下来，重新阅读并提供足够的细节，这是有道理的。 对于技术规范，您可能希望引导开发人员寻求解决方案，但对于功能规范，应该完全忽略“如何”。

Answer 8

我建议在这里查看Roberston的Volere模板。 他们是大西洋系统公会的一部分，还有像汤姆德马科和Timothy Lister这样的“Peopleware”成名人士。

由于模板受版权保护，我不会在此处重现，但会为您提供一些主要标题：

1. 项目的目的
2. 利益相关者
3. 强制约束
4. 命名约定和术语
5. 相关事实和假设
6. 工作范围
7. 业务数据模型和数据字典
8. 产品范围
9. 功能要求
10. 外观和感觉要求......

还有更多，但这应该给你一个想法。 模板中最有趣的部分是需求shell，其中列出了一种提示卡的功能要求。 再次受版权保护，但真正有价值。

看看这里的第9章。