需求说明文档之阅读人员分析,如何提高需求说明文档的读者认可度

详细的软件需求规格说明书,介绍软件需求规格的常见要素 内容表 1 引言 1.1 目的 1.2 文档约定 1.3 预期的读者和阅读建议 1.4 产品的范围 1.5 参考文献 2 综合描述 2.1 产品的前景 2.2 产品的功能 2.3 用户类和特征 2.4 运行环境 2.5 设计和实现上的限制 2.6 假设和依赖 3 外部接口要求 3.1 用户界面 3.2 硬件接口 3.3 软件接口 3.4 通信接口 4 系统特征 4.1 说明和优先级 4.2 激励/响应序列 4.3 功能需求 5 其他非功能需求 5.1 性能需求 5.2 安全设施需求 5.3 安全性需求 5.4 软件质量属性 5.5 业务规则 5.6 用户文档 6 其他需求 附录A 词汇表 附录B 分析模型 附录C 待确定问题的列表 立即下载
 需求报告的最终目的是给人来阅读的,所以一定要考虑需求报告的读者群,有4类角色可能阅读软件系统的需求文档:
   客户与用户业务高层;
   用户的中层管理人员与具体人员;
   用户IT主管与开发人员,包括设计人员、编码人员、同行的专家;
    项目管理人员:包括项目经理、质量保证人员、测试人员、 需求管理员、 配置管理员、计划人员等等;
     不同的读者对文档的阅读需求是不同的,他们关注的信息是不同的。我见过了很多次需求评审的失败(如果做好需求评审我会另外再撰文描述),总结下来我认为和需求描述没有区分读者群是很有关系的。针对上述的4种分类,我们具体的来分析一下每类读者的特点:
(1) 客户与用户业务高层
      他们关心的企业是系统的目标性需求,关心的是系统总体的功能 框架,关心的是系统解决了哪些管理问题,对具体的需求是不关心的,所以给他们阅读的文档应该是从总体上来描述,要高度抽象。由于他们的工作很忙,很难有比较长的时间来读这些材料,所以要简短明了,能够用1页纸说明问题的就要不要用2页纸,而且一般都要给高层进行需求汇报,需要配上语言说明,因此采用PowerPiont片子也就成了一种常用的方法,讲解需求与讨论一般应掌握不要超过1小时。需求人员常犯的毛病是过多地关注了企业的细节性需求,而忽略系统的目标性需求,所以在安排需求获取的步骤上、需求报告的编写上往往没有抓住企业高层最关心的问题、没有抓住根本性的问题,在给企业的高层汇报时当然很难通过评审。


(2)用户的中层管理人员与具体人员
     企业的中层管理人员关注的是企业的局部需求,他们要求对自己的负责的局部系统能够有总体的了解,能够和其他的子系统衔接的很好,业务流程很流畅,覆盖了自己需要的所有业务流程,能够通过系统起到控制作用就行了。具体的操作人员更关心自己的的哪些活动是否在系统中都能处理,软件是否可以很容易地操作,他们关注的焦点更具体,要求更直观。所以对这类的读者可以通过比较详细的文档来描述需求了,当然应该以他们习惯的思维方式来描述,不能从开发人员的角度来描述。我看到过很多几百页的需求文档给用户去阅读、去评审,结果要么用户不置可否,要么直接讲看不懂,为什么呢?一是开发人员在文档中分子系统、分模块、分功能点一层深入下去描述,不符合用户的思维习惯,他们希望能够从业务流程、业务活动的角度来考虑问题,而不是功能;二是太多了,用户也没有时间静下心来去消化、吸收如此多的文档,需求毕竟不是小说,能够那么吸引读者。


(3)用户IT主管与开发人员,包括设计人员、编码人员、同行的专家
     大多数分析人员可能最擅长的就是些写这类的文档了,往往也是那这类的文档给所有的读者看,其问题我们上边都说了,这里我们就不赘述了。
     需要注意的是在描述需求时候传统的做法是以功能为主线,来展开描述,实际上如果是以数据为主线来描述需求也是一种很好的办法,在我们上面谈到的五元组中,从数据的角度来分析系统可以更容易实现向OOA、OOD的切换。


