94、优秀需求文档撰写指南

优秀需求文档撰写指南

1. 书面需求应包含的内容

需求的目的是列出产品应具备的所有要素，涵盖机械、电气、软件、人机界面、电源、安全等各个方面。但这并不意味着一个简单产品的需求文档就得长达 1000 页，然而仅用一段文字或几个示例场景也不足以涵盖所有必要细节。

1.1 需求的宏观意义

拥有书面且完整的需求有诸多重要意义：
- 确保不遗漏任何事项。
- 在投入时间构建无法满足所有需求的系统之前，提前把握整体情况。
- 为后续设计过程提供支撑，例如完善的测试计划会确保对需求文档中的所有内容进行测试。
- 作为与利益相关者沟通的工具，表明“完成后，系统将按此文档所述运行”。

需求应全面，产品必须做的、不能做的以及必须满足的所有约束条件都应包含在内。虽然较长的文档创建和维护成本更高，但需求文档的合适篇幅需根据具体情况权衡，关键是不能遗漏重要内容，同时遵循“简洁至上”原则。需求文档无需辞藻华丽，要点式表述、短语形式均可，只要意思清晰，目标是简短易读。

由于没人能全知全能，期望需求从项目一开始就完全正确并不现实。但提前尽可能详细地记录需求能避免许多不必要的问题，而且该文档可作为收集后续发现或变更需求的载体。

若系统在初始阶段新颖或定义模糊，可先进行原型开发。在桌面计算机等资源丰富的平台上进行原型开发，有助于开发算法、获取客户对潜在替代方案的反馈，从而明确需求。但要注意，不能将原型代码误当作初始产品。原型开发完成后，应丢弃原型，根据所学内容编写需求，然后开始开发具备产品质量的软件。

1.2 需求的类型

需求主要分为以下三种类型：
| 需求类