ARTICLE · INTELLIGENCE

战地情报 · 详情页

来自尧图项目组的一线实战观察与深度解析

26页SRS模板:需求文档拆分、非功能指标与追踪矩阵

26页SRS模板:需求文档拆分、非功能指标与追踪矩阵

简介:面向软件研发团队、需求分析师及计算机相关专业学生,这份软件需求规格说明书模板用于解决SRS结构不统一、章节遗漏和评审要素不全的问题。整包为1个doc文档,约1.34MB,采用26页左右的正式文档版式,围绕引言、需求分析理论与目标、需求概述、系统功能需求、接口与软硬件环境需求、验证确认与签字审核等主线展开。目录中可见项目背景、条件与限制、移动办公系统结构与网络拓扑、界面显示与待办公文列表、公文详情、网站信息审批、会议申请、意见录入、移动邮件、会议管理、通知通告、通讯录、车辆管理、电子公文预览及政务信息平台等功能条目,并配有版本更新记录和审核意见栏。已有1126人学习,适合需要快速搭建需求文档框架、对照检查功能覆盖度并形成评审闭环的读者参考,版本记录、章节层级与审核签字表均可直接套用。

1. 需求先立住:一份 26 页的 SRS 模板能挡住多少返工

接手一个移动端办公系统升级项目,甲方给的材料往往只有一页纸,加一句「参照原有系统做,加个手机端就行」。真正让项目卡住的从来不是写代码,而是把这句话变成一份能评审、能签字、能拿去验收的软件需求规格说明书。这套模板解决的问题很具体:它把一份约 26 页的 SRS 拆成引言、需求概述、系统功能需求、接口需求、非功能需求五个可交付部分,每一节都留了填写口径和真实模块示例,覆盖移动办公、车辆管理、电子公文预览、信息资源管理平台四类典型模块。做毕设或课设的人可以照着它的章节结构交一份完整文档,接互联网项目要出交付物的人,也可以直接把这套骨架搬过去改。适合谁?手里有需求但写不成文档的人,以及文档写了却总在验收阶段被推翻的人。

2. 文档骨架:版本表、审核确认表与条件限制的填写口径

一份需求文档的可信度,有一半不在正文,而在开头那几张表和最后那几行字。模板的文档头包含三块内容:版本更新概要、项目负责人审核与确认、以及文档信息(项目名称、文档名称、文档 ID、说明、作者、最后更新时间)。这三块如果只填个日期,文档就退化成了「聊天记录整理稿」,后面任何一次需求变更都会变成扯皮。

2.1 版本表要写「改了什么」,不是「哪天改的」

模板里的版本表长这样,字段是版本号、时间、更新人、更新摘要:

版本号时间更新人更新摘要
V1.02011-10-02需求负责人移动办公、车辆管理模块需求内容
V1.12011-10-20需求负责人信息资源管理系统平台需求内容
V1.22011-11-08需求负责人根据业务需求补充电子公文在线预览

注意第三列写的是模块名加动作,而不是「修改若干处」。这份摘要的价值在于:评审会上有人问「移动端公文预览是哪一版加进来的」,你翻到这张表就能答出来,而不是靠回忆。我一般会再加一条硬规则——每个版本号必须能对应到功能清单里的一批条目编号,摘要里的模块名要能在第三章的表格中检索到。做不到这一点,就说明这次变更没有落到条目上。

2.2 审核确认表是这份文档唯一有约束力的部分

模板给的确认表字段很朴素:姓名、职位、审核时间、审核意见(签字),并且分成供应商方和客户方两栏。很多团队把这张表放在文档末尾当装饰,签完就归档,结果需求一变,双方各执一词。

通常的做法是:确认表按模块拆成多轮签,而不是整本签一次。比如 V1.0 只签移动办公和车辆管理两个模块,V1.1 签平台部分。每轮签字前必须冻结该模块的功能清单,冻结之后再提的新需求走下一个版本号。这样做的好处是责任边界清楚——某个模块上线后功能对不上,翻签字页就知道当时确认的是哪一版清单。