(4) 项目管理人员:包括项目经理、质量保证人员、测试人员、需求管理员、配置管理员、计划人员等等
     把拿给开发人员看的需求文档给管理人员看,这也是分析人员常犯的毛病。管理人员实际上最关心的是需求列表。

   在此基础上项目经理、质量保证人员可以据此来进入项目策划过程,测试人员可据此进入测试策划过程,需求管理员、配置管理员可以识别配置项制定相关的活动计划。没有这张表管理人员就很难高效地开展他们的管理活动,也就谈不到最基本的需求复用了。在上述的表中,需求的优先级是很重要的一列,对项目经理进行项目管理的平衡决策是很重要的,实际上需求的优先级可能比需求本身更重要。

3 需求描述的表示技巧


      上面我们谈到了,需求文档是人与人之间交互的文档,是不同类型的人之间交互的文档,因此需求文档的可读性是一个很重要的方面,为了提高文档的可读性可以借鉴下面的一些做法:
   在文档的描述中,适当运用链接,增强文档的可读性;

多用穷举的方式,以便于发现遗漏的需求;
   通过适当的换行来提高可读性 ;
   采用黑体、斜体、下划线、颜色等多种方式来突出重要内容;
   定义标准的术语,以减少二义性,减少文档的页数;
     在功能需求的描述中,对于类似的、统一的功能可以单独地进行详细描述,其他地方进行引用,或做为术语进行定义,以简化文档,减少重复。
 尽管你按照上述的方法去做了,也不要期望能够编写出一份能体现需求应具备的所有特性的文档,无论你如何去细化、分析、评论和优化需求,都不可能达到完美,但是你能够做到“可接受”,写一份客户、用户、开发人员、管理人员都认可的一份需求,而不是完美的需求! 
需求文档——需求文档怎么写 一、要讨论怎么写需求文档,首先就的搞清楚需求的构成,我是这么分的: 1、功能需求; 2、非功能需求或技术需求; 我一般把功能需求划分为几个部分: a、业务过程; b、业务规则; c、业务数据; 立即下载

相关推荐

【从零开始玩量化7】easyTrader: 自动化(程序化)交易利器

前面的文章,我们介绍了数据获取工具AKShare, 量化回测工具backtrader等,这一篇,介绍程序化交易工具easyTrader。作者网名食灯鬼,目前项目在Github上的star数已经有6.7k。这可能是目前,开源能找到的,最好用的程序化交易库了。本文介绍了easyTrader的简单用法,这个包还有很多功能,后续再继续写文章探究。

量化投资助手的博客 1万+

需求规格说明书模板

需求规格说明阐述一个软件系统必须提供的功能和性能以及它所要考虑的限制条件,它不仅是系统测试和用户文档的基础,也是所有子系列项目规划、设计和编码的基础。它应该尽可能完整地描述系统预期的外部行为和用户可视化行为。除了设计和实现上的限制,软件需求规格说明不应该包括设计、构造、测试或工程管理的细节。   1)采用软件需求规格说明模版: 采用需求规格说明书模板在你的组织中要为...

aisuocuo6821的博客 1359

Oasys安装教程

在基环境下执行然后去 C:\Users.condarc打开 .condarc这个文件 删除干净里面的东西。

weixin_44254178的博客 1297

需求分析文档模板

目 录 1. 引言 1 1.1. 背景 1 1.2. 参考资料 1 1.3. 假定和约束 1 1.4. 用户的特点 1 2. 功能需求 1 2.1. 系统范围 1 2.2. 系统体系结构(二层架构的系统可剪裁本小节) 1 2.3. 系统总体流程 2 2.4. 需求分析 2 2.4.1. XXXXXXX(功能需求名称) 2 2.4.1.1. 功能描述 2 2.4.1.2.

shen516的专栏 1万+

