1. 导言
我也来个导言: 写这篇博客的目的就是来解答一下下面几个问题:
- 需求文档怎么写?
- 需求文档都应该包含哪些内容?
- 怎样才算一个合格的需求文档?
产品需求文档(Product requriement document),全称应该叫做“产品需求规格说明书”,简称PRD。
说明书大家都见过吧,有简短的,有冗长的像论文一样的,既然是说明书,那没有什么特定的格式,只要能把产品写清楚就可以。
这里总结一下比较通用的大纲,不会写的照这个大纲写,出入不会太大。
2. 正文
产品需求文档怎么写,这里提供一个大体的通用框架:
2.1 大纲
标题:XXXX项目产品需求规格说明书V1.0.0文档信息修订记录目录1. 导言1.1 编写的目的(例如:本文档为“XXXXXX”项目的产品需求文档,主要用于为软件开发提供需求说明分析,明确所要开发的平台应具有的功能、性能及界面,为该项目的UI、开发、测试等相关人员提供参考,作为开发阶段的输出文档,指导项目开发人员进行功能开发工作,同时为测试人员编写测试用例以及产品功能测试报告提供依据。)1.2 文档范围(例:此文档主要描述“XXX”项目中的功能逻辑一级业务规则等。包含小程序端、XXX端、XXX端,对这些平台的功能模块的产品设计进行了详细的描述。)1.2 项目概述(项目的起源、目标)1.2 预期读者(本文适合于XXXX项目中的PM、UI、BA、SA、开发人员、测试人员等阅读。)1.3 参考文档(如有)1.4 术语表2. 需求说明(或功能概述)需求列表说明、分析3. 功能实现3.1 业务流程图(一般都有)3.2 用例图(如有)3.2 数据流图(若有)3.3 状态图(若有)3.4 模块一3.4.1 XXX功能3.4.1.1 功能描述3.4.1.2 界面原型(圆形截图)3.4.1.3 界面元素(即对原型界面上的字段进行列举和描述。视情况)3.4.1.4 按钮说明3.4.1.5 业务规则(样式、动作、交互、规则等都可以这里,尽可能详细到每个点)3.4.1 XXX功能3.5 模块二3.5.1 XXX功能3.5.2 XXX功能4. 其他3.5.1 安全性需求3.5.2 性能需求3.5.3 可维护性需求5. 附录(可以包括一些补充信息,如参考文献、详细的术语表、项目进度计划等)
2.2 补充
这里补充一些常见的表格样式等
文档信息表格:
修订记录表格:
术语表格:
需求说明表格(适用于小需求):
目录:
3. 总结
水无常形,人无常势,任何东西都是可变的,选择性借鉴,不可拘泥于某种形式。