提示:审核意见栏不要只写「同意」。写「同意,但待办公文列表排序规则以本文档 3.2 节为准」这种带指向的意见,比一个签名有用得多。

2.3 项目背景与需求概述:一句话需求要展开成四层

模板第二章的目录是项目背景、需求概述、条件与限制、系统结构、网络拓扑图。这五节的顺序不是随便排的,它对应四层递进:为什么做(背景)、做成什么样(概述)、受什么约束(条件与限制)、长什么形状(结构与拓扑)。

以移动办公为例,背景层写的是业务动因:外出人员需要批阅公文、收发邮件、查通讯录,目标是「随时随地处理」。概述层要写清 4A 的落地含义——任何地点、任何时间、任何数据、任何设备,这四个词听着像口号,落到文档里必须变成可检查的条目:支持哪些终端系统版本、支持哪些无线网络环境、哪些业务在移动端必须闭环。结构层再往下落到四层安全控制域:

层次职责交付边界
终端用户层面向各类手机终端提供展现,客户端程序安装后使用客户端适配与界面规范
运营商服务层提供无线网络环境,兼容多种制式与接入方式接入配置与适配测试
业务逻辑层核心业务处理,含基础服务、解析引擎、访问安全管理、通用组件、系统管理服务端开发主体
外部系统层与办公自动化系统及其他业务系统适配接口与数据映射

这张表最实际的作用是划分工作量。终端用户层和业务逻辑层是自研范围,运营商服务层是外部依赖,外部系统层是集成范围。写文档时把「谁的活」标出来,报价和排期才有依据。

2.4 条件与限制:把「必须满足」和「不能碰」分开写

模板把这一节标了「可选」,但在实际项目里它往往是返工率最高的一节。写法上分两栏:必须满足的条件(输入数据范围与格式)、所受的限制(软件环境、硬件环境、技术与工具约束、标准与规范、经费与工期、对外部组件的依赖)。

移动办公项目里最典型的一条限制是终端系统版本:要求支持某三个移动操作系统的最低版本以上。这句话同时是限制和验收门槛——版本号写进文档,测试同事才知道兼容性矩阵怎么排;不写,就只能等上线后用户反馈「我的手机打不开」。

另一条容易漏的是「必须使用或避免的特定技术、工具、编程语言和数据库」。电子公文预览这个需求里,明确要求对现有交换平台和移动办公系统做最小改动,这就是一条强限制,它直接决定了后面只能走中间层组件的方案,而不是改两端。限制写得越早,方案就越不会被推翻。

3. 功能需求拆分:模块清单、界面元素与业务实体表的三级落笔

第三章是整份文档的主体,也是最容易写成「功能罗列」的地方。模板给出的组织方式是三级下钻:功能模块 → 实现功能 → 界面元素与交互规则。移动办公的清单从登录、收文审批、发文审批一路排到短信中心、性能测试,粗看像一张菜单,但真正决定验收的是第三级。

3.1 功能清单表:模块要拆到「可独立验收」的粒度

按模板的写法,功能清单是两列表:功能模块、实现功能。移动办公部分大致分成这几组:

功能模块实现功能
登录登录
审批收文审批、发文审批、内办文审批、合同处理审批、待办待阅信息审批、督办审批、会议审批
阅文收文阅文、发文阅文、内办文阅文、合同处理阅文、信息阅文、督办阅文、会议阅文
公文流转公文排序、公文流转、公文发送、查询公文、公文查询结果列表
会议会议通知列表、会议通知详情
移动邮件收邮件、回复邮件、转发邮件、发送邮件、邮箱设置
通讯录组织结构树、人员列表、人员详情
通知通告通知通告列表、通知通告详情
批示与授权领导批示列表与详情、代理授权列表与详情、代理授权人员结构树
名片与消息机关名片列表与详情、拨打电话、发送短信、消息列表与详情、消息附件、回复消息
短信中心短信列表、短信详情、发送短信、接收短信