别再自己写组件了!用uni-app的midButton属性5分钟搞定中间凸起TabBar(H5/小程序通用)

本文详细介绍了uni-app官方提供的midButton属性,帮助开发者5分钟内实现中间凸起的TabBar效果,无需编写繁琐的自定义组件代码。该方案兼容H5和微信小程序平台,配置简单且维护成本低,大幅提升开发效率和性能表现。

weixin_30431445的博客 348

【医学影像】Deep Learning for Automatic Pneumonia Detection

写在前面的话: 这篇论文是北美放射学会(RSNA)在Kaggle平台上托管的肺炎区域检测挑战赛取得第二名成绩的解决方案。因为笔者需要用到其中的图像增强方案,因此本篇博客只介绍了数据集和图像增强,关于模型的改进和其它改进点没有涉及。 论文地址:https://arxiv.org/abs/2005.13899 代码地址:https://github.com/tatigabru/kaggle-rsna 比赛地址:https://www.kaggle.com/c/rsna-pneumonia-detection-c

chenzhoujian_的博客 1567

软件工程---文档的目标读者及作用

大家都知道软工文档一共有十三个,包括可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、数据库设计说明书、数据要求说明书、测试计划、测试分析报告、项目开发总结报告、操作手册、用户手册、开发进度月报,这么多的文档,它是给谁看的呢,它的作用有是怎样的呢,下面我以表格的形式给大家分析一下: 文档 读者 作用 可行性研究

灵活的小胖子 1333

增益调度控制 —— 理论、案例与交互式 GUI 实现

本文详细介绍了增益调度控制的基本原理、数学模型及公式推导,探讨了该方法在适应非线性系统和大范围工作条件下的优势与局限。通过航空飞行控制、发动机推力控制以及化工过程控制三个典型案例,我们展示了如何利用调度变量动态调整控制增益,从而使得控制系统在各个工作点均能达到优良性能。为帮助工程师和研究者更直观地理解并验证增益调度控制的实际效果,本文提供了一套基于 Python 与 PyQt6 的交互式 GUI 控制系统代码。用户不仅可以实时查看仿真数据,还能通过在线调节参数直观体验调度控制的优势。

闲人编程的博客 1480

怎么写软件需求文档

