华为需求和设计工程写作(含模版)省公共课一等奖全国赛课获奖课件.pptx
《华为需求和设计工程写作(含模版)省公共课一等奖全国赛课获奖课件.pptx》由会员分享,可在线阅读,更多相关《华为需求和设计工程写作(含模版)省公共课一等奖全国赛课获奖课件.pptx(90页珍藏版)》请在咨信网上搜索。
1、需求设计写作培训需求设计写作培训质量管理部质量管理部SQA小组小组.06第第1页页课程范围u仅关注怎样写作文档u不包括详细需求分析和设计方法第第2页页课程内容l为何要文档化l文档写作基本要求l需求设计文档模板l需求文档写作l设计文档写作第第3页页为何要文档化开发人员经过文档化过程查错补遗;便于评审,在早期发觉技术上问题;后续阶段开发任务可能由他人负担,输出文档便于他们开展工作;维护人员开展维护工作需要;文档是必要交付件;可读性就尤为关键第第4页页为何要文档化“全部过程分析都要形成文档。我们现在有一个严重问题是,大家好像不喜欢写文档,对于需要实现方案,通常都是一个责任人在脑袋里想想该怎么实现,然
2、后邮件或电话找几个相关人员讨论一下就算能够了,可能连个会议材料或会议纪要都没有。而老外可不是这么,他们非常非常重视文档,他们认为一个人在脑袋里想东西是不清楚也不全方面,有时候心里想认为很正确方案实际上可能存在致命缺点。他们要求必须把心里想法形成文档才能有效防止这种问题。写文档过程中,能够愈加有效、更深入去整理您原来心里思绪,很多问题在您写过文档过程中您就能发觉;另外,文档写作多使用图表,浪费口水文字尽可能少用,和我们一起工作系统工程师在系统架构分析中就画了五六十张图,就算看不懂他写英文,从图中我们就能够很清楚指导整个产品系统架构。”摘自一位华为员工瑞典出差汇报5第第5页页课程内容l为何要文档化
3、l文档写作基本要求l需求设计文档模板l需求文档写作l设计文档写作第第6页页文档写作基本要求下面文档出自于我们开发人员手笔,大家以为怎样?第第7页页文档写作基本要求应使用标准模板写作;文档封页、页眉页脚、修订统计、附录、参考文件应完善;关键词、摘要、缩略语应完整;目录要及时更新;通篇文档标题、文字格式、间距应协调美观;全部文档模板中章节,只可增加,不可删除;编写提议是用来指导文档写作,在利用完后要及时删除;图号置于图形之下,表号置于表格之上;第第8页页文档写作基本要求应追求图文并茂效果;句子和段落要短;使用语言应严谨,不要使用白话;采取主动语气;不要出现“我们”、“你们”、“他们”这么称谓,或“
4、这个”、“那个”这么词,应使用“本”、“该”、“其”;表述清楚,防止引发歧义;通篇文档细节上要保持一致;第第9页页练习 房子南北走向,房子大门在东侧中间位置。门厅长约3米,宽2米,门厅左面是主卧室,右面是厨房。厨房3米宽,4米长,厨房门对着门厅,厨房顶头还有一个北阳台,与厨房同宽,长1米。主卧室宽3米,长5米左右,房间门对着客厅。客厅与餐厅连为一体,共7米长,4米宽,与客厅相连有一南阳台,与客厅同宽,长1.5米。餐厅北面是卫生间,卫生间与厨房相对,中间由1米宽,3米长过道隔开;卫生间门对着过道,南墙与厨房南墙在一条直线上;卫生间为长方形,南墙长3米,另一边长2米。卫生间北面是次卧,同宽,门朝着
5、过道,次卧长4米。过道北端是书房门,书房南北长4米,书房有一个一米见方门厅,书房西墙长4米,包含1米长门厅长度,西墙把书房和次卧分隔开。门厅东墙北端90角折向东,长2米,把书房和厨房北阳台分隔开。大家认为下面描述怎样?终究长多少??是左?是左?还是右?还是右?大段叙述,不大段叙述,不利于了解!利于了解!10第第10页页练习1.房子南北走向,房子大门在东侧中间位置。2.门厅长3米,宽2米,门厅左面是主卧室,右面是厨房。3.厨房3米宽,4米长,厨房门对着门厅,厨房顶头还有一个北阳台,与厨房同宽,长1米。4.主卧室宽3米,长5米左右,房间门对着客厅。5.客厅与餐厅连为一体,共7米长,4米宽,与客厅相
6、连有一南阳台,与客厅同宽,长1.5米。6.餐厅北面是卫生间,卫生间与厨房相对,中间由1米宽,3米长过道隔开;卫生间门对着过道,南墙与厨房南墙在一条直线上;卫生间为长方形,南墙长3米,另一边长2米。7.卫生间北面是次卧,同宽,门朝着过道,次卧长4米。8.过道北端是书房门,书房南北长4米,书房有一个一米见方门厅,书房西墙长4米,包含1米长门厅长度,西墙把书房和次卧分隔开。门厅东墙北端90角折向东,长2米,把书房和厨房北阳台分隔开。修改成以下描述之后呢?第第11页页练习主卧室主卧室次卧室次卧室厨房厨房餐厅餐厅客厅客厅阳台阳台阳台阳台卫生间卫生间书房书房门厅门厅过道过道北北西西再改成以下列图形描述呢?
7、第第12页页练习LSW与CAMS配合实现认证计费方案中,客户(禁止多人同时使用业务帐号)登陆经过认证开始计费后,假如出现LSW重起情况,处理方法分为两种:1.有时间芯片LSW(能够统计时间),设备重起后会使用设备时间戳特征判断出设备重起了,这时会将CAMS上在线用户删除并按照最终一次计费更新报文来终止计费。用户可再次正常登陆。2.下面描述呢?白话修改成以下描述呢?1.使用时间芯片LSW(支持统计时间功效),利用设备时间戳特征能够检测出设备是否重启,设备重启时将CAMS上在线用户删除,并依据最终一次计费更新报文终止计费。用户可再次正常登陆。第第13页页练习因为一台设备能够设置多个radius服务
8、器,也就是radius scheme。用户能够经过命令行来配置该radius服务器是否开启设备重启防吊死功效。因为一台设备能够设置多个radius服务器,即radius scheme。用户能够经过命令行来配置该radius服务器是否开启设备重启防吊死功效。第第14页页练习CAMS收到该报文后会马上回应一个code=5计费回应报文,然后依据accounting-on报文携带NAS-IP和NAS-ID找到经过该设备认证用户,并将他们在线信息删除。CAMS收到该报文后会马上回应一个code=5计费回应报文,然后依据accounting-on报文携带NAS-IP和NAS-ID找到经过该设备认证用户,并
9、将其在线信息删除。15第第15页页练习修改原因:这个函数是将要发送packet转化为buffer,系统原有函数RD_PutPacketToBuffer是针对认证用户设计,因为本特征为设备开启后执行,没有用户信息,所以在RD_PutPacketToBuffer函数基础上做了一些修改,形成该函数。修改原因:该函数实现将待发送packet转化为buffer功效,系统原有函数RD_PutPacketToBuffer针对认证用户设计,因为本特征为设备开启后执行,没有用户信息,所以在RD_PutPacketToBuffer函数基础上做了一些修改,形成该函数。第第16页页练习ARP Authorized加强
10、了网络安全,阻止了DHCP server对非法ARP回应进行学习,而且经过周期ARP ping能够快速探测到用户是否下线。在设备接口上使能ARP Authorized,该接口ARP动态学习功效被禁止。在某个接口上禁止arp动态学习,不影响其它接口arp学习。在禁止了arp动态学习接口上,只能经过手工添加静态arp,或者其它一些被允许模块才能够添加arp,这种arp被称为ARP Authorized,授权arp不再和其它动态表项一样老化,而是有自己老化机制,后面会说明。DHCP server就是这么一个模块。静态arp优先级高于授权arp,也就是说能够覆盖授权arp。1.ARP与arp、ARP
11、Authorized与授权arp,使用术语应该统一;2.ARP Authorized应先解释后引用;3.“DHCP server就是这么一个模块”,是否相关?第第17页页课程内容l为何要文档化l文档写作基本要求l需求设计文档模板l需求文档写作l设计文档写作第第18页页模板何处获取需求SRS文档:REP01T01http:/jvpal接口文档:REP01T03http:/jvpal设计概要设计:DVP05T01http:/jvpal详细设计:DVP05T03http:/jvpal软件设计:DVP05T04http:/jvpal移植设计:DVP05T05http:/jvpal需求设计合一来自华为北
12、研所h3crnd01-fs软件部规软件部规范范小特征开发规范小特征开发规范模模板板需求设计需求设计需求设计文档模板19第第19页页课程内容l为何要文档化l文档写作基本要求l需求设计文档模板l需求文档写作l设计文档写作第第20页页什么是好需求什么样需求是好需求完整性清楚性可行性一致性可验证性第第21页页练习2.1.1Functional Requirements1 功效需求1修改设置smarton password命令1.Introduction介绍 在设置smarton password同时,要求密码显示形式为明文和密文。2.Inputs 输入 1)密码显示形式。2)smarton passw
13、ord。3.Process 处理 1)统计密码显示形式。2)当密码显示形式为simple时,直接设置smarton password为设置值;当密码显示形式为cipher时,假如设置值是密文,先将其进行解密成明文再设置,假如是明文则直接设置。4.output输出 无5.Inherit继承性 Update-需要改进大家看看下面需求描述怎样?1.介绍中描述显示形式有明文和密文两种,但处理中描述显示形式却是simple和cipher,不一致;2.密码允许输入哪些字符,长度有没有限制,均没有交待。不完整3.输出没有吗?不完整第第22页页练习2.1.1配置或者取消配置系统WOL功效1.Introduct
14、ion介绍 在系统视图下配置或者取消配置WOL使能。2.Inputs 输入 系统视图下:wol enable 或 undo wol enable3.Process 处理 在系统视图下配置或者取消WOL使能。去系统WOL使能时,将WOL模块MAC-ADDR表清空,释放所占内存。初始化MAC地址表相关指针。4.output输出 WOL功效在系统中被使能或被去使能;去系统使能时,MAC-ADDR表被清空。5.Inherit继承性 NEW-新增功效在前面没有介绍情况下,这里应对缩略语进行详细解释,不然不完整第第23页页练习2.1.1SRS.FUNC.DHG.001 IKE模块支持DH交换时使用Grou
15、p5,Group141.Introduction介绍 支持IKE DH组Group5和Group14是由8040波兰提出新需求,用户希望能提供更高安全级别安全密钥,希望能支持DH 3/4/5,不过DH Group3/4是由椭圆曲线来实现,与Group1/2/5有很大区分,且需要较大工作量,所以此次特征开发暂且实现对Group5/14支持。完整性:这种术语也应该简单介绍,毕竟不是算数学题第第24页页练习2.2.18 R.FUNC.018支持XRN堆叠 3.Process 处理 当unit down时,处理端口删除消息,把down掉unit端口从镜像组中删除,由此可能有对应镜像组状态改变。当收到u
16、nit up消息时,本unit向其它unit发送端口镜像同时消息。此消息包含本unit所配置镜像组信息。2.2.1Performance Requirements 性能需求1.Performance Requirements1 性能需求1 通话语音要求流畅。“可能”、“流畅”都是不清楚,不一样人了解不一样。不清楚普通也不可验证。25第第25页页SRS纲领简介简介目目范围范围总体概述总体概述软件概述软件概述软件功能软件功能用户特征用户特征假设和依赖关系假设和依赖关系需求建模需求建模建模工具建模工具具体需求具体需求功能需求功能需求性能需求性能需求外部接口需求外部接口需求l总体设计约束标准符合性硬件
17、约束技术限制l软件质量属性可维护性可靠性l依赖关系l其它需求l需求分级l附录第第26页页介绍总体总体概述概述详细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求目目范围范围描述文档目描述文档目指明文档读者指明文档读者l软件命名l软件要做什么,不做什么l软件应用要点:要点:“目目”是针对文档,是针对文档,“范围范围”针对是软件功能。针对是软件功能。第第27页页练习1Introduction 介绍1.1Purpose 目标 本文用于描述DHCP增强项目中ARP相关需求需求及设计,满足以下分配需求:1.在接口上禁止ARP动态学习;2.允许DHCP serv
18、er添加授权ARP;3.ARP PING;4.配置授权ARP老化时间;5.假如dhcp server删除租约则应删除对应arp;6.删除授权ARP表项后删除租约;本文适合用于相关开发及维护人员,本文档描述了COMWAREV300R002产品软件需求。1.2Scope 范围 本文包含DHCP增强项目中ARP相关需求需求规格分析及软件设计说明。本文不包含相关实当代码、用户指导及测试计划。应在范围中描述范围不是用来描述本文包范围不是用来描述本文包含什么、不包含什么含什么、不包含什么第第28页页总体概述总体总体概述概述详细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它
19、其它需求需求假设和依假设和依赖关系赖关系总体总体概述概述软件功效软件功效用户特征用户特征软件概述软件概述本节不对需求作详细描述,只是为了使那些需求更易于了解第第29页页总体概述软件概述总体总体概述概述详细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求n描述软件与其它产品或项目所组成整体环境本软件模块1外部模块3系统外部模块1系统外部模块2外部模块4本节是概要性描述,最好使用图形描述系统或项目组件、互联性及外部接口本节是概要性描述,最好使用图形描述系统或项目组件、互联性及外部接口30第第30页页总体概述软件功效总体总体概述概述详细详细需求需求设计设计
20、约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求n提供软件所实现功效一个概要描述能够从更高层规格文档直接引用清楚易懂显示不一样功效及其相互关系不描述详细需求功效3功效1功效2。第第31页页总体概述用户特征总体总体概述概述详细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求n描述影响特定需求最终用户普通特征最终用户:操作人员、维护人员、系统管理人员等考虑方面:受教育程度、经验、专业技术知识等第第32页页总体概述假设和依赖总体总体概述概述详细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需
21、求n假设尚不确定但又必须要情况下,所设定一个参考结果,与已知事实相对。n依赖对外部条件依赖,二者之间存在明确需求关系。第第33页页练习1.本项目基于PPPoFR和MPoFR应用,是针对虚模板上QoS应用增强型项目,要求原有PPPoFR模块、QoS模块、MP模块稳定可靠。2.本项目依赖ACL模块稳定性,包含ACL规则维护、匹配等。3.本项目依赖VRP提供VOS底层平台,如内存管理、定时器、消息和队列等。4.本性能优化项目基于前提是,当前系统转发性能瓶颈在转发流程,而非硬件限制。下面描述是假设还是依赖?假设依赖依赖假设第第34页页需求建模需求需求建模建模详细详细需求需求设计设计约束约束质量质量属性
22、属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求总体概述DFD样例在DOS环境下模拟实现ATM柜员机功效需求分析方法更多培训资料参见 h3crnd01-fs软件部规范软件部规范小特征开发规范小特征开发规范培训培训需求设计需求设计35第第35页页详细需求功效需求功效需求详细需求详细需求性能需求性能需求接口需求接口需求总体总体概述概述详细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求l逐条定义详细需求逐条定义详细需求l包含需求规格全部细节包含需求规格全部细节l一条需求必须有一个编号一条需求必须有一个编号第第36页页详细需求功效需求总体总体概述概述详
23、细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求处理处理n功效需求描述每一个需求输入怎样被转换成输出,描述软件必须执行基本动作,同时给出该规格优先级。输入输入输出输出第第37页页详细需求功效需求总体总体概述概述详细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求功效需功效需求描述求描述介绍介绍处理处理该功效目标、使用方法和技巧,及相关背景介绍全部输出数据详细描述从输入数据和中间参数取得输出全部操作全部输入数据详细描述输入输入输出输出第第38页页详细需求功效需求总体总体概述概述详细详细需求需求设计设计约束约
24、束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求n输入数据描述:输入起源数量度量单位时序允许输入偏差范围第第39页页详细需求功效需求总体总体概述概述详细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求n处理操作:输入数据正当性检测操作次序异常情况响应操作影响到参数用于把系统输入转换到对应输出全部方法,诸如方程式,数学算法,逻辑操作对输出数据正当性检测l溢出l通信失败l错误处理40第第40页页详细需求功效需求总体总体概述概述详细详细需求需求设计设计约束约束质量质量属性属性介绍介绍附录附录依赖依赖关系关系其它其它需求需求n输出数据描述输
25、出到何处(如打印机、文件等)数量度量单位时序允许输出偏差范围对非法值处理错误消息第第41页页详细需求功效需求功效需求写作关键点:每个功效需求分配唯一编号,且给出一有意义标题,便于检索。标题通常是动宾词组,不要使用“功效需求一/二”这么描述。是描述What to do,而不是How to do;介绍部分描述“做什么”没有意义,因为后面IPO会详细介绍。应描述有利于了解后续IPO内容:Why,为何会有此需求 When/Where,什么时候/什么场所使用 How,怎样使用 对IPO描述中将使用到特殊术语解释 与其它功效需求联络等第第42页页详细需求功效需求功效需求写作关键点(续):处理部分能够采取C
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 华为 需求 设计 工程 写作 模版 公共课 一等奖 全国 获奖 课件
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【精****】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【精****】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。