拆分标准不是「功能多少」,而是「能不能单独写一条验收用例」。收文审批和发文审批看起来同构,但界面元素完全不同——收文有来文单位,发文有主送、抄送、拟稿人、密级。合并写成「公文审批」,测试同事就得靠猜。

3.2 界面级需求:列表排序、字段显示、文件类型这些「小事」才是验收点

模板在移动办公部分花了大量篇幅写界面规则,这些内容看着琐碎,实际是验收时唯一能逐条打勾的东西。

待办公文列表规定两行显示:第一行是公文速级图标、业务种类、接收时间;第二行是公文标题。排序规则写了三条——按业务种类、按速级(特急、急件、平件)、按接收时间。这三条并列在一起时,文档必须补一句优先级,否则两个开发能写出两种顺序。我一般补成:「先按速级降序,同速级内按接收时间降序,业务种类仅用于分组展示」。这种句子写进文档,评审会就不会卡在这里。

公文详细信息界面则按公文类型分别列字段:收文要写来文单位、紧急程度、标题、内容摘要、意见;外发文要写主办单位、主送单位、抄送单位、事由(标题)、紧急程度、拟稿人、密级、意见;内办文在上述基础上增加历史意见;督办事项要写名称、承办部门、会办部门、密级、紧急程度、督字号、督办类别、要求完成时间、历史意见。字段清单直接对应后端的返回结构和前端表单校验,少一个字段,就是一次返工。

文件类型是另一处必写项。正文限定为 Tif、Doc、ceb 三类,附件类型不限制,但 Office 系列、图片格式、Tif 可以在手机端直接浏览,其余走下载;超过 5M 的文件提供下载但不保证在线预览。这三句话翻译成开发任务就是:服务端要做格式判定、要做大小阈值判断、客户端要准备两套呈现路径(内嵌预览、下载提示)。如果只写「支持常见格式在线预览」,上线后一定会出现「为什么我的 PDF 打不开」的工单。

意见录入部分同样如此。要求支持直接输入,也支持从常用词条中选择,词条分公用和个人两类;审批意见发送时先选环节,环节顺序与后台办公系统保持一致,下一环节数量在 1 到 4 个之间时用多级下拉联动,上级选定后下级自动过滤不可选项或自动选中必选项;当意见发往默认环节的默认人员时,跳过环节和人员选择界面直接发送。这一段文字背后是三个交互分支,写成这样,前端才不用反复确认。

3.3 业务实体落表:一车一档的字段清单应该出现在需求文档里

车辆管理模块的要求是「一车一档」「一人一档」,并且列出了完整字段。这类内容很多人觉得该放到数据库设计里,但需求文档不写,设计阶段就要重新找业务方确认一遍,而业务方往往记不全。我倾向于在功能需求里直接把实体字段列成表,再附一段建表语句作为落地示例。

-- 车辆档案表:对应需求文档中"一车一档"的字段清单 CREATE TABLE vehicle_archive ( id BIGINT PRIMARY KEY, plate_no VARCHAR(16) NOT NULL, -- 车牌号,业务唯一键 vehicle_type VARCHAR(32) NOT NULL, -- 车辆类型 owner_dept VARCHAR(64), -- 使用人或单位 oil_card_no VARCHAR(32), -- 油卡号,用于油费对账 buy_date DATE, -- 购置日期 buy_amount DECIMAL(12,2), -- 购置金额 engine_no VARCHAR(32), -- 发动机号 vin VARCHAR(32), -- 车架号 brand_model VARCHAR(64), -- 厂牌型号 load_weight DECIMAL(8,2), -- 载重量 seat_count INT, -- 可乘坐人数 status TINYINT DEFAULT 1 -- 在用/报废状态 );