以前没写过,也跟公司性质有关,自己研发的软件,然后用户提哪里用的不合适,然后调整。现在要做一个新项目,领导让做一个需求文档,所以就研究了以下。 总结有几点: 1、要明白客户要做什么(需求的大概框架,以及逻辑、算法、公式等),这个过程要问甲方项目负责人(可能会知道有哪些部门、负责人等)。 2、明白框架以后,要明白具体的操作过程(需要录入哪些内容、平时都是根据哪些查询的、哪个地方需要打印、什么时

haibin_hu的专栏 1万+

【WRF数据准备】海温(SST)数据替换

【WRF数据准备】海温(SST)数据替换

WW、forever的博客 1119

性能优化-高通cDSP(QDSP6)架构详解

高通cDSP开发的商业价值30秒快速认识高通cDSP开发的商业价值【高通cDSP旨在处理一些简单但需要大量计算的场景,如图像处理、科学计算、AI训练、计算机视觉等。这些场景使用CPU来运算会极大的降低CPU的吞吐量,因此利用现代寄存器较宽的特性设计出了适配数据并行的DSP芯片,cDSP就是典型的代表。利用cDSP+CPU既可以满足一般的使用场景,也可以完成现代图像和视频数据的处理。

发狂的小花的博客 5946

软件工程文档目标读者

写了几个文档后发现每个文档的序言都要求写文档的目标读者,软件工程生命周期中每个阶段需要的文档不同,文档的读者也不同,我想还是先把读者弄清楚再继续写吧!一查原来早就有人写了,他写是他的,我写是我的。 这六个阶段14个文档4个读者的关系是: 因为每个文档的目标读者不同,所以文档中的语言的专业程度要注意分寸。面向用户的只有用户手册和操作手册,而且是文档中最简单直接的文档,相当于软件的帮助。就

南柯 1223

YOLO车辆测距、车辆识别与单目测距

YOLO(You Only Look Once)是一种实时物体检测系统,能够识别视频或图像中的多个对象,并确定其位置。结合车辆识别与单目测距技术,YOLO可以用于交通监控、自动驾驶等应用场景,通过单个摄像头实现车辆的识别与距离测量。YOLO结合单目测距技术,在多个应用领域展现出巨大的潜力与灵活性。其实时性和准确性为智能交通、自动驾驶等领域提供了强有力的技术支持。

走向CTO的路上... 1721

大模型应用开发--Agent笔记1(定义,ReAct、Plan-and-execute范式,Coze、Dify低代码平台,LangChain、LlamaIndex、AutoGen框架,评估,含代码)

本文基于datawhale的Hello-Agents开源项目及其他大模型开发资料整理而成。内容分为四个部分: 智能体基础概念、智能体构建范式、智能体框架比较和智能体性能评估。笔记重点分析了不同范式的优缺点,并通过实际代码示例展示了各框架的具体实现方式。作者将持续更新学习内容,深入探索智能体开发的实践应用。

zhuai.blog.youkuaiyun.com 2017

VB摄像头监控

该VB模块可对摄像头捕获的画面进行录像等,可在创建的窗口进行控制

Statistics and Machine Learning Toolbox

Statistics and Machine Learning Toolbox(带书签),MATLAB统计学习工具

《软件工程》第八章——需求获取

《软件工程》第八章笔记

giottomu的博客 1614

OV9734 DATASHEET,完整规格书

OV9734完整规格书,包括电气参数,尺寸规格,寄存器配置表等

银之森(一)需求分析文档

1. 引言 1.1 编写目的 本文档编写基于以下准则: (1) 理解并描述问题的信息域, 并以此建立数据模型. (2) 定义软件应完成的功能, 并以此建立功能模型. (3) 描述作为外部事件结果的软件行为, 建立行为模型. (4) 对描述信息, 功能和行为的模型进行分解, 用层次的方式展示细节. 本文档面向多种读者对象: (1) 项目经理: 了解预期产品的功能, 并据此进行系统...

fivfi的博客 1005

迈瑞BS系列全自动生化分析仪LIS协议接口手册(内含HL7和ASTM)

迈瑞BS系列全自动生化分析仪LIS协议接口手册,内含HL7和ASTM)

需求规格说明文档

教室自习判断系统需求规格说明文档目录:1、引言  1.1、编写目的  1.2、项目背景  1.3、预期读者和阅读建议  1.4、参考资料2、总体描述  2.1、目标    开发背景    开发意图    应用目标和作用范围    产品前景  2.2、用户场景分析    用户场景    用户需求  2.3、运行环境  2.4、假定和约束    假定    约束3、界面概述1、引言1.1、编写目的本需...

weixin_30897233的博客 354

概要设计文档

项目文档:概要设计文档 1.引言部分 1.1目的 该文档的目的是描述病人病历存储系统的概要设计,主要内容包括系统功能简介、系统结构设计、模块设计和界面设计等。 本文档的预期读者包括:设计人员,开发人员,项目管理人员,测试人员。 1.2 范围 1.2.1 系统目标 开发一个满足医生和数据上传人员需求的系统。方便查询、更改、下载、上传相关信息等。 1.2.2 主要软件需求 ...

899

概要设计文档3.0

概要设计文档 1、引言部分 引言部分主要说明编写目的、系统的范围和参考资料等。 1.1目的 该文档的目的是描述旅游软件的概要设计,主要内容包括系统功能简介、系统结构设计、模块设计和界面设计等。 本文档的预期读者包括:设计人员,开发人员,项目管理人员,测试人员。 1.2 范围 1.2.1 系统目标 我们设计这款软件主要目的是给大学生提供一款主要针对他们的旅游方式推荐旅游攻略的软件,让...

