524 lines
17 KiB
Plaintext
524 lines
17 KiB
Plaintext
Q/SY KLD
|
|
昆仑数智科技有限责任公司企业标准
|
|
Q/SY KLD
|
|
软件需求文档编写要求
|
|
Requirements for Writing Software Requirement
|
|
Documents
|
|
2OXX-XX-XX 发布
|
|
2OXX-XX-XX 实施
|
|
昆仑数智科技有限责任公司
|
|
发 布
|
|
次
|
|
言。
|
|
艳围_
|
|
2 规范性引用文件
|
|
3 术语利定义_
|
|
4 缩略语_
|
|
需求文档编写基本廪则。
|
|
编写文档结构与肉容规范
|
|
文档头部信息
|
|
6.2 业务需求主体.
|
|
6.2.1 需求~景/来源_
|
|
6.2.2 业务价#_
|
|
6.2.3 需求描述
|
|
6.2.4 影响分析_
|
|
6.2.5 验收条件
|
|
6.2.6其它.
|
|
6.3 研岌需求主体.
|
|
6.3.
|
|
需求来源_
|
|
6.3.2 优光级_
|
|
6.3.3 功能架构
|
|
6.3.4 功能描述
|
|
6.3.5 非功能性需求描述:
|
|
6.3.6 验收标璀_
|
|
附 录 A
|
|
(规池性)
|
|
标题名称
|
|
A.1
|
|
附 录
|
|
(资料。)
|
|
标题名称_
|
|
8.1
|
|
参 考 交
|
|
献
|
|
前
|
|
言
|
|
本文件按照 GB /T 1.1-2020 <标谁化工作导则
|
|
部分: 标准化文件的结构和起草规则》的规定
|
|
起草。
|
|
本文件由 X XX
|
|
(一层组织全称) 提出。
|
|
本交件由昆仑数智科技有限责任公司科技与产品发展部归八。
|
|
本交件起草单位:
|
|
(一层组织全称)
|
|
本文件主婴起草人:
|
|
本文件审查人:
|
|
|
|
需求文档编写要求
|
|
范围
|
|
本交件规定了软件开发过程中业务需求和砥发需求交裆编写的婴求
|
|
本文件适用于昆仑数智企业软件开发过程中业务需求和研发箫求文裆的编写
|
|
规范性引用文件
|
|
下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中 ,社日期的引用交件,
|
|
仅该日期对应的版本适用于本文件; 不注日期的引用文件,其最新版本 (包括所有的修改单) 适用于本
|
|
文件。
|
|
GB/T1.12020 《标准化工作导则 笫
|
|
部分: 标准化文件的绪构和起草规则》
|
|
术语和定义
|
|
下列术语和定义适用于本文件。
|
|
业务需求
|
|
Business Requirements
|
|
客户/用户捉出的核心目标
|
|
3.2
|
|
研发需求
|
|
Development Requirements
|
|
系统需实现的具体功能
|
|
缩略语
|
|
需求文档编写基本原则
|
|
消晰明确: 使用简洁的技术术语。避免棋糊描述; 每条需求须独立成段
|
|
不可批杂多个功能点
|
|
可验证性: 每条需求需附带验收条件 (如" 用户登陆响应时间<2秒"
|
|
|一。标识:为每条需求分配帷一编号(格式:REQ- 项目缩写-模坎-序号,如 REQERP-AUTH-0OI )。
|
|
可追溯。: 需求需关联到来源 (如用户反馈。会议记录。竞品分析文裆编号)
|
|
编写文档结构与内容规范
|
|
6.1
|
|
文档头部信息
|
|
Q/SYKLD
|
|
交裆头部固定包含以下信息:
|
|
项自名称
|
|
文裆版本号 (袼式: vl00, 遵循语义化版本控制)
|
|
编写/修订日期
|
|
编写人7审核人
|
|
适用范围 (如核心系统。移动端祺块)
|
|
6.2
|
|
业务需求主体
|
|
6.2.1
|
|
需求背景 /来源
|
|
详细描述业务场景。包括当前的市场环境。竞争对手分柝。用户需求变化等。以便更好地理解需求
|
|
的背景和重婴性。为了更好的描述需求背景,可以考虑从业务驱动因素。问题场景描述等方面入手对需
|
|
求的背景进行描述。
|
|
业务驱动困素
|
|
核心问题: 当前业务遇到的痛点或机会是什么
|
|
示列:
|
|
'现有订单系统无法支持砂级库存同步
|
|
导致超卖问题频发,近3个月用户投诉量增加
|
|
35
|
|
关键点:
|
|
当前业务现状 (数据化描逑)
|
|
未满足的目标或问题后果 (如效宰损失。成本增加
|
|
用户流失等)
|
|
问题场景描述
|
|
具体场景: 需求针对那些用户或业务场景
|
|
示列:
|
|
#商家在促销活动期间需手动调整库存
|
|
操作繁琐且容易出锴。平均耗时30 分钟/次。
|
|
关键点:
|
|
用户角色 (如商家。运菅人员)
|
|
具体操作流程或场景痛点。
|
|
市场/行业背景
|
|
外部困素: 市场需求。竞争压力或行业趋棼是否驱动了该需求?
|
|
示列:
|
|
"竞品已上线 AI 客服系统,用户满意度提升 20%
|
|
我方需跟进以保持竞争力。
|
|
关键点:
|
|
竞品分析。用户调砥结果;
|
|
行业标准或技术潢进 (如 AI
|
|
自动化趋棼)
|
|
利益相关者
|
|
{Stokeholdcrs)
|
|
相关方诉求: 哪些部门或角色需要该功能
|
|
示列:
|
|
#客服部门反馈现有工单系统无法自动分类问题。导致响应效率低下
|
|
关键点: 提卅箫求的部门或角色 (如业务方。技术团队。筐理层) ; 他们的核心诉求和目标=
|
|
数据支持
|
|
量化侬据: 用数据证明需求的必婴性。
|
|
示列:
|
|
#调研显示
|
|
80%的用户因支付流穆复杂放弃下单
|
|
导致转化荤损失15%。
|
|
关键点: 用户调研数据。业务指标 (如转化率。锴误宰)
|
|
历史问题发生的频率或影响范围
|
|
政策1合规婴求
|
|
法规驱动: 是否困法袢法规。安全标准等必须实珧
|
|
示列:
|
|
"根据 《个人信息保护法》婴求。用户数据导出功能需增加权熨审批流程。
|
|
关键点:
|
|
法规名称及具体婴求;
|
|
不合规的风险 (如罚款。停I整改)
|
|
关联需求/系统
|
|
匕下文依赖: 需求与其他功能或系统的关联性。
|
|
示列:
|
|
"本需求为供应链系统升级的
|
|
~部分
|
|
需与 ERP 系统库存祺块对接。
|
|
关键点:
|
|
匕游/下游侬赖的系统或功能:
|
|
整体项目规划中的定位。
|
|
完整示列:
|
|
当前会员系统的积分兑换功能仅支持实物商品。但用户调研显示:
|
|
65%酌用户希望积分可兑换视频平
|
|
台会员等虚拟权益;
|
|
'无法满足 隶
|
|
近6个月积分闲置单高达 45%
|
|
导致用户活跃度下降。
|
|
此外
|
|
竞品 (如^平台) 己匕线虚拟权益兑换功能。其会员续费率提开 20%。
|
|
为提升角户粘性并踉迸市场趋
|
|
势。 扩屣积分兑换场昃。支持虚拟权益发放。
|
|
6.2.1.1
|
|
干系人
|
|
列出业务相关干系人 (客户。业务部仃。用户代表等)
|
|
针对每一类干系人的痛点进行分析。
|
|
6.2.1.2
|
|
收集方法
|
|
描述如何收巢业务需求 (如访谈。问卷等)
|
|
6.22
|
|
业务价值
|
|
应明确需求的具体价值。包括对业务增长。用户体验提升。成本控制等方面的其体影响。荪助相关
|
|
方理解实施该需求的必婴。。
|
|
需求价值的表达要避免棋矧,尽量量化表达不要夺人,不要假设, 区分短期和长期价值并且把用户
|
|
视角和业务视角结合。
|
|
可从以下几个角度入手:
|
|
业务捎标提升
|
|
明确需求对关键业务指标 (如收入。转化宰。效率) 的直接影响
|
|
示列:
|
|
"上线自动退颛功能后。预计客服人工处理退款工单量馘少70%
|
|
每月书省人力成本约
|
|
5万元。
|
|
用户体验忧化
|
|
描述功能对用户操作效宰。满意度或留存率的提升。
|
|
示列:
|
|
"优化搜索算法后,用户平均找到目标商品的肘间从
|
|
分钟缩短至 15秒。预计用户氍
|
|
存率提升10%。
|
|
成本降低或效率提升
|
|
说明需求如何碱少资源浪费
|
|
缩短沉程耗时或降低运维复杂度。
|
|
示列:
|
|
#引入自动化部署工其后
|
|
版本发布耗时从2小时降至 t0 分钟。团卧产能捉升30%。
|
|
风险控制或合规。
|
|
说明需求如何规避法律风险或系统稳定。问题
|
|
示列:
|
|
"实现数据加密存储后。可满足 GDPR 合规婴求,避免潸在罚款 (最商年菅收 4%)
|
|
战略或市场竞争忧棼
|
|
关联企业长期战略目标或市场竞争需求C
|
|
示列:
|
|
"支持多语言功能盾。可拓展东甫亚市场
|
|
支撑公司年度海外菅收增长 20%的甘标。
|
|
技术偾缓解或可扩展。
|
|
说明技术架构优化对未来需求的支撑作用。
|
|
示列:
|
|
"虿构订单模块后。系统可支持未来
|
|
牛日均百万级订单量的增长需求。
|
|
6.2.2.
|
|
优先级
|
|
为每个需求分配优先级 (高。中。低)
|
|
6.222
|
|
需求分类
|
|
需求属于功能需求。非功能需求还是接1需求=
|
|
|
|
6.2.3
|
|
需求描述
|
|
6.2.3.
|
|
整体描述
|
|
整体描述聚焦于它所在的棋块或者系统,从更高层级或者整体的角度描述需求的功能。裉据需求的
|
|
特点可以描述他在业务架构中的坐标位置。或者明确业务匕下游的交互关系
|
|
或者其它能够崭助开发人
|
|
员理解业务特点的方式。
|
|
6.2.3.2
|
|
干系人业务流裎
|
|
从干系人视角描述该需求的业务流程
|
|
6.2.3.3
|
|
界面需求
|
|
该章书可选c
|
|
此处填入界齑原型囹
|
|
6.23.3.
|
|
界面字段说明
|
|
针对原型的界面展示宁段和输入宁段进行说明
|
|
袼式如下=
|
|
字段名称
|
|
数据类型
|
|
长度
|
|
说明
|
|
6.23.3.2
|
|
界面操作
|
|
针对界面原型的操作进行说明。
|
|
袼式如下:
|
|
序号
|
|
业务#作
|
|
说明
|
|
6.23.4
|
|
处理逻辑详细说明
|
|
对于复杂的处理逻辑在此具体说明。比如涉及到后台处理逻辑。处理步骤。可以通过时序倒辅助说
|
|
6.2.3.5
|
|
数据描述
|
|
数握项
|
|
数据类型
|
|
数抿含义
|
|
触发条仵
|
|
可选条件
|
|
姓多
|
|
字符型
|
|
必填
|
|
中龄
|
|
整型
|
|
必填
|
|
6.2.3.6
|
|
非功能性需求
|
|
6.2.3.6.1
|
|
性能:求
|
|
描述系统响应时间
|
|
最大并岌访问等需求
|
|
6.23.6.2
|
|
隔离需求
|
|
描述项目采用的隔商策略
|
|
是逻辑隔离,还是物理隔商
|
|
6.2.3.6.3
|
|
安全需求
|
|
描述用户认证。授权筐理。链路传输。数据备份和归裆竽安全需求
|
|
6.2.3.6.4
|
|
运行环境需求
|
|
描述软件。硬件配食的婴求。链路婴求。以及系统可移植。的需求
|
|
6.2.3.6.5
|
|
可靠性:求
|
|
描述系统运行的可靠性。可用性需求。是否需婴 HA, STANDBY , 负载均衡等高可用冗余设计
|
|
6.2.3.7
|
|
接口需求
|
|
与外部棋块/系统的交互需求 (如"与第三方支付平台对接")
|
|
6.2.4
|
|
影响分析
|
|
该章书可选。
|
|
应对需求实施可能带来的风险和影响进行全齑分析,包括对现有系统。业务。用户。技术风险与挑
|
|
战。资源投入和法律合规的影响。描述的时候可选择其中一
|
|
个或者名个受到影响的困素进行措述。
|
|
下面
|
|
对这些困素进行详细说明
|
|
系统影啊
|
|
棋块/功能影啊: 需求涉及那些琬有棋块或功能需婴修改
|
|
示列:
|
|
"订单创建模块需新增预售订单类型处理逻辑。
|
|
"用户牛心需扩展杈限管理功能=
|
|
支持角色分级。
|
|
接1影响: 是否新增或修改接八
|
|
示列:
|
|
"支付系统需捉供新版退弑 API
|
|
〈31
|
|
|接口逐步废弃。
|
|
数据影啊: 数据结构。存储或流程是否娈化
|
|
示列:
|
|
"商品表新增预臂开始时间宁段。历史数据需批量初始化。
|
|
业务影啊
|
|
流程娈更: 业务流程是否需婴调整
|
|
示列:
|
|
"财务结算流程需增加预臂订单的结算周期 (从 TtI 改为T+7)
|
|
部门协作: 哪些部门需婴配合流程或规则娈化
|
|
示列:
|
|
"客服困卧需培训预臂订单的售后处理规则。
|
|
KPI 关联: 对业务指标 (如转化宰。客单价) 的预期影响。
|
|
示列:
|
|
*预计预臂功能匕线后。客单价提升 15%
|
|
但计单取消率可能增加 5%
|
|
用户影啊
|
|
用户体验娈化: 用户缫作流程是否简化或复杂化
|
|
示列:
|
|
"用户需在结算页于动选择'现货'或'预臂'商品,操作步骤增加
|
|
步。
|
|
用户教爷成本: 是否需婴引导用户适应新功能?
|
|
示列:
|
|
*需在 APP 首页增加顸售功能引导弹窗,持续推送
|
|
天。
|
|
技术风险与祧战
|
|
|
|
技术复杂度: 是否存在技术难点或未知风险
|
|
示列:
|
|
"预臂库存与现货库存的实时隔离需解诀高并发下的数据一致性问题。
|
|
依赖风险: 是否依歉未经验证的技术或第三方服务
|
|
示列:
|
|
"依赖笫三方彻流 API 的实时回调接口,需评估其稳定性 (SLA 99.9% )
|
|
资源影啊
|
|
人力投入: 开发
|
|
测试。运维的预计工时。
|
|
示列:
|
|
"后端开发: 10人日,前端开发: 5人日。联调浏试: 3人月。
|
|
环境依歉: 是否需婴特殊浏试环堍或数据稚备
|
|
示列:
|
|
"需在测试环垸模拟百万级预臂订单压力测试。
|
|
法律与合规影啊
|
|
政策合规性: 是否涉及数据隐私。消费者权益等法规
|
|
示列:
|
|
"预臂规则需明确标注发货时间。避免违反《电子商务法》第35条。
|
|
整示列:
|
|
影响雏度
|
|
具体肉容
|
|
风险/应对措施
|
|
系统。能
|
|
琐售计单峰预计达 10 万1分钟
|
|
需优化数据库
|
|
El 险:
|
|
数据库压力过犬;
|
|
分库策略
|
|
应对: 分库+读写分离
|
|
用户体验
|
|
部分用户可能困等待发货时间较长选择取消计
|
|
应对: 挺供预售订单取消补偿券
|
|
(满 IO0 馘10)
|
|
合规。
|
|
预售规则需在商品页显著位置展示发货时间
|
|
风险: 法律纠纷;
|
|
应-:
|
|
法务团队审核交案
|
|
6.2.5
|
|
验收条仵
|
|
该章书可选。
|
|
编写验收条件婴明确输入与输出。避免棋矧词汇,使用量化指标_
|
|
采用"前置条件+触发动作+预期
|
|
结果"的框架进行描述
|
|
并且翌对条件进行分类
|
|
比如: 功能验收
|
|
性能验收
|
|
兼容性验收等,
|
|
例如:
|
|
功能验收
|
|
|
|
描逑系统在特定场景下的预期行为
|
|
例如: *当用户点击 `提交'按钮时,系统应保存表单数据并跳转到确认页面。
|
|
。能验收
|
|
定义响应时间。吞吐量。资源占用等指标
|
|
列如: *系统在 I0O0 并发用户下。页面加载时间应小于2秒。
|
|
蒹容性验收
|
|
明确支持的平台 设备或者版本
|
|
列如: *功能需兼容 Chrome 100+
|
|
Safori 15+ 及 Fitefox 90+浏览器。
|
|
安全。验收
|
|
涉及杈限。数据保护等
|
|
例如: *用户密码加密存储
|
|
且连续
|
|
次登陆失败斥锁定账户30 分钟。
|
|
用户界面 (UI〉 要求
|
|
描述交互或视觉
|
|
例如: *错误提示应显示为红色文本框
|
|
并自动聚集到错溟宁段。
|
|
用户验收测试场景
|
|
描述用户实际#作流程的验证
|
|
列如:
|
|
'用户从商品搜索到支付完成的端到端流毪需成功执行。
|
|
验收的分类不局限于这些情祝。根据实际需求可自定义。
|
|
6.2.6
|
|
其它
|
|
该章书可选。
|
|
可以增加其他相关信息。如实施的时间框架。预算。资源需求等。
|
|
6.3
|
|
研发需求主体
|
|
6.3.1
|
|
需求来源
|
|
指定研发需求是从聊个业务需婴分解而来,婴指定需求名称。需求编号和文裆版本号。
|
|
6.3.2
|
|
优先级
|
|
根据砥发需求的虿婴性和紧迫性。按高中低三档分配优先级。
|
|
6.3.3
|
|
功能架构
|
|
功能架构编写要求
|
|
采用三级分层结构,需包含功能树图
|
|
(Tisio
|
|
UNL 图) 辅助说明
|
|
命名规范:
|
|
~级棋块: [业务领域牛心 (如客户牛心 订单4心)
|
|
二级棋块: [主体对象]管理 (如个入客户管理。集团客户管理)
|
|
三级棋块: [核心操佾管理 (如基础信息管理。衩限酡置)
|
|
示列:
|
|
客户中心(一级)
|
|
个人客户管理〈二级)
|
|
基础信息管理
|
|
〈二级〉
|
|
服务记录管理〈三级)
|
|
巢团客户管理(二级)
|
|
卜巢团信息管理 (三级)
|
|
成员单位管理〈三级)
|
|
6.3.4
|
|
功能描述
|
|
6.3.41
|
|
总体描述
|
|
功能性需求是一个总体的描述。谥循" 作为 <用户角色> 我想婴<结果〉 以便于 <甘的>
|
|
的书
|
|
写结构,是对功能的整体描述。细节放在子章节
|
|
每一个子章节是一个功能单元(功能点)
|
|
6.3.42
|
|
功能单元描述
|
|
功能单元的编写方法采用以下两种方式:
|
|
建议以主状诮宾或主诮宾补的固定句式进行描述。
|
|
如: 系统用户〈主语)通过〈介词〉人员管理界面〈名词〉查询〈谓语〉用户僖息〈宾语)
|
|
并且
|
|
可以修改〈诮语)用户的基本信息〈宾语)
|
|
主状诮宾
|
|
主语_状语+诮语_宾语 或 名词_名词-介词_动词_名词
|
|
|
|
|
|
主诮宾补: 主语_诮语 _宾语_补语 或 名词_动词_名词_介词+名词
|
|
应尽量避免将拆分表"子过程描述"内容堆叠于此。
|
|
配图: 可使用 UNL 流毪图描述关键功能流毪
|
|
每个流程对应一
|
|
~张图。或通过图片来直观呈现页面
|
|
布局。展示消晰 谁确即可。
|
|
6.3.5
|
|
非功能性需求描述
|
|
该章节可选。
|
|
非功能。需求可以按如下类型进行描述:
|
|
非功能。需求棋板
|
|
棋板: 系统应[性能描进],以确保[业务目标或用户体验]。
|
|
示列: 系统应能够在 5秒内响应用户请求,
|
|
以确保用户不会感到竿待时间过长。
|
|
业务规则需求模板
|
|
棋板: 当[触发条件]时。系统应[必务规则描逝
|
|
以便[业务目柄。
|
|
示列: 当计单金额超过 IOO0 元时
|
|
系统应自动应用 10%的折扣,以便鼓励高价值计单。
|
|
安全。需求棋板
|
|
棋板: 为了[安全目柄],系统应[安全措硇]
|
|
以便[保护措施描d。
|
|
示例: 为了保护用户数据。系统应婴求用户在
|
|
分钟后未活动肘自动注销,以便防止未授权
|
|
访问。
|
|
。能优化需求模板
|
|
棋板: 为了[性能目柄,系统应[优化措硇]
|
|
以便[。能捉升描逝=
|
|
示列: 为了捉商页面加载逑度
|
|
系统应优化数据库查询。以便将贞面加载时间从
|
|
秒诚少到
|
|
用户界面需求棋板
|
|
棋板: 用户应能够[界面操佾,以便[用户目柄。
|
|
示列: 用户应能够通过点击"捉交"按钮来捉交表单,以便快递完成注册流翟。
|
|
报告和监控需求棋板
|
|
棋板: 系统应提供[报告类型,以便[监控目柄。
|
|
示列: 系统应捉供每日销售报告
|
|
以便筐理层监控销售趋棼。
|
|
巢成需求棋板
|
|
棋板: 系统应与外部系统]集成。以便[集成目柄。
|
|
示例: 系统应与务系统粜成。以便自动同步交易数据。
|
|
维护和升级需求棋板
|
|
棋板: 系统应[维护措施],以便[雏护目柄。
|
|
示例: 系统应定期进行安全更新。以便保持系统的安全。。
|
|
5.3.6
|
|
验收标准
|
|
验收标准的编写原则是: 可量化。可验证。完整覆盖 (功能
|
|
性能
|
|
安全
|
|
交裆吗维度)
|
|
完整示列:
|
|
1.功能实现
|
|
输入正确账号密码可跳转到苜页 (潮试用例羧盖
|
|
种浏览器)
|
|
密码错误
|
|
次后锁定账户
|
|
小时 (箫模拟 10 次错误黹求验证)
|
|
性能要求
|
|
单接口啊应时间^ 20Oms ( 压测 500 并发逦过)
|
|
登录成功宰>99.9% (持续24小肘监控)
|
|
3。安全要求
|
|
逦过 OWASP Top 10 漏洞扫描 (报告无高危漏洞)
|
|
密码传输加密 (HTTPStBCtpt 算法验证)
|
|
交付文档
|
|
提供 APT 接]文档 (含错误码说明)
|
|
提交部署配置龇本 (巳逦过 Jenkins 流水线验证)
|