这段建表语句不是让你照抄字段类型,而是提醒一件事:需求里列的每个字段,都要能回答「谁维护、什么时候填、能不能为空」。车牌号定为业务唯一键,是因为后面的费用登记、维保记录、用车申请都要靠它关联;油卡号单独留一列,是因为油费统计要按卡号对账;状态列区分在用和报废,是因为统计分析只应统计在用车辆。把这些判断写进文档的说明段落,比在数据库评审会上再吵一遍省事得多。

车辆管理模块的其余部分同理:驾驶员档案一人一档,字段含姓名、性别、出生年月、驾驶证号、领证日期、证件有效期、开始驾驶时间、准驾车型、联系电话、年审记录;费用管理记录车牌号、车辆类型、加油时间、记账时间、卡号、加油站名称、油号、单价、数量、金额;维保记录记维保时间、维保内容、维修人;供应商档案记编号、名称、全称、联系人、电话、地址;维修计划记设施名称、车辆名称、型号规格、计划时间、完成时间、维护内容;安全检查记车辆号码、建制司机、行驶里程、检验结果、检验员签名、检验时间、建议、备注。用车申请则明确要求在现有办公系统上走审批流程,这一条把车辆模块和外部系统的边界划清了。

3.4 统计分析类需求:报表不写维度就等于没写

模板对统计分析的要求是生成车辆油费统计、用车申请记录统计、维保记录统计,并支持月报、季报、年报。写这类需求最容易犯的错是只写报表名。合格的写法至少包含四项:统计维度(按车辆、按部门、按时间段)、时间口径(自然月还是记账月)、指标定义(金额含不含税、里程取哪次录入值)、输出形式(页面展示还是导出表格)。

权限管理那条也值得单独说一句。文档要求权限模块具备上下级相互独立运作、层级控制的特点。这句话翻译成可验收的条目是:上级账号可查看下级汇总数据但不可代下级录入;下级管理员只能管理本单位人员与车辆;跨级查询需显式授权。写不出这三条,权限模块做完一定被退回。

4. 接口与非功能需求:四层结构、交换流程与可量化指标

第四章和第五章在模板里篇幅不长,但它们是评审会上最容易被追问的部分——因为功能需求可以演示,接口和非功能只能靠文档自证。

4.1 结构与拓扑:把四层安全域映射到交付范围

第二章讲过的四层安全控制域,在接口章节要再落一次地,因为每一层对应的接口形态不同。终端用户层对应的是客户端与服务端之间的数据请求接口;运营商服务层对应的是网络接入配置,不产生自研代码;业务逻辑层对外暴露的是业务服务接口;外部系统层则是与办公自动化系统之间的适配接口。

网络拓扑同样要写清三侧划分:终端侧是发起请求的终端设备和软件,网络侧是运营商网络,机房侧是承载移动化系统和通信设备的服务器群。车辆管理模块的拓扑更简单——车辆管理服务器及数据库与办公系统服务器及数据库部署在同一局域网内,通过系统接口实现统一登录认证。这一句「同一局域网 + 统一登录认证」就是交付约束:不新建独立账号体系,不跨网部署。

注意:拓扑图不要只画框。每个框旁边标注协议、端口归属方和是否在自研范围内,评审时能省掉一半解释。

4.2 接口需求:中间层组件的三件事与交换流程的五步

电子公文预览这个需求是接口章节的典型样本。约束是最小改动,方案是在两个系统之间搭一个中间层组件,它只做三件事:把移动办公访问电子公文的请求重定向到中间层;把交换平台里的公文转换成移动办公能识别的格式(一般是扫描件格式);把转换后的文件以流的形式返回终端显示。

这三句话对应三个可测点:重定向规则是否覆盖全部公文访问入口、格式转换的成功率与耗时、文件流返回是否支持断点与大文件。文档里把这三条写成验收条目,测试同事就能直接排用例。