居贝比的博客 2万+

第7-9章 软件工程课后习题答案

一 单项选择题 1.测试用例设计时,主要工作是()。 设计测试场景的输入数据 设计测试场景的输入与输出数据 设计测试场景的输出数据 以上都不是 [参考答案] 设计测试场景的输入与输出数据 2.测试用例设计时,主要工作是()。 需求分析 软件设计 软件构建 软件测试 [参考答案] 软件设计 3.软件体系结构定义为() {component, connector, configuration} {models, connector} {object, collaboration, message, } [参考答

Aviana_j的博客 3245

文档工程体验设计:重塑开发者体验

最近,一边在思考如何进行开发者体验优化,一边在设计新的文档体系,以确保文档和代码的一致性。于是,便结合我先前对于文档代码化的理解和实践,并展开对于 Rust、Julia、Dart、Kotl...

Phodal's zenthink 2175

5分钟轻松搞定产品需求文档!这可能史上最全PRD文档模板

为什么写这篇文章? 第一:写PMCAFF的PRD文档,大家都是用户,比较好参考与理解,方便大家来找我写的不好的地方。 第二:我在自学PRD文档的编写过程中,总是遇到PRD文档里的对应产品总是找不到或是下架的情况,很难找到比较全面以及详细的参考模板,故一气之下撸了一篇,写好分享之。 关于这篇文章 1.PRD本来就没有固定的版式,根据团队以及个人的需求有所差别,本篇力求简单,不累述。 2.这篇PRD可...

csyifanZhang的博客 1530

Word产品需求文档,已经过时了

说来有些惭愧,写这篇文章是用来教大家写需求文档的。但其实,我很少会写传统意义上的产品需求文档;甚至,我连word都很少用。用惯了Axure的任意布局方式,再用word感觉非常别扭,尤其是在添加图片时,简直感到捉急。当然,这不是我不用word写需求文档的根本原因。简单来谈一下,为什么软件开发项目中,需要需求文档这么个东西?在稍微大一点的开发团队中,产品经理未必能向所有开发人员,传达具体的产品开发需求

pmcaff2008的博客 737

产品需求文档模板

记得自己在学习PRD文档撰写的时候,总希望能找到一份比较全面详细又易懂的模板。如果你也曾有相同的困恼或者尚未遇到满意的答案,或许本文可以提供不错的参考。 (往下阅读之前,希望能先思考一下:为什么需要写PRD 文档?欢迎评论讨论) 惯例,还是先甩图 不同公司、不同团队或产品对PRD文档的要求不同,不同PM的撰写风格也各有所异,本文力求全面而简洁,仅做简要概括。 简书,在我看来长这样 本文“简书”移动端为例,按照上图的总结写一份简单的PRD文档框架,希望能帮助同为“简书”用户的大家更好地理解。(PM菜

qq_44713502的博客 5864

软件需求分析阅读报告一

                    《软件需求最佳实践》第一章 需求实践现状分析   通过阅读第一章,作者通过列举了Standish Group的研究,分析到了如下的十大成功保证和十大败因。这个表格的数据对我将来做项目有很大的帮助,通过这个表格我明白了今后我做项目的时候需要注意的地方 成功的十大因素有及其权重: 用户的参与...

aiyyzap4570的博客 237

模型之外的那套装置:用 AI harness 完成一个三端同步应用

AI harness 指模型之外、让模型能持续产出可交付软件的全部工程装置。本文把它称作"支架"。它由五层构成:输入层规定模型读什么,反馈层规定模型怎么知道自己错了,观测层把界面与设备状态变成可读事实,记忆层让跨会话不失真,边界层规定哪些动作不许模型自行作出。支架的价值在六天里可以直接计量。

Leo的Matrix 181
上一篇: 如何解决JSP页面显示乱码问题
下一篇: Illegal mix of collations (latin1_swedish_ci,IMPLICIT) and (utf8_general_ci,COER) 解决办法
dw_java08
博客等级 码龄15年 122粉丝 66原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值