如何编写系统需求规范 (SRS) 文档

想象一下，您负责设计一栋 17 层高的建筑，但缺少蓝图。如果没有这份重要文档，整个项目将面临严重错误的风险。启动一个新的软件项目也类似，如果没有蓝图，您很可能会生产出一个缺乏必要软件功能且不符合客户需求的系统。明确的需求（例如系统需求规范 (SRS) 文档中包含的需求）可奠定基础，确保您的团队交付正确的产品并避免昂贵的返工。

但您应该从哪里开始呢？在本文中，我们将详细介绍 SRS 文档及其使用方法，并提供示例，帮助您走上成功之路。

什么是系统需求规范 (SRS) 文档？

SRS 文档重点介绍软件需要做什么以及必须如何执行。它奠定了重要的基础，以便参与项目的每个人都能了解最重要的细节。

SRS 文档概述了系统所需的行为、功能和能力，以及任何潜在的约束。包括功能性和非功能性需求。不包括客户要求之外的设计建议和信息。

已收到所有必要利益相关者的批准，表明他们清楚地了解项目要求并且每个人都同意。从某种意义上说，SRS 文档充当了任何一方在遇到不确定性时都可以参考的保险单。

为什么要使用 SRS 文档？

使用 SRS 文档可确保项目细节清晰明了，从而降低浪费时间和潜在返工的风险。使用此类文档的重要好处包括：

• 提供有价值的客户反馈。SRS 文档是客户确认贵组织了解需要解决的问题以及软件必须如何应对挑战的确认。图表和表格等视觉效果可以提供额外的清晰度。
• 将工作分解成更小的部分。SRS 文档包含大量信息，但它们最终将问题分解为更小、更易于管理的部分。
• 作为父文档。SRS 是其创建后任何其他文档的父文档。工作范围、软件设计规范和其他文档通常会利用 SRS 文档中突出显示的内容。此外，它可以作为产品验证检查。我们做对了吗？检查 SRS 文档。

SRS 文档有助于在开发过程的早期发现问题，从而有助于更有效地管理时间。例如，在开发开始之前更新规范要比在开发过程的后期更新规范容易得多。

SRS 文档格式：系统需求规范文档是如何编写的？

与遵循食谱类似，SRS 文档中有几个重要的组成部分或成分。一份好的文档需要回答几个关键问题，例如：

• 软件应该做什么？
• 它应该如何表现？
• 性能要求是什么？
• 是否有任何需要注意的限制？如果有，它们是什么？

一个好的起点是 SRS 大纲。各个部分的粗略大纲可以帮助您准备填写重要细节。请考虑以下几点：

• 创建简介。简介介绍了软件需要做什么（以及不应该做什么）。开发团队和产品所有者应该参与编写计划的这一部分。为什么需要构建产品？它解决了哪些挑战？谁将使用该产品？此外，SRS 简介可能包含文档内容的概述。
• 撰写一般描述。关注产品的功能。定义所需的硬件和用户界面。最终用户期望软件做什么？各种功能有哪些？最终，本节将重点介绍系统界面、用户界面、硬件界面、软件界面等。此外，还需要包括任何重要的假设。
• 包括具体要求规范。本节检查有关产品的具体细节，以便更容易设计和验证产品是否满足要求。它描述了软件必须处理的所有输入，突出显示了任何所需的结果，并明确定义了任何必要的集成。还应包括性能标准以及任何软件系统属性，例如可读性、可用性、安全性、盈利能力等。

有了基本大纲后，您就可以在团队和客户的帮助下开始填写。完成后，获得最终批准。对项目重要的每个人都需要审查并批准文档的最终版本。

SRS 文档中包含的需求规范多种多样，因此没有一个通用的模板。但是，可以使用诸如此类的通用软件需求模板来创建文档的“骨架”。然后，您可以随时填写详细信息。

系统需求规范文档中不应包含哪些内容？

随着您在编写 SRS 文档方面的经验越来越丰富，这个过程将变得更快。但是，在开始时，列出要避免的常见错误会有所帮助。请考虑以下几点：

• 未包含完整的词典。您的 SRS 文档是否包含只有特定行业的人才能理解的术语？如果是，请创建一个词典部分以便于查看，并包含任何不常见的术语的定义。
• 混合概念造成混乱。保持文档井然有序，并小心地以合乎逻辑的流程向读者呈现信息。避免在整个文档中混合概念，以免造成混乱。
• 不完全了解最终用户。谁将与软件交互，预期结果是什么？例如，假设一个软件应该生成报告。部分要求涉及用户如何单击特定按钮来生成各种报告。确保您知道对报告生成软件的期望，也知道谁在单击该按钮，以便您更好地了解用户和所需的功能。
• 太模糊。确保您的要求不会导致不明确的解释。 SRS 文档旨在防止误解，因此请确保文档不会产生误解。对于每个功能或情况描述，请确保不要提供尚未定义的规范。

软件如何简化 SRS 文档的创建？

有助于简化需求规范的资源有助于编写 SRS 文档。例如，Jama Connect 是一个旨在跟踪整个产品开发生命周期的中心，使产品经理和工程师能够在多个层面跟踪需求、决策和关系，并有效地交付合规、市场驱动的产品。

Jama Connect 通过协调利益相关者、尽早识别风险以及在整个开发过程中可视化法规、需求和测试用例之间的联系，帮助团队按时、按预算交付高质量的产品。如果您正在寻找一种简化编写 SRS 文档的解决方案，请确保它提供：

• 信心。可追溯性要求应该在整个开发过程中显而易见，阐明风险并让您满怀信心地继续前进。
  可见性。该解决方案应通过监控系统、团队、活动和结果之间的关系和依赖关系来提供对产品开发过程的可见性。
• 速度。应提供快速协调，这有助于跟踪决策、提高效率和最大限度地减少返工，从而按时按预算生产出高质量的产品。
• 适应性。确保解决方案能够轻松适应您组织的工作流程，为您的团队创造直观的体验，让他们快速上手。
• 性能。确保系统提供基准并监控团队的长期绩效，以更好地了解重新调整产品开发流程的好处。
  总体而言，您要确保任何有助于简化 SRS 文档创建的软件都能让您的团队具备分析影响、跟踪决策和确保您要构建的产品的质量的能力。

取得更大的成功

设计一个强大的 SRS 文档可确保您拥有一份适用于整个开发项目的“首选”文档。目标是在程序开发过程之前消除任何潜在的实施障碍。但同时，文档需要灵活且可扩展，以便根据产品需求轻松修改。

在编写和审查需求时牢记上述提示，可以让您创建一个与客户需求紧密结合的项目，避免代价高昂的错误，并最终支持您构建更好的产品。