公文交换网络的结构更复杂,由五类组件构成:

组件定位职责
OA 交换边缘组件为办公系统提供收发文及相关子服务,通过前置接口接入交换网络
OA 前置边缘组件一端接 OA 交换,一端通过消息队列或服务接口接交换接口
交换接口核心组件隔离核心交换、分担网络压力,提供交换服务与查询服务
交换核心核心组件路由、单位与人员管理、交换跟踪、指令分析应答、数据分解合并、核心传输、加解密与签名验证
CA 认证支撑组件提供数字签名与数据加解密,仅与核心交换相连

交换流程分五步:生成交换对象并签名加密、按同步或异步通道传输、核心解析路由并分发给 N 个接收单位、逐级下发至目标 OA、目标端验签解密入库。流程之后还有回执机制,这是最容易被漏掉的部分:每级成功提交后反向发送送达回执,任一环节失败则由前一系统反向发送失败回执,接收方解析入库成功后还要发一条入库回执,解析、解密、验签、入库任一失败则发解析失败回执。

三类回执写进文档的意义在于:它是「公文到底送没送到」的唯一证据链。没有这一节,运维阶段排查「对方说没收到」就只能靠日志盲猜。

4.3 非功能需求:性能、安全、扩展性都要写成可判定条目

模板第五章列了性能需求、安全设施需求、安全性需求、扩展性需求、可移植性需求。这五节的通病是写成形容词。下面这张表是我一般会采用的写法对照:

类别不合格写法可判定写法
性能系统响应快待办公文列表首屏在 3G 网络下加载不超过 3 秒,列表滚动不卡顿
性能支持多人使用并发在线用户 500 人时,登录与列表接口成功率不低于 99%
安全设施保证安全采用数字证书认证,传输链路加密,公文正文与附件均需鉴权后访问
安全性权限控制完善未授权用户访问他人公文详情返回无权限提示,且记录审计日志
扩展性易于扩展新增一个业务模块只需增加配置与页面,不修改核心服务代码
可移植性兼容性好客户端在三类终端系统的最低版本以上均可完成登录与审批闭环

这些数字不是拍脑袋来的,通常的做法是先取现有系统的实测值作为基线,再按业务增长预期上浮。写不出数字时,至少写出测量条件——什么网络、什么数据量、什么操作路径。有条件、有阈值,这条非功能需求才算成立;否则验收会上没人能说清「到底算不算达标」。

接口需求那一节还要覆盖用户界面、硬件需求、网络需求、通信需求、运行环境五项。运行环境要写到具体版本区间,硬件需求要写到终端最低配置与服务端部署规格,通信需求要写明同步调用和异步消息各自适用的场景。这几节内容不多,但缺一项,部署阶段就要临时补文档。

5. 避坑:需求文档里最容易翻车的五处

下面五条都是我在评审会上真实见过被退回的写法,按「现象—原因—解决」逐条拆。

5.1 范围与版本上的两个坑

坑一:版本表只写日期,不写变更摘要。

现象是文档改了七八版,版本表里全是「修改」「优化」两个字,评审时没人说得清某个功能是哪一版加的。原因是把版本表当成了形式主义的签字页,更新时顺手填个日期。解决方式是规定摘要必须写「模块名 + 动作 + 影响范围」,例如「车辆管理模块,新增安全检查记录字段,影响统计报表口径」,并且每个版本号在功能清单里能检索到对应条目。做不到就不允许升版本号。

坑二:把「参照原有系统」当成需求写进去。

现象是文档里反复出现「与原有系统保持一致」,开发和测试都按各自理解推进,上线后界面和交互全不一样。原因是这句话看起来省事,实际上把定义权交给了每个人。解决办法是把「一致」拆成可枚举项:一致的到底是字段集合、排序规则、还是操作路径?模板里公文详情、通知通告详情都写了「界面元素与 OA 中一致」,合格的补充是在其后附一张字段对照表,把 OA 的字段名和移动端字段名一一对应。凡是出现「保持一致」四个字的地方,后面必须跟一张表或一段枚举。

