1、需求设计写作培训需求设计写作培训质量管理部质量管理部SQA小组小组2005.06课程范围u仅关注如何写作文档u不涉及具体的需求分析和设计方法课程内容l为什么要文档化l文档写作基本要求l需求设计文档模板l需求文档写作l设计文档写作为什么要文档化 开发人员通过文档化的过程查错补遗； 便于评审，在早期发现技术上的问题； 后续阶段开发任务可能由他人承担，输出文档便于他们开展工作； 维护人员开展维护工作需要； 文档是必要的交付件； 可读性就尤为关键为什么要文档化“所有的过程分析都要形成文档。我们现在有一个严重的问题是，大家好像不喜欢写文档，对于需要的实现方案，通常都是一个负责人在脑袋里想想该怎么实现，然
2、后邮件或电话找几个相关人员讨论一下就算可以了，可能连个会议材料或会议纪要都没有。而老外可不是这样的，他们非常非常重视文档，他们认为一个人在脑袋里想的东西是不清晰也不全面的，有时候心里想的认为很正确的方案实际上可能存在致命缺陷。他们要求必须把心里的想法形成文档才能有效的避免这种问题。写文档的过程中，可以更加有效的、更进一步去整理您原来心里的思路，很多问题在您写过文档的过程中您就能发现；另外，文档写作多使用图表，浪费口水的文字尽量少用，和我们一起工作的系统工程师在系统架构分析中就画了五六十张图，就算看不懂他写的英文，从图中我们就能够很清晰的指导整个产品的系统架构。” 摘自一位华为员工的瑞典出差报告
3、5课程内容l为什么要文档化l文档写作基本要求l需求设计文档模板l需求文档写作l设计文档写作文档写作基本要求下面的文档出自于我们开发人员的手笔，大家觉得如何？文档写作基本要求应使用标准模板写作；文档封页、页眉页脚、修订记录、附录、参考文献应完善；关键词、摘要、缩略语应完整；目录要及时更新；通篇文档标题、文字格式、间距应协调美观；所有文档模板中的章节，只可增加，不可删除；编写建议是用来指导文档写作的，在利用完后要及时删除；图号置于图形之下，表号置于表格之上；文档写作基本要求应追求图文并茂的效果；句子和段落要短；使用语言应严谨，不要使用白话；采用主动语气；不要出现“我们”、“你们”、“他们”这样的称
4、谓，或“这个”、“那个”这样的词，应使用“本”、“该”、“其”；表述清晰，避免引起歧义；通篇文档细节上要保持一致； 练习 房子南北走向，房子大门在东侧中间位置。门厅长约3米，宽2米，门厅左面是主卧室，右面是厨房。厨房3米宽，4米长，厨房门对着门厅，厨房的顶头还有一个北阳台，与厨房同宽，长1米。主卧室宽3米，长5米左右，房间门对着客厅。客厅与餐厅连为一体，共7米长，4米宽，与客厅相连有一南阳台，与客厅同宽，长1.5米。餐厅的北面是卫生间，卫生间与厨房相对，中间由1米宽，3米长的过道隔开；卫生间门对着过道，南墙与厨房的南墙在一条直线上；卫生间为长方形，南墙长3米，另一边长2米。卫生间的北面是次卧，
5、同宽，门朝着过道，次卧长4米。过道的北端是书房门，书房南北长4米，书房有一个一米见方的门厅，书房的西墙长4米，包括1米长的门厅长度，西墙把书房和次卧分隔开。门厅东墙北端90角折向东，长2米，把书房和厨房北阳台分隔开。大家认为下面的描述如何？究竟长多少？? 是左？是左？还是右？还是右？大段的叙述，大段的叙述，不利于理解！不利于理解！10练习1.房子南北走向，房子大门在东侧中间位置。2.门厅长3米，宽2米，门厅左面是主卧室，右面是厨房。3.厨房3米宽，4米长，厨房门对着门厅，厨房的顶头还有一个北阳台，与厨房同宽，长1米。4.主卧室宽3米，长5米左右，房间门对着客厅。5.客厅与餐厅连为一体，共7米长
6、，4米宽，与客厅相连有一南阳台，与客厅同宽，长1.5米。6.餐厅的北面是卫生间，卫生间与厨房相对，中间由1米宽，3米长的过道隔开；卫生间门对着过道，南墙与厨房的南墙在一条直线上；卫生间为长方形，南墙长3米，另一边长2米。7.卫生间的北面是次卧，同宽，门朝着过道，次卧长4米。8.过道的北端是书房门，书房南北长4米，书房有一个一米见方的门厅，书房的西墙长4米，包括1米长的门厅长度，西墙把书房和次卧分隔开。门厅东墙北端90角折向东，长2米，把书房和厨房北阳台分隔开。修改成如下描述之后呢？练习再改成如下图形描述呢？练习LSW与CAMS配合实现认证计费的方案中，客户（禁止多人同时使用的业务帐号）登陆通过
7、认证开始计费后，如果出现LSW重起的情况，处理方法分为两种：1.有时间芯片的LSW（可以记录时间的），设备重起后会使用设备时间戳的特性判断出设备重起了，这时会将CAMS上的在线用户删除并按照最后一次计费更新报文来终结计费。用户可再次正常登陆。2.下面的描述呢？白话修改成如下的描述呢？1.使用时间芯片的LSW（支持记录时间功能），利用设备时间戳特性可以检测出设备是否重启，设备重启时将CAMS上的在线用户删除，并依据最后一次计费更新报文终结计费。用户可再次正常登陆。练习由于一台设备可以设置多个radius服务器，也就是radius scheme。用户可以通过命令行来配置该radius服务器是否启动
8、设备重启防吊死功能。 由于一台设备可以设置多个radius服务器，即radius scheme。用户可以通过命令行来配置该radius服务器是否启动设备重启防吊死功能。 练习CAMS收到该报文后会立即回应一个code=5的计费回应报文，然后根据accounting-on报文携带的NAS-IP和NAS-ID找到通过该设备认证的用户，并将他们的在线信息删除。 CAMS收到该报文后会立即回应一个code=5的计费回应报文，然后根据accounting-on报文携带的NAS-IP和NAS-ID找到通过该设备认证的用户，并将其在线信息删除。 15练习修改原因： 这个函数是将要发送的packet转化为bu
9、ffer，系统原有函数RD_PutPacketToBuffer是针对认证用户设计的，由于本特性为设备启动后执行，没有用户信息，所以在RD_PutPacketToBuffer函数基础上做了一些修改，形成该函数。 修改原因： 该函数实现将待发送的packet转化为buffer的功能，系统原有函数RD_PutPacketToBuffer针对认证用户设计，由于本特性为设备启动后执行，没有用户信息，所以在RD_PutPacketToBuffer函数基础上做了一些修改，形成该函数。 练习ARP Authorized加强了网络安全，阻止了DHCP server对非法ARP回应进行学习，并且通过周期的ARP
10、ping可以快速的探测到用户是否下线。在设备的接口上使能ARP Authorized，该接口的ARP动态学习功能被禁止。在某个接口上禁止arp动态学习，不影响其他接口的arp学习。在禁止了arp动态学习的接口上，只能通过手工添加静态arp，或者其他一些被允许的模块才可以添加arp，这种arp被称为ARP Authorized，授权arp不再和其他的动态表项一样老化，而是有自己的老化机制，后面会说明。DHCP server就是这样的一个模块。静态arp的优先级高于授权arp，也就是说可以覆盖授权arp。 1. ARP与arp、ARP Authorized与授权arp，使用术语应该统一；2. AR
11、P Authorized应先解释后引用；3. “DHCP server就是这样的一个模块”，是否相关？课程内容l为什么要文档化l文档写作基本要求l需求设计文档模板l需求文档写作l设计文档写作模板何处获取需求SRS文档：REP01T01http:/jvpal接口文档：REP01T03http:/jvpal设计概要设计：DVP05T01http:/jvpal详细设计：DVP05T03http:/jvpal软件设计：DVP05T04http:/jvpal移植设计：DVP05T05http:/jvpal需求设计合一来自华为北研所h3crnd01-fs软件部规范小特性开发规范模板需求设计需求设计文档模板
12、19课程内容l为什么要文档化l文档写作基本要求l需求设计文档模板l需求文档写作l设计文档写作什么是好的需求什么样的需求是好的需求完整性清晰性可行性一致性可验证性练习2.1.1Functional Requirements1 功能需求1修改设置smarton password命令1. Introduction介绍 在设置smarton password的同时，规定密码显示形式为明文和密文。2. Inputs 输入 1)密码显示形式。 2)smarton password。3. Process 处理 1)记录密码显示形式。 2)当密码显示形式为simple时，直接设置smarton passwor
13、d为设置值；当密码显示形式为cipher时，如果设置值是密文，先将其进行解密成明文再设置，如果是明文则直接设置。4. output输出 无5. Inherit继承性 Update-需要改进大家看看下面的需求描述如何？1.介绍中描述的显示形式有明文和密文两种，但处理中描述的显示形式却是simple和cipher，不一致；2.密码允许输入哪些字符，长度有无限制，均没有交待。不完整3.输出没有吗？不完整练习2.1.1配置或者取消配置系统WOL功能1. Introduction介绍 在系统视图下配置或者取消配置WOL使能。2. Inputs 输入 系统视图下: wol enable 或 undo wo
14、l enable3. Process 处理 在系统视图下配置或者取消WOL使能。去系统WOL使能时，将WOL模块的MAC-ADDR表清空，释放所占内存。初始化MAC地址表相关指针。4. output输出 WOL功能在系统中被使能或被去使能；去系统使能时，MAC-ADDR表被清空。5. Inherit继承性 NEW-新增功能在前面没有介绍的情况下，这里应对缩略语进行详细解释，否则不完整练习2.1.1SRS.FUNC.DHG.001 IKE模块支持DH交换时使用Group5，Group141.Introduction介绍 支持IKE DH组的Group5和Group14是由8040波兰提出的新需求
15、，用户希望能提供更高安全级别的安全密钥，希望能支持DH 3/4/5，但是DH Group3/4是由椭圆曲线来实现的，与Group1/2/5有很大的区别，且需要较大的工作量，因此本次特性开发暂且实现对Group5/14的支持。完整性：这种术语也应该简单介绍，毕竟不是算数学题练习2.2.18 R.FUNC. 018支持XRN堆叠 3.Process 处理 当unit down时，处理端口删除消息，把down掉的unit端口从镜像组中删除，由此可能有相应的镜像组状态的改变。 当收到unit up消息时，本unit向其它unit发送端口镜像同步消息。此消息包含本unit所配置的镜像组信息。2.2.1P
16、erformance Requirements 性能需求1. Performance Requirements1 性能需求1 通话语音要求流畅。“可能”、“流畅”都是不清晰的，不同人理解不一样。不清晰一般也不可验证。25SRS大纲l简介目的范围l总体概述软件概述软件功能用户特征假设和依赖关系l需求建模建模工具l具体需求功能需求性能需求外部接口需求l总体设计约束标准符合性硬件约束技术限制l软件质量属性可维护性可靠性l依赖关系l其他需求l需求分级l附录简介总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求目的目的范围范围l描述文档目的l
17、指明文档读者l软件命名l软件要做什么，不做什么l软件的应用要点：“目的”是针对文档，“范围”针对的是软件功能。练习1Introduction 简介1.1Purpose 目的 本文用于描述DHCP增强项目中ARP相关需求的需求及设计，满足以下分配需求： 1.在接口上禁止ARP动态学习； 2.允许DHCP server添加授权ARP； 3.ARP PING； 4.配置授权ARP老化时间； 5.如果dhcp server删除租约则应删除相应的arp； 6.删除授权ARP表项后删除租约； 本文适用于相关开发及维护人员，本文档描述了COMWAREV300R002产品的软件需求。1.2Scope 范围 本
18、文包括DHCP增强项目中ARP相关需求的需求规格分析及软件设计说明。 本文不包括相关实现代码、用户指导及测试计划。应在范围中描述范围不是用来描述本文范围不是用来描述本文包括什么、不包括什么包括什么、不包括什么总体概述总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求假设和依假设和依赖关系赖关系总体总体概述概述软件功能软件功能用户特征用户特征软件概述软件概述本节不对需求作具体描述，只是为了使那些需求更易于理解总体概述软件概述总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求
19、n描述软件与其它产品或项目所组成的整体环境本软件模块1外部模块3系统外部模块1系统外部模块2外部模块4n本节是概要性描述，最好使用图形描述系统或项目的组件、互联性及外部接口30总体概述软件功能总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n提供软件所实现功能的一个概要描述可以从更高层规格文档直接引用清楚易懂显示不同功能及其相互关系不描述具体需求功能3功能1功能2。总体概述用户特征总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n描述影响特定需求的最终用户的一般特征最
20、终用户：操作人员、维护人员、系统管理人员等考虑方面：受教育程度、经验、专业技术知识等总体概述假设和依赖总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n假设尚不确定但又必须要的情况下，所设定的一个参考结果，与已知事实相对。n依赖对外部条件的依赖，两者之间存在明确的需求关系。练习1.本项目基于PPPoFR和MPoFR应用，是针对虚模板上的QoS应用的增强型项目，要求原有的PPPoFR模块、QoS模块、MP模块稳定可靠。2.本项目依赖ACL模块的稳定性，包括ACL规则的维护、匹配等。3.本项目依赖VRP提供的VOS底层平台，如内存管理
21、、定时器、消息和队列等。4.本性能优化项目基于的前提是，目前系统转发性能的瓶颈在转发流程，而非硬件限制。下面的描述是假设还是依赖？假设依赖依赖假设需求建模需求需求建模建模具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求总体概述DFD样例在DOS环境下模拟实现ATM柜员机的功能需求分析方法更多的培训资料参见 h3crnd01-fs软件部规范软件部规范小特性开发规范小特性开发规范培训培训需求设计需求设计35具体需求功能需求功能需求具体需求具体需求性能需求性能需求接口需求接口需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附
22、录附录依赖依赖关系关系其它其它需求需求l逐条定义具体需求逐条定义具体需求l包含需求规格的所有细节包含需求规格的所有细节l一条需求必须有一个编号一条需求必须有一个编号具体需求功能需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求处理处理n功能需求描述每一个需求的输入怎样被转换成输出，描述软件必须执行的基本动作，同时给出该规格的优先级。输入输入输出输出具体需求功能需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求功能需功能需求描述求描述介绍介绍处理处理该功能的目的、使
23、用方法和技巧，及相关背景介绍所有输出数据的详细描述从输入数据和中间参数获得输出的所有操作所有输入数据的详细描述输入输入输出输出具体需求功能需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n输入数据的描述：输入来源数量度量单位时序允许的输入偏差范围具体需求功能需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n处理操作：输入数据合法性检测操作次序异常情况的响应操作影响到的参数用于把系统输入转换到相应输出的所有方法，诸如方程式，数学算法，逻辑操作对输出数据的合法性检
24、测l溢出l通信失败l错误处理40具体需求功能需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n输出数据的描述输出到何处（如打印机、文件等）数量度量单位时序允许的输出偏差范围对非法值的处理错误消息具体需求功能需求功能需求写作要点： 每个功能需求分配唯一编号，且给出一有意义的标题，便于检索。标题通常是动宾词组，不要使用“功能需求一/二”这样的描述。 是描述What to do，而不是How to do； 介绍部分描述“做什么”没有意义，因为后面IPO会详细介绍。应描述有利于理解后续IPO的内容： Why，为什么会有此需求 When
25、/Where，什么时候/什么场合使用 How，如何使用 对IPO描述中将使用到的特殊术语的解释 与其它功能需求的联系等具体需求功能需求功能需求写作要点(续)： 处理部分可以采用C语言中关键词如if、else、while等辅助描述，这样在时序、逻辑上更清晰； IPO缺一不可 有些情况下，输入输出可能不直观，如：定时器超时事件、接口up/down事件等，但并不是没有，否则处理什么。若认为实在没有，那最可能是功能需求分解不合理，所描述的功能根本就不成为需求。 不要将命令行作为功能需求描述 单纯的命令行不能提供任何功能，只是用户界面而已； 每一命令行之后都承载着一具体功能； 命令行的形式我们可以自行定
26、义，但其后的功能我们无法自行定义； 用户真正需要的是命令行承载的功能。命令行形式，甚至是命令行是否必要，这些用户并不会关心。练习2.1.1.取拨号口属性函数1.Introduction介绍 取以下配置：链路空闲挂断时间：dialer timer idle；呼叫间隔时间：dialer timer enable；链路建立等待时间：dialer timer wait-carrier；竞争等待时间： dialer timer compete；缓冲区报文数： dialer queue-length2.Inputs 输入 NULL。3.Process 处理 遍历所有的全局DDR控制块链表 是Dialer接
27、口和物理接口 取DDR的ifnet 取所有的拨号口属性 返回链表头指针4.Output 输出 拨号口属性链表头指针。1.在描述实现，按照这样的IPO描述无法对其进行验证；2.更应该作为一个接口需求，而不是功能需求；具体需求性能需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n描述软件或人机交互的静态和动态量化需求。静态的量化需求支持的终端数目支持的并发用户数目需处理的文件和记录的数目表和文件的大小动态的量化需求可包括正常和满负荷业务量条件下，某时间段（如一小时）内处理的事务和任务的数目以及数据量。45具体需求性能需求举例：性能
28、需求写作要点： 每条性能需求必须以可测量的术语进行描述，即应给出明确的量化指标，包括度量单位； 对于动态性能指标，除性能指标外，还应包含必要的的前置条件；前置条件交易能很快完成，操作员不必等待。95%的事务应在1秒内被处理。电梯由静止状态进入正常匀速(2m/s)状态时间限定在22.5s秒内。具体需求接口需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求接口需求接口需求硬件接口硬件接口软件接口软件接口用户接口用户接口通信接口通信接口软件人机交互特软件人机交互特性性与系统硬件之间与系统硬件之间的接口的接口与其他软件产品或应用与其他软
29、件产品或应用系统之间的接口系统之间的接口消息、回调函数等系消息、回调函数等系统内部通信接口统内部通信接口具体需求接口需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n用户接口示例：系统用户通过一个显示终端进行操作，需要描述：要求的屏幕格式页面布局以及报告或菜单的内容输入和输出的相关时序是否支持可编辑功能键具体需求接口需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n软件接口描述如何使用其他软件，针对每个所需软件描述：名字助记符版本号来源描述与其他软件的接口，针
30、对每个接口描述：接口的目的通过消息和格式定义接口具体需求接口需求接口需求写作要点： 用户接口若是命令行，写作需遵照操作手册的格式进行； 软件接口小节，应只描述本软件/系统对外提供的软件接口，不包括外部提供给本软件/系统的接口，后者应在依赖中予以描述； 软件接口若为函数，写作可以按照代码中函数头的格式进行，这样在后续阶段能很方便地重用。如：1.R.INTF.SOFT.001 1.R.INTF.SOFT.001 认证接口认证接口/* 函数名称: ATMLoginInProc* 功能描述: 读取输入的用户的账号名及密码，保存到当前用户信息全局变量中，* 并到账务处理系统进行认证。 * 输 入: 无
31、* 输 出: 无 * 返 回 值: VOS_OK： 表示登录成功； VOS_ERR：表示登录失败。 * 调用关系: 略* 其 它: 无*/50总体设计约束n描述由标准、硬件、技术限制等造成的对设计的限制标准顺从：描述来自现有标准和规则的需求报告格式数据命名协议硬件约束：描述支持软件运行的硬件条件，如内存限制技术限制：描述对使用的特定技术的限制，如数据库、并行操作等总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求软件质量属性n可维护性n可靠性n安全性n可移植性n易用性n.总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属
32、性简介简介附录附录依赖依赖关系关系其它其它需求需求软件质量属性总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n可维护性描述支持软件可维护的具体需求例如：跟踪调试功能告警提示功能对软件模块之间的耦合度进行考虑软件质量属性总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n可靠性容错性在出现软件故障的时候仍然能够维持某种层次性能的能力。可恢复性在出现故障时的恢复能力和重新建立某种层次性能的能力。例如：主备板热备份通信链路中断重连软件质量属性总体总体概述概述具体具体需求需求
33、设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n安全性在此描述防止软件遭到意外或恶意的侵入、使用、修改、破坏或泄密的因素。例如：使用特定的加密技术保存详细的日志或历史数据对不同模块分配特定的功能限制程序某些区域间进行通信对重要的数据计算校验和55软件质量属性总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求n可移植性描述把软件从一个环境转换到另一个环境时，所需要的用户程序、用户接口兼容性限制等需求。软件质量属性总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关
34、系关系其它其它需求需求n易用性易懂性：用户通晓逻辑概念花费的人力和软件的适用性易学性：用户学习应用程序花费的人力易操作性：用户操作应用程序所花费的人力依赖关系n依赖关系解释每一条需求的内部和外部依赖关系说明：依赖关系也可以在前面具体介绍每一条需求时进行描述总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求其它需求总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求数据库数据库操作操作本地化需求本地化需求其它需求其它需求附录n附录I/O 格式的示例，成本分析研究的描述，用户调
35、查的结果有助于用户阅读SRS的支持或背景信息软件将解决的问题的描述被支持组织的历史，背景，经验和操作特征软件需求与项目里程碑的交叉参考表，指明哪些软件需求将在哪些里程碑阶段里完成为了符合安全、出口、安装或其它需求，对代码和介质的特殊包装要求说明：附录不是必须要求的内容SRS中包含附录时，应明确声明附录是否是需求的一部分。总体总体概述概述具体具体需求需求设计设计约束约束质量质量属性属性简介简介附录附录依赖依赖关系关系其它其它需求需求60需求文档写作要点l仅关注“What to do”，即系统需提供什么功能。不要描述“How to do”，那是设计关注的事情。1.功能需求部分不要出现“函数”、“数
36、据结构”、“指针”、buildrun之类的表述；2.站在客户的立场上来写需求，而不是站在开发人员的立场上。需求文档写作要点l功能需求划分应合理3.1Functional Requirements 功能需求3.1.1配置要求通过PPP协商从对端得到协商的DNS地址1.Introduction介绍 在接口视图下通过以下命令来配置要求通过PPP主动协商从对端得到DNS地址：ppp ipcp dns request 2.Inputs 输入 用户在某一封装了PPP协议的接口视图下，输入 ：ppp ipcp dns request 3.Process 处理 路由器解析此命令输入正确后，将修改PPP协议中的
37、协商参数，使的路由器在进行PPP协商的时候会要求对端分配协商的DNS地址。4.Output 输出 操作成功后，可以通过在当前视图下输入 display this 命令来查看配置是否成功。否则显示出错提示。3.1.2配置取消要求通过PPP协商从对端得到协商的DNS地址1.Introduction介绍 在接口视图下通过以下命令来配置取消要求通过PPP主动协商从对端得到DNS地址：undo ppp ipcp dns request 需求文档写作要点2.Inputs 输入 用户在某一封装了PPP协议的接口视图下，输入 ： undo ppp ipcp dns request 3.Process 处理 路
38、由器解析此命令输入正确后，将修改PPP协议中的协商参数，使的路由器在进行PPP协商的时候不会要求对端分配协商的DNS地址。4.Output 输出 操作成功后，可以通过在当前视图下输入 display this 命令来查看先前配置是否被取消。否则显示出错提示。3.1.3配置保存协商得到的DNS地址，并可通过命令display interface查看1.Introduction介绍 保存从对端协商得到的DNS地址，并可通过查看接口信息的display interface命令将得到的DNS地址显示出来。2.Inputs 输入 取出协商得到的DNS地址3.Process 处理 路由器保存协商得到的DN
39、S地址，并将其添加到接口信息中4.Output 输出 操作成功后，协商得到的DNS地址保存GotOptions里，并被添加到接口信息中，否则显示出错提示，不会显示在接口信息中。分析： 前两个功能点是在描述一条命令行，而后一功能点描述的是另一条相关的命令行。 用户的需求是什么？是这两条命令行吗？ 命令行只是我们提供的用户界面，隐藏其后的功能需求是什么？ “支持通过PPP协商获取DNS地址”，就这一条。 拆成三条，需求分解不合理，如何修正？ 一条功能需求（支持通过PPP协商获取DNS地址） display命令的修改可以在功能需求的输出中提及。 一条接口需求（undo ppp ipcp dns re
40、quest ）需求文档写作要点唐僧：唉唉唉！大家不要生气，生气会犯了嗔戒的！悟空你也太调皮了，我跟你说过，叫你不要乱扔东西。乱扔东西这么多你看我还没说完呢，你把棍子又给扔掉了！月光宝盒是宝物，你把它扔掉会污染环境。唉，要是砸到小朋友呢，怎么办？就算没有砸到小朋友，砸到那些花花草草也是不对的呀！l保持语句和段落的简短。需求文档写作要点l需求陈述应该具有一致的样式。例如“系统必须”或者“用户必须”，并紧跟一个行为动作和可观察的结果。3举例：计算过程中出现除零错误时，系统必须立即弹出对话框显示该错误，并进行声音提示。6举例：计算过程中出现除零错误时，系统必须给出提示信息。65需求文档写作要点l必须避
41、免模糊的、主观的术语，减少不确定性。例如：也许、大概、可能、界面友好、容易、简单、美观、迅速、有效、支持、许多、最新技术、优越的、可接受的和健壮的。 . .美女美女. !需求文档写作要点l避免使用比较性的词汇，例如：提高、最大化、最小化和最佳化。定量地说明所需要提高的程度或者说清一些参数可接受的最大值和最小值。提高文件柜提高文件柜的高度。的高度。伙计2伙计3伙计1伙计1需求文档写作要点l不应该把多个需求集中在一个冗长的叙述段落中。务必记住：不要在需求说明中使用“和/或”，“等等”之类的连词。lC&C08交换机应该提供呼叫等待和三方通话等新业务。lC&C08交换机应该提供呼叫等待功能。lC&C0
42、8交换机应该提供三方通话功能。lC&C08交换机应该提供呼叫转移功能。lC&C08交换机应该提供闹钟服务功能。 这个“等”包含哪些内容？怎么测试？测试人员需求范例69课程内容l为什么要文档化l文档写作基本要求l需求设计文档模板l需求文档写作l设计文档写作设计文档大纲(开发项目)零层零层设计设计一层一层设计设计二层设计配置和控制简介简介模块模块1 1详设详设数据库模块模块n n详设详设HLDHLDLLDLLD上下文定义设计思路分解描述依赖性描述接口描述分解描述依赖性描述接口描述数据描述函数描述开发项目：系统总体设计子系统设计系统对外关系HLD分解层次一般不超过3层（0层、1层、2层），每层的模块
43、数以2到4个为宜，最多不要超过7个。单元模块函数总数也不超过7个；HLD阶段将所有函数全部分解出来，LLD阶段不再关注模块分解；HLD使用结构图描述函数的调用关系；函数分解规模以3050行(非空非注释)为宜，最大不超过200行。每个函数的复杂度控制在10以内，即：一个函数中不能有太多的if，else，for, switchcase等逻辑；LLD阶段写伪码，推荐在source insight中写，完成后嵌入LLD中。伪码的粗细程度以适宜作注释为标准；设计文档写作要点结构图(structure chart)描述了一个系统的模块划分，体现了模块之间的层次、组织和通信关系 示例：结构图伪码又叫PDL(
44、Program Design Language)，是一种混合语言，用自然语言（如英语、汉语等）描述程序的处理逻辑，用一定的关键字语法（如if、else等）定义控制结构和数据结构。优点：优点：维护方便容易评审作为代码注释缺点：缺点：不容易掌握粗细容易写成代码伪码伪码 = 关键字语法 + 自然语言描述伪码 使用C语言的语法书写伪代码，使用标准符号，如：if, else, , while等； 用描述性语言来描述；if（接口是以太网接口）if（InterfaceType = ETHERNET) 详略得当。用概括性的语句来描述具体的处理，要求在每个逻辑处理分支用简练、概括性的语言描述处理，而不要局限于处
45、理的细节。 封装IP报文头的内容;用收到报文的源地址来设置发送报文的目的地址;用发送报文接口的地址来设置发送报文的源地址;伪码写作说明：75设计样例设计文档大纲(增强、移植项目)移植或增强项目：修改分类修改分类1 1修改原因影响分析修改描述修改点1修改点n修改分类修改分类N N增强、移植设计修改分类： 对所有需要的修改点进行分类，一个修改分类包含一个或多个修改点，实现一相对独立的功能； 每个修改分类都应使用有明确含义的标题，如：“关于XXX的修改”。修改分类一关于将MQC策略应用到ATM PVC接口下的修改修改点： 一个修改点描述一处修改，如一个数据结构的修改，一个宏定义的修改，一个函数的修改
46、等； 修改点也应使用有意义的标题，不要使用“修改点1”等。增强、移植设计修改原因：修改原因： 针对每个修改点，具体阐述为什么需要修改，如因为某某处理流程的变化，功能的扩展，界面的变化，性能的优化等； 不应该描述修改什么，这是修改描述部分应详细介绍的内容； 修改原因中的描述应有助于对修改描述的理解。修改修改原因原因影响影响分析分析修改修改描述描述增强、移植设计影响分析：影响分析： 应评估修改对原模块有无冲击，从功能、性能、接口等多方面进行评估； 应评估修改对系统资源的消耗情况； 应描述为了配合此修改点还需要作哪些修改，即将各修改点关联起来。 还应考虑对测试的影响，即如何充分地验证这些修改。影响影
47、响分析分析修改修改原因原因修改修改描述描述80增强、移植设计修改描述：修改描述： 使用合适的标注方式标注方式描述修改，修改前后对比要明显；修改修改描述描述影响影响分析分析修改修改原因原因新增的代码：用红色表示新增的代码：用红色表示修改的代码：用蓝色表示修改的代码：用蓝色表示删除的代码：用删除线表示删除的代码：用删除线表示增强、移植设计修改描述修改描述:(:(续续) ) 对原代码的修改一定要将修改的具体位置体现出来； 新增函数应采用伪码描述，与原有函数的调用关系应该用函数调用关系图的方式表示出来，便于理解； 对于修改函数，若改动量很小或很分散，可以直接用代码描述；对于大段集中的修改，建议还是采用
48、伪码描述。修改修改描述描述影响影响分析分析修改修改原因原因练习2.修改点struct crypto_xf transforms1）修改原因crypto_xf transforms结构增加AES；2）影响分析无3）修改描述struct crypto_xf transforms = AES_CBC, AES(CBC-Mode), 16, 32, 2 * BLOCKSIZE, NULL, IKE_AesInit, IKE_AesEncrypt, IKE_AesDecrypt 修改原因还是在描述如何修改，为什么修改却没有阐述。 影响分析“无”，是无影响，还是没有分析？ 修改描述中没有体现出修改在原代码
49、中的具体位置。练习2.修改点2 数据结构修改：ETHARP_ARPRTENTRY_S1）修改原因 需要在ARP表项节点纪录授权表项标志位。2）影响分析 修改原有数据结构，对其他模块无影响。3）修改描述typedef struct tagARPRTENTRY。#if ( VRP_MODULE_LINK_ARP_AUTHORIZED = VRP_YES ) ULONG ulArpAuthTag; /* 授权表项标志位 * 0 x1 - 授权ARP; * 0 x0 - 其他; */#endifETHARP_ARPRTENTRY_S; 修改原因还是在描述如何修改，没有介绍增加该标志是为了什么。 影响分
50、析“对其他模块无影响”，结构体变大，有没有评估对系统内存资源的消耗？增强、移植设计范例85思考对于开发项目，在详细设计阶段，我们提倡在C文件中写伪码，这样较之在word文档中写伪码的好处有：1.可读性更好。伪码在形式上很接近于代码，而大家更习惯在source insight中阅读代码；2.利于评审，原因同上；3.编码阶段可直接重用。对于增强、移植项目，目前大家都是在word文档中写设计，是因为word文档中可以使用特殊的标注，这样能将修改前后的对比体现出来。移植设计能否也在移植设计能否也在C文件中写呢？文件中写呢？请大家思考这个问题，如果有好的想法，可以提出来讨论。内容回顾l为什么要文档化l文
