
应用需求文档,也叫应用需求说明,是在任何人动手构建之前,对应用的一份简短书面规划:谁会使用它、每个人看到哪些界面、它保存哪些信息、对接哪些服务、哪些暂不包含,以及这次构建最多花费多少。您阅读它、质疑它、修改它,只有当它描述的正是您真正想要的应用时,您才确认它。
之所以先确认需求说明,是因为在需求说明里发现错误成本最低。在纸面上挪动一行字不花一分钱。如果在构建完成后才发现辅导老师能看到所有家长的电话号码,或者学费无法分期缴纳,那就意味着要重新构建。
用大白话说,什么是软件需求说明?
在软件领域,需求说明(在较大的项目中常被称为需求文档,或 SRS,即软件需求规格说明)是需要应用的人与负责构建的人之间的约定。它说明应用必须做什么,而不是代码如何实现。对一家店铺、一个俱乐部或一所学校来说,只要写得具体、用语平实,一页通常就够了。
检验需求说明的方法很简单:两个不同的构建者读了它,能做出大致相同的应用吗?如果页面上写的是学生可以查看成绩,那只是一个愿望。如果写的是学生用手机号登录,按科目查看自己各次考试的分数,并与班级平均分并列显示,那就是一项别人可以构建、您也可以核对的需求。
一页应用需求文档包含哪些内容?
以一家想要管理课程、考勤和学费的辅导中心为例。一份有用的一页需求说明包含以下部分:
| 需求说明的部分 | 写的是什么 | 辅导中心示例 |
|---|---|---|
| 谁使用它 | 每类需要登录的人,以及他们能做什么 | 负责人、辅导老师、学生和家长;只有负责人能看到学费总额 |
| 按角色划分的界面 | 每个角色看到的页面,以及在页面上做什么 | 辅导老师:今日课程、记录考勤、录入考试成绩。家长:考勤、成绩、应缴学费 |
| 保存的数据 | 应用存储的记录,以及每条记录包含什么 | 学生、课程、每节课的考勤、考试和成绩、学费分期和收据 |
| 集成 | 对接的外部服务,以及如何对接 | 通过支付网关在线缴纳学费,每期都开具收据 |
| 暂不包含 | 这个版本不会做什么 | 不检查课程表冲突;不导入去年的记录 |
| 费用上限 | 这次构建最多花费多少 | 在确认之前就显示的上限,而不是做完之后的估算 |
按角色划分的界面是人们最容易一扫而过的部分,却也最重要。一个应用实际上是共享同一套数据的几个应用:负责人视图、辅导老师视图和家长视图。按角色逐一阅读界面,您才会注意到辅导老师可以记录考勤,却没有人能更正记错的考勤。
暂不包含这一行同样重要。它告诉您哪些东西您得不到,而这正是构建完成后常见的失望来源。一份简短、坦诚的排除清单,说明需求说明写得好,而不是写得差。
当您向 Deployflix 描述应用时,它写出的需求说明就遵循这种结构:谁使用应用、有哪些界面、保存哪些数据、哪些暂不包含,以及这次构建最多花费多少,并且使用您写作时所用的语言。如果您的描述有不清楚的地方,它会在制定方案之前先问您。工作原理展示了需求说明在各个步骤中所处的位置。
如何阅读并质疑应用需求说明?
不要像读合同那样从头读到尾,而要像过一遍您生意中的一天那样去读。
- 以每个角色的身份走一遍真实的一天。他们点什么、看到什么、输入什么?然后对其他每个角色都这样走一遍。
- 跟踪一条记录从头到尾。挑一个学生、一笔订单或一次预约。谁创建它,谁修改它,谁能删除它,它最终去了哪里?
- 找出不顺利的情况。预约被取消、退款、录入错误、付款失败、会员退出。如果需求说明只描述了一切顺利的情况,就问问出了问题时会怎样。
- 核对每一个您会打印出来的数字和文字。发票格式、学费分期、税额行和收据编号都应与您现在的做法一致。如果您的发票必须显示 GST、增值税或销售税等税项,请和您的会计师核对细节。
- 对任何含糊的地方都要提问。像管理、跟踪、方便和报表这样的词背后都藏着需要做的决定。问一问:哪份报表,显示什么,给谁看?
确认之前应该留意哪些漏洞?
大多数出问题的需求说明并不是写错了,而是不完整。下面是最常出现的漏洞。
谁能看到什么
角色很容易列出来,也很容易写得含糊。检查每个角色能看到什么,而不只是能做什么。辅导老师能看到学费吗?一位家长能看到别人孩子的成绩吗?员工能下载客户名单吗?如果应用保存个人信息,现在就决定谁能看到。
编辑、取消和撤销
每条记录总有一天需要更正。确认需求说明写明了谁可以编辑或取消一条记录,以及旧的数值是否会保留。
钱
如果应用需要收款,需求说明就应列明支付流程:顾客可以使用哪些方式付款(银行卡和本地支付方式)、支付什么费用、是否允许部分付款、付款后会收到什么,以及未付款或付款失败时如何处理。退款规则由您的企业决定,请写清楚。支付网关通常按每笔交易的一定比例收费,在许多国家还会加收固定费用,因此请查看您所用网关的价格页面。Deployflix 应用通过 Razorpay 或 Cashfree 等支付网关收款;国际支付网关即将上线。我们的集成页面列出了目前可连接的服务。
消息和提醒
如果您需要提醒,请说明提醒应如何送达:通过邮件、应用内通知,还是其他方式。如果需求说明没有提到发送渠道,就默认没有这项功能。
您现有的数据
电子表格和旧登记本往往需要迁移到新应用中。问清楚导入这些数据是包含在需求说明里,还是列在暂不包含清单中。
设备和语言
用户会在手机、店铺柜台的电脑上使用,还是两者都会用?除了英语,是否还需要支持西班牙语、阿拉伯语、法语或其他语言?这些决定会影响界面设计,因此请在构建前确定。Deployflix 会用您指定的语言编写应用中的文字,本身支持 41 种语言。
为什么要在构建之前确认需求说明?
因为改一句话比改一个应用便宜。在构建之前,增加家长角色或一项学费分期,只是在页面上改几个字。构建之后,同样的修改可能会牵涉到已经完成的界面、数据和权限。
确认需求说明也让您有了核对成品应用的依据。构建完成后,打开需求说明逐项打勾:每个角色、每个界面、每项数据。缺少的任何内容,都是可以合理提出的问题。
需求说明也会在您决定开始前明确费用。一次构建的费用上限写在需求说明中,您可以看着明确的数字做决定。在 Deployflix,这一上限会在您确认前显示,而您只需按构建实际消耗的积分付费,具体说明见价格页面。
应用构建完成后,修改如何规划?
应用很少有真正做完的时候。新开一门课、开第二个地点、换一种收费方式:每一项都值得像第一次构建那样认真对待。
把每次修改当作一份小型需求说明来规划:改什么、涉及哪些角色和界面、增加或更改哪些数据、哪些保持不变,以及可能花费多少。用同样的问题去阅读它,并在开工之前确认。保留之前的版本,这样如果修改出了问题,您可以回退到之前好用的版本。
Deployflix 就是这样处理修改的:您说出要改什么,它把这次修改规划为下一个版本,在确认之前什么都不会构建。之前的每个版本都会保留。在组织中,只有角色允许的人才能确认,详见安全页面。
一份可以直接使用的应用需求说明模板
如果您要自己写需求说明,可以复制下面这些标题,并用平实的句子逐项填写:
- 一句话介绍应用:它为谁而做,要完成什么工作。
- 角色:每类用户,以及他们能看到什么、做什么。
- 按角色划分的界面:每个角色有哪些界面,每个界面上发生什么。
- 保存的数据:每类记录及其包含的信息。
- 集成:支付、您的域名、应用商店、代码存放在哪里,以及它要连接的其他任何服务。
- 规则:费用、限制、截止日期、取消和退款。
- 暂不包含:这个版本不会做什么。
- 费用上限和确认:最多花费多少,以及由谁签字确认。
想看角色、界面和数据的实际示例,可以参考辅导机构班级管理系统EN或诊所预约应用EN。验证想法的创业者可以把需求说明写得更短,只有一个角色、几个界面,再加上一份明确的暂不包含清单,就像创业公司 MVP 网页应用EN那样。
问题
应用需求说明和需求文档有什么区别?
主要是篇幅和正式程度不同。大型项目的需求文档可能有很多页带编号的需求条目。小商家的应用需求说明用一页纸、平实的语言,涵盖同样的内容(谁使用、做什么、保存什么)。
应用需求说明应该由谁来写?
由了解生意的人提供内容:角色、日常工作和规则。构建者可以把这些整理成结构化的需求说明,但只有您才能判断它对不对。
确认需求说明之后还能修改吗?
可以。把它当作一次修改:描述哪里不同,阅读更新后的方案,然后再次确认。保留之前的版本,以便对比或回退。
应用需求说明应该写多长?
长到重要的事情都不用靠猜,短到您会把它从头读完。对大多数小商家的应用来说,一页就合适;如果写得长很多,可以考虑分阶段构建。
描述您的应用
用您自己的话写下需求。Deployflix 会写出一页方案并附上费用,只有在您确认后才会开始构建。
已复制。登录 Deployflix 后粘贴即可。