5.2 功能与验收口径上的三个坑

坑三:排序规则只写一条,或写了多条不写优先级。

现象是待办公文列表在测试环境按时间排,在生产环境按速级排,两边都说自己符合文档。原因是文档同时列了按业务种类、按速级、按接收时间三条规则,却没写谁优先。解决方式是固定成一条判定链:先速级降序,同速级按接收时间降序,业务种类作为分组标签而非排序键。同理,会议列表写明只按会议时间倒序、只显示一周并可查上下周,通知通告列表只按发布时间倒序——一条规则就够,但要写死。

坑四:接口只写「对接 OA」,不写字段、方向和失败处理。

现象是联调阶段双方各拿一份自己理解的字段表,对不上就互相等。原因是把接口当成一句话需求。解决办法是每个接口至少写四项:调用方向(谁调谁)、传输内容(关键字段与必填性)、同步还是异步、失败回执怎么走。公文交换那套回执机制就是范本——送达回执、失败回执、入库回执各有触发条件,写清楚之后,运维排查才有依据。

坑五:非功能需求写成形容词。

现象是验收会上甲方说「感觉有点慢」,乙方说「已经很快了」,谁也说服不了谁。原因是没有测量条件和阈值。解决办法按上一章那张对照表来写:指标、条件、阈值三件套齐全,并约定测量方法(用什么网络、什么账号、什么数据量、取第几次加载)。写不出来的指标,就先标为待定并在评审会上定责任人,而不是用「良好」「完善」糊过去。

6. 验收与答辩:把 SRS 变成可评审、可追踪的交付物

文档写完不等于交付完成,真正决定它能不能过关的是两场会:需求评审会和答辩(或验收)会。

6.1 评审会怎么开才不流于形式

会前三天把文档发给三方:业务方、开发负责人、测试负责人,并要求每人至少提三条意见,提不出就说明没看。会上不逐页念文档,只走三件事:过版本表确认本轮冻结范围;过功能清单逐条确认「做/不做/下期做」;过非功能需求逐条确认阈值是否可测。每条结论当场记进会议纪要,落到文档对应条目上,会后一个工作日内出修订版。

6.2 用一张追踪矩阵兜住「需求有没有被实现」

评审通过后,我一般会维护一张需求追踪矩阵,三列就够:

需求条目设计/实现位置验证方式
待办公文列表排序规则(3.2 节)列表服务排序接口构造三种速级与不同接收时间的数据,核对顺序
附件超过 5M 仅下载不预览(3.2 节)附件服务大小判定上传 5M 上下各一个文件,检查呈现路径
公文交换三类回执(4.2 节)交换核心回执模块模拟送达、失败、入库三种场景,检查回执生成
并发 500 人登录成功率(4.3 节)服务端压测压测工具模拟 500 并发,统计成功率与响应时间

这张表的价值在验收阶段体现得最明显:甲方提「这个功能好像没做」,你翻到矩阵第三列,把验证记录拿出来,讨论就从主观感受变成了事实核对。答辩时同理,评委问「你怎么保证需求都实现了」,矩阵比任何口头解释都有说服力。

我吃过一次亏:早期做项目时文档写得挺厚,但从来没做过追踪矩阵,验收会上对方随口一句「当时说的那个排序不是这样的」,我翻遍文档也找不出反证,最后只能返工。从那以后我每次交需求文档,都强制走一遍「版本表—功能清单—追踪矩阵」这三步,宁可多花两天,也不在验收阶段补课。希望这套模板和上面的写法,能帮你在下一个项目里少走一遍这条弯路。

本文还有配套的精品资源,点击获取

RELATED READING

延伸阅读

更多一线实战笔记与深度复盘,助您持续精进