華為需求和設(shè)計(jì)工程寫作(含模版)名師優(yōu)質(zhì)課賽課一等獎(jiǎng)市公開課獲獎(jiǎng)?wù)n件

需求設(shè)計(jì)寫作培訓(xùn)質(zhì)量管理部SQA小組.06第1頁(yè)課程范圍僅關(guān)注怎樣寫作文檔不包括詳細(xì)需求分析和設(shè)計(jì)方法第2頁(yè)課程內(nèi)容為何要文檔化文檔寫作基本要求需求設(shè)計(jì)文檔模板需求文檔寫作設(shè)計(jì)文檔寫作第3頁(yè)為何要文檔化開發(fā)人員經(jīng)過(guò)文檔化過(guò)程查錯(cuò)補(bǔ)遺；便于評(píng)審，在早期發(fā)覺(jué)技術(shù)上問(wèn)題；后續(xù)階段開發(fā)任務(wù)可能由他人負(fù)擔(dān)，輸出文檔便于他們開展工作；維護(hù)人員開展維護(hù)工作需要；文檔是必要交付件；…………可讀性就尤為關(guān)鍵第4頁(yè)為何要文檔化“全部過(guò)程分析都要形成文檔。我們現(xiàn)在有一個(gè)嚴(yán)重問(wèn)題是，大家好像不喜歡寫文檔，對(duì)于需要實(shí)現(xiàn)方案，通常都是一個(gè)責(zé)任人在腦袋里想想該怎么實(shí)現(xiàn)，然后郵件或電話找?guī)讉€(gè)相關(guān)人員討論一下就算能夠了，可能連個(gè)會(huì)議材料或會(huì)議紀(jì)要都沒(méi)有。而老外可不是這么，他們非常非常重視文檔，他們認(rèn)為一個(gè)人在腦袋里想東西是不清楚也不全方面，有時(shí)候心里想認(rèn)為很正確方案實(shí)際上可能存在致命缺點(diǎn)。他們要求必須把心里想法形成文檔才能有效防止這種問(wèn)題。寫文檔過(guò)程中，能夠愈加有效、更深入去整理您原來(lái)心里思緒，很多問(wèn)題在您寫過(guò)文檔過(guò)程中您就能發(fā)覺(jué)；另外，文檔寫作多使用圖表，浪費(fèi)口水文字盡可能少用，和我們一起工作系統(tǒng)工程師在系統(tǒng)架構(gòu)分析中就畫了五六十張圖，就算看不懂他寫英文，從圖中我們就能夠很清楚指導(dǎo)整個(gè)產(chǎn)品系統(tǒng)架構(gòu)?！?/p>

——

摘自一位華為員工瑞典出差匯報(bào)5第5頁(yè)課程內(nèi)容為何要文檔化文檔寫作基本要求需求設(shè)計(jì)文檔模板需求文檔寫作設(shè)計(jì)文檔寫作第6頁(yè)文檔寫作基本要求下面文檔出自于我們開發(fā)人員手筆，大家以為怎樣？第7頁(yè)文檔寫作基本要求應(yīng)使用標(biāo)準(zhǔn)模板寫作；文檔封頁(yè)、頁(yè)眉頁(yè)腳、修訂統(tǒng)計(jì)、附錄、參考文件應(yīng)完善；關(guān)鍵詞、摘要、縮略語(yǔ)應(yīng)完整；目錄要及時(shí)更新；通篇文檔標(biāo)題、文字格式、間距應(yīng)協(xié)調(diào)美觀；全部文檔模板中章節(jié)，只可增加，不可刪除；編寫提議是用來(lái)指導(dǎo)文檔寫作，在利用完后要及時(shí)刪除；圖號(hào)置于圖形之下，表號(hào)置于表格之上；第8頁(yè)文檔寫作基本要求應(yīng)追求圖文并茂效果；句子和段落要短；使用語(yǔ)言應(yīng)嚴(yán)謹(jǐn)，不要使用白話；采取主動(dòng)語(yǔ)氣；不要出現(xiàn)“我們”、“你們”、“他們”這么稱謂，或“這個(gè)”、“那個(gè)”這么詞，應(yīng)使用“本××”、“該××”、“其”；表述清楚，防止引發(fā)歧義；通篇文檔細(xì)節(jié)上要保持一致；第9頁(yè)練習(xí)

房子南北走向，房子大門在東側(cè)中間位置。門廳長(zhǎng)約3米，寬2米，門廳左面是主臥室，右面是廚房。廚房3米寬，4米長(zhǎng)，廚房門對(duì)著門廳，廚房頂頭還有一個(gè)北陽(yáng)臺(tái)，與廚房同寬，長(zhǎng)1米。主臥室寬3米，長(zhǎng)5米左右，房間門對(duì)著客廳?？蛷d與餐廳連為一體，共7米長(zhǎng)，4米寬，與客廳相連有一南陽(yáng)臺(tái)，與客廳同寬，長(zhǎng)1.5米。餐廳北面是衛(wèi)生間，衛(wèi)生間與廚房相對(duì)，中間由1米寬，3米長(zhǎng)過(guò)道隔開；衛(wèi)生間門對(duì)著過(guò)道，南墻與廚房南墻在一條直線上；衛(wèi)生間為長(zhǎng)方形，南墻長(zhǎng)3米，另一邊長(zhǎng)2米。衛(wèi)生間北面是次臥，同寬，門朝著過(guò)道，次臥長(zhǎng)4米。過(guò)道北端是書房門，書房南北長(zhǎng)4米，書房有一個(gè)一米見方門廳，書房西墻長(zhǎng)4米，包含1米長(zhǎng)門廳長(zhǎng)度，西墻把書房和次臥分隔開。門廳東墻北端90角折向東，長(zhǎng)2米，把書房和廚房北陽(yáng)臺(tái)分隔開。大家認(rèn)為下面描述怎樣？終究長(zhǎng)多少？?

是左？還是右？大段敘述，不利于了解！10第10頁(yè)練習(xí)1.房子南北走向，房子大門在東側(cè)中間位置。2.門廳長(zhǎng)3米，寬2米，門廳左面是主臥室，右面是廚房。3.廚房3米寬，4米長(zhǎng)，廚房門對(duì)著門廳，廚房頂頭還有一個(gè)北陽(yáng)臺(tái)，與廚房同寬，長(zhǎng)1米。4.主臥室寬3米，長(zhǎng)5米左右，房間門對(duì)著客廳。5.客廳與餐廳連為一體，共7米長(zhǎng)，4米寬，與客廳相連有一南陽(yáng)臺(tái)，與客廳同寬，長(zhǎng)1.5米。6.餐廳北面是衛(wèi)生間，衛(wèi)生間與廚房相對(duì)，中間由1米寬，3米長(zhǎng)過(guò)道隔開；衛(wèi)生間門對(duì)著過(guò)道，南墻與廚房南墻在一條直線上；衛(wèi)生間為長(zhǎng)方形，南墻長(zhǎng)3米，另一邊長(zhǎng)2米。7.衛(wèi)生間北面是次臥，同寬，門朝著過(guò)道，次臥長(zhǎng)4米。8.過(guò)道北端是書房門，書房南北長(zhǎng)4米，書房有一個(gè)一米見方門廳，書房西墻長(zhǎng)4米，包含1米長(zhǎng)門廳長(zhǎng)度，西墻把書房和次臥分隔開。門廳東墻北端90角折向東，長(zhǎng)2米，把書房和廚房北陽(yáng)臺(tái)分隔開。修改成以下描述之后呢？第11頁(yè)練習(xí)主臥室次臥室廚房餐廳客廳陽(yáng)臺(tái)陽(yáng)臺(tái)衛(wèi)生間書房門廳過(guò)道北西再改成以下列圖形描述呢？第12頁(yè)練習(xí) LSW與CAMS配合實(shí)現(xiàn)認(rèn)證計(jì)費(fèi)方案中，客戶（禁止多人同時(shí)使用業(yè)務(wù)帳號(hào)）登陸經(jīng)過(guò)認(rèn)證開始計(jì)費(fèi)后，假如出現(xiàn)LSW重起情況，處理方法分為兩種：

1.有時(shí)間芯片LSW（能夠統(tǒng)計(jì)時(shí)間），設(shè)備重起后會(huì)使用設(shè)備時(shí)間戳特征判斷出設(shè)備重起了，這時(shí)會(huì)將CAMS上在線用戶刪除并按照最終一次計(jì)費(fèi)更新報(bào)文來(lái)終止計(jì)費(fèi)。用戶可再次正常登陸。

2.……下面描述呢？白話修改成以下描述呢？ ………… 1.使用時(shí)間芯片LSW（支持統(tǒng)計(jì)時(shí)間功效），利用設(shè)備時(shí)間戳特征能夠檢測(cè)出設(shè)備是否重啟，設(shè)備重啟時(shí)將CAMS上在線用戶刪除，并依據(jù)最終一次計(jì)費(fèi)更新報(bào)文終止計(jì)費(fèi)。用戶可再次正常登陸。第13頁(yè)練習(xí)因?yàn)橐慌_(tái)設(shè)備能夠設(shè)置多個(gè)radius服務(wù)器，也就是radiusscheme。用戶能夠經(jīng)過(guò)命令行來(lái)配置該radius服務(wù)器是否開啟設(shè)備重啟防吊死功效。因?yàn)橐慌_(tái)設(shè)備能夠設(shè)置多個(gè)radius服務(wù)器，即radiusscheme。用戶能夠經(jīng)過(guò)命令行來(lái)配置該radius服務(wù)器是否開啟設(shè)備重啟防吊死功效。第14頁(yè)練習(xí)CAMS收到該報(bào)文后會(huì)馬上回應(yīng)一個(gè)code=5計(jì)費(fèi)回應(yīng)報(bào)文，然后依據(jù)accounting-on報(bào)文攜帶NAS-IP和NAS-ID找到經(jīng)過(guò)該設(shè)備認(rèn)證用戶，并將他們?cè)诰€信息刪除。CAMS收到該報(bào)文后會(huì)馬上回應(yīng)一個(gè)code=5計(jì)費(fèi)回應(yīng)報(bào)文，然后依據(jù)accounting-on報(bào)文攜帶NAS-IP和NAS-ID找到經(jīng)過(guò)該設(shè)備認(rèn)證用戶，并將其在線信息刪除。15第15頁(yè)練習(xí)修改原因：這個(gè)函數(shù)是將要發(fā)送packet轉(zhuǎn)化為buffer，系統(tǒng)原有函數(shù)RD_PutPacketToBuffer是針對(duì)認(rèn)證用戶設(shè)計(jì)，因?yàn)楸咎卣鳛樵O(shè)備開啟后執(zhí)行，沒(méi)有用戶信息，所以在RD_PutPacketToBuffer函數(shù)基礎(chǔ)上做了一些修改，形成該函數(shù)。

修改原因：該函數(shù)實(shí)現(xiàn)將待發(fā)送packet轉(zhuǎn)化為buffer功效，系統(tǒng)原有函數(shù)RD_PutPacketToBuffer針對(duì)認(rèn)證用戶設(shè)計(jì)，因?yàn)楸咎卣鳛樵O(shè)備開啟后執(zhí)行，沒(méi)有用戶信息，所以在RD_PutPacketToBuffer函數(shù)基礎(chǔ)上做了一些修改，形成該函數(shù)。

第16頁(yè)練習(xí) ARPAuthorized加強(qiáng)了網(wǎng)絡(luò)安全，阻止了DHCPserver對(duì)非法ARP回應(yīng)進(jìn)行學(xué)習(xí)，而且經(jīng)過(guò)周期ARPping能夠快速探測(cè)到用戶是否下線。 在設(shè)備接口上使能ARPAuthorized，該接口ARP動(dòng)態(tài)學(xué)習(xí)功效被禁止。在某個(gè)接口上禁止arp動(dòng)態(tài)學(xué)習(xí)，不影響其它接口arp學(xué)習(xí)。 在禁止了arp動(dòng)態(tài)學(xué)習(xí)接口上，只能經(jīng)過(guò)手工添加靜態(tài)arp，或者其它一些被允許模塊才能夠添加arp，這種arp被稱為ARPAuthorized，授權(quán)arp不再和其它動(dòng)態(tài)表項(xiàng)一樣老化，而是有自己老化機(jī)制，后面會(huì)說(shuō)明。DHCPserver就是這么一個(gè)模塊。 靜態(tài)arp優(yōu)先級(jí)高于授權(quán)arp，也就是說(shuō)能夠覆蓋授權(quán)arp。1.ARP與arp、ARPAuthorized與授權(quán)arp，使用術(shù)語(yǔ)應(yīng)該統(tǒng)一；2.ARPAuthorized應(yīng)先解釋后引用；3.“DHCPserver就是這么一個(gè)模塊”，是否相關(guān)？第17頁(yè)課程內(nèi)容為何要文檔化文檔寫作基本要求需求設(shè)計(jì)文檔模板需求文檔寫作設(shè)計(jì)文檔寫作第18頁(yè)模板何處獲取需求SRS文檔：REP01T01http://jvpal接口文檔：REP01T03http://jvpal設(shè)計(jì)概要設(shè)計(jì)：DVP05T01http://jvpal詳細(xì)設(shè)計(jì)：DVP05T03http://jvpal軟件設(shè)計(jì)：DVP05T04http://jvpal移植設(shè)計(jì)：DVP05T05http://jvpal需求設(shè)計(jì)合一來(lái)自華為北研所\\h3crnd01-fs\軟件部規(guī)范\小特征開發(fā)規(guī)范\模板\需求設(shè)計(jì)需求設(shè)計(jì)文檔模板19第19頁(yè)課程內(nèi)容為何要文檔化文檔寫作基本要求需求設(shè)計(jì)文檔模板需求文檔寫作設(shè)計(jì)文檔寫作第20頁(yè)什么是好需求什么樣需求是好需求完整性清楚性可行性一致性可驗(yàn)證性第21頁(yè)練習(xí)2.1.1FunctionalRequirements1功效需求1修改設(shè)置smartonpassword命令1. Introduction介紹在設(shè)置smartonpassword同時(shí)，要求密碼顯示形式為明文和密文。2. Inputs輸入

1)密碼顯示形式。2)smartonpassword。3. Process處理

1)統(tǒng)計(jì)密碼顯示形式。

2)當(dāng)密碼顯示形式為simple時(shí)，直接設(shè)置smartonpassword為設(shè)置值；當(dāng)密碼顯示形式為cipher時(shí)，假如設(shè)置值是密文，先將其進(jìn)行解密成明文再設(shè)置，假如是明文則直接設(shè)置。4. output輸出無(wú)5. Inherit繼承性

Update-需要改進(jìn)大家看看下面需求描述怎樣？1.介紹中描述顯示形式有明文和密文兩種，但處理中描述顯示形式卻是simple和cipher，不一致；2.密碼允許輸入哪些字符，長(zhǎng)度有沒(méi)有限制，均沒(méi)有交待。不完整3.輸出沒(méi)有嗎？不完整第22頁(yè)練習(xí)2.1.1配置或者取消配置系統(tǒng)WOL功效1. Introduction介紹在系統(tǒng)視圖下配置或者取消配置WOL使能。2. Inputs輸入系統(tǒng)視圖下:wolenable或undowolenable3. Process處理在系統(tǒng)視圖下配置或者取消WOL使能。去系統(tǒng)WOL使能時(shí)，將WOL模塊MAC-ADDR表清空，釋放所占內(nèi)存。初始化MAC地址表相關(guān)指針。4. output輸出

WOL功效在系統(tǒng)中被使能或被去使能；去系統(tǒng)使能時(shí)，MAC-ADDR表被清空。5. Inherit繼承性

NEW-新增功效在前面沒(méi)有介紹情況下，這里應(yīng)對(duì)縮略語(yǔ)進(jìn)行詳細(xì)解釋，不然不完整第23頁(yè)練習(xí)2.1.1 SRS.FUNC.DHG.001IKE模塊支持DH交換時(shí)使用Group5，Group141. Introduction介紹支持IKEDH組Group5和Group14是由8040波蘭提出新需求，用戶希望能提供更高安全級(jí)別安全密鑰，希望能支持DH3/4/5，不過(guò)DHGroup3/4是由橢圓曲線來(lái)實(shí)現(xiàn)，與Group1/2/5有很大區(qū)分，且需要較大工作量，所以此次特征開發(fā)暫且實(shí)現(xiàn)對(duì)Group5/14支持。完整性：這種術(shù)語(yǔ)也應(yīng)該簡(jiǎn)單介紹，畢竟不是算數(shù)學(xué)題第24頁(yè)練習(xí)2.2.18 R.FUNC.018支持XRN堆疊

……3.Process處理當(dāng)unitdown時(shí)，處理端口刪除消息，把down掉unit端口從鏡像組中刪除，由此可能有對(duì)應(yīng)鏡像組狀態(tài)改變。當(dāng)收到unitup消息時(shí)，本unit向其它unit發(fā)送端口鏡像同時(shí)消息。此消息包含本unit所配置鏡像組信息。2.2.1 PerformanceRequirements性能需求1. PerformanceRequirements1性能需求1

通話語(yǔ)音要求流暢?！翱赡堋薄ⅰ傲鲿场倍际遣磺宄?，不一樣人了解不一樣。不清楚普通也不可驗(yàn)證。25第25頁(yè)SRS綱領(lǐng)簡(jiǎn)介目范圍總體概述軟件概述軟件功能用戶特征假設(shè)和依賴關(guān)系需求建模建模工具具體需求功能需求性能需求外部接口需求總體設(shè)計(jì)約束標(biāo)準(zhǔn)符合性硬件約束技術(shù)限制軟件質(zhì)量屬性可維護(hù)性可靠性……依賴關(guān)系其它需求需求分級(jí)附錄第26頁(yè)介紹總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求目范圍描述文檔目指明文檔讀者軟件命名軟件要做什么，不做什么軟件應(yīng)用要點(diǎn)：“目”是針對(duì)文檔，“范圍”針對(duì)是軟件功能。第27頁(yè)練習(xí)1 Introduction介紹1.1 Purpose目標(biāo)本文用于描述DHCP增強(qiáng)項(xiàng)目中ARP相關(guān)需求需求及設(shè)計(jì)，滿足以下分配需求：

1.在接口上禁止ARP動(dòng)態(tài)學(xué)習(xí)；

2.允許DHCPserver添加授權(quán)ARP；

3.ARPPING；

4.配置授權(quán)ARP老化時(shí)間；

5.假如dhcpserver刪除租約則應(yīng)刪除對(duì)應(yīng)arp；

6.刪除授權(quán)ARP表項(xiàng)后刪除租約；本文適合用于相關(guān)開發(fā)及維護(hù)人員，本文檔描述了COMWAREV300R002產(chǎn)品軟件需求。1.2 Scope范圍本文包含DHCP增強(qiáng)項(xiàng)目中ARP相關(guān)需求需求規(guī)格分析及軟件設(shè)計(jì)說(shuō)明。本文不包含相關(guān)實(shí)當(dāng)代碼、用戶指導(dǎo)及測(cè)試計(jì)劃。應(yīng)在范圍中描述范圍不是用來(lái)描述本文包含什么、不包含什么第28頁(yè)總體概述總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求假設(shè)和依賴關(guān)系總體概述軟件功效用戶特征軟件概述本節(jié)不對(duì)需求作詳細(xì)描述，只是為了使那些需求更易于了解第29頁(yè)總體概述－軟件概述總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求描述軟件與其它產(chǎn)品或項(xiàng)目所組成整體環(huán)境本軟件模塊1外部模塊3系統(tǒng)外部模塊1系統(tǒng)外部模塊2外部模塊4本節(jié)是概要性描述，最好使用圖形描述系統(tǒng)或項(xiàng)目組件、互聯(lián)性及外部接口30第30頁(yè)總體概述－軟件功效總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求提供軟件所實(shí)現(xiàn)功效一個(gè)概要描述能夠從更高層規(guī)格文檔直接引用清楚易懂顯示不一樣功效及其相互關(guān)系不描述詳細(xì)需求功效3功效1功效2。。。第31頁(yè)總體概述－用戶特征總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求描述影響特定需求最終用戶普通特征最終用戶：操作人員、維護(hù)人員、系統(tǒng)管理人員等考慮方面：受教育程度、經(jīng)驗(yàn)、專業(yè)技術(shù)知識(shí)等第32頁(yè)總體概述－假設(shè)和依賴總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求假設(shè)尚不確定但又必須要情況下，所設(shè)定一個(gè)參考結(jié)果，與已知事實(shí)相對(duì)。依賴對(duì)外部條件依賴，二者之間存在明確需求關(guān)系。第33頁(yè)練習(xí)1.本項(xiàng)目基于PPPoFR和MPoFR應(yīng)用，是針對(duì)虛模板上QoS應(yīng)用增強(qiáng)型項(xiàng)目，要求原有PPPoFR模塊、QoS模塊、MP模塊穩(wěn)定可靠。2.本項(xiàng)目依賴ACL模塊穩(wěn)定性，包含ACL規(guī)則維護(hù)、匹配等。3.本項(xiàng)目依賴VRP提供VOS底層平臺(tái)，如內(nèi)存管理、定時(shí)器、消息和隊(duì)列等。4.本性能優(yōu)化項(xiàng)目基于前提是，當(dāng)前系統(tǒng)轉(zhuǎn)發(fā)性能瓶頸在轉(zhuǎn)發(fā)流程，而非硬件限制。下面描述是假設(shè)還是依賴？〔假設(shè)〕〔依賴〕〔依賴〕〔假設(shè)〕第34頁(yè)需求建模需求建模詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求總體概述DFD樣例－在DOS環(huán)境下模擬實(shí)現(xiàn)ATM柜員機(jī)功效需求分析方法更多培訓(xùn)資料參見

\\h3crnd01-fs\軟件部規(guī)范\小特征開發(fā)規(guī)范\培訓(xùn)\需求設(shè)計(jì)35第35頁(yè)詳細(xì)需求功效需求詳細(xì)需求性能需求接口需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求逐條定義詳細(xì)需求包含需求規(guī)格全部細(xì)節(jié)一條需求必須有一個(gè)編號(hào)第36頁(yè)詳細(xì)需求－功效需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求處理功效需求描述每一個(gè)需求輸入怎樣被轉(zhuǎn)換成輸出，描述軟件必須執(zhí)行基本動(dòng)作，同時(shí)給出該規(guī)格優(yōu)先級(jí)。輸入輸出第37頁(yè)詳細(xì)需求－功效需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求功效需求描述介紹處理該功效目標(biāo)、使用方法和技巧，及相關(guān)背景介紹全部輸出數(shù)據(jù)詳細(xì)描述從輸入數(shù)據(jù)和中間參數(shù)取得輸出全部操作全部輸入數(shù)據(jù)詳細(xì)描述輸入輸出第38頁(yè)詳細(xì)需求－功效需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求輸入數(shù)據(jù)描述：輸入起源數(shù)量度量單位時(shí)序允許輸入偏差范圍第39頁(yè)詳細(xì)需求－功效需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求處理操作：輸入數(shù)據(jù)正當(dāng)性檢測(cè)操作次序異常情況響應(yīng)操作影響到參數(shù)用于把系統(tǒng)輸入轉(zhuǎn)換到對(duì)應(yīng)輸出全部方法，諸如方程式，數(shù)學(xué)算法，邏輯操作對(duì)輸出數(shù)據(jù)正當(dāng)性檢測(cè)溢出通信失敗錯(cuò)誤處理40第40頁(yè)詳細(xì)需求－功效需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求輸出數(shù)據(jù)描述輸出到何處（如打印機(jī)、文件等）數(shù)量度量單位時(shí)序允許輸出偏差范圍對(duì)非法值處理錯(cuò)誤消息第41頁(yè)詳細(xì)需求－功效需求功效需求寫作關(guān)鍵點(diǎn)：每個(gè)功效需求分配唯一編號(hào)，且給出一有意義標(biāo)題，便于檢索。標(biāo)題通常是動(dòng)賓詞組，不要使用“功效需求一/二”這么描述。是描述Whattodo，而不是Howtodo；介紹部分描述“做什么”沒(méi)有意義，因?yàn)楹竺鍵PO會(huì)詳細(xì)介紹。應(yīng)描述有利于了解后續(xù)IPO內(nèi)容：

Why，為何會(huì)有此需求

When/Where，什么時(shí)候/什么場(chǎng)所使用

How，怎樣使用對(duì)IPO描述中將使用到特殊術(shù)語(yǔ)解釋與其它功效需求聯(lián)絡(luò)等第42頁(yè)詳細(xì)需求－功效需求功效需求寫作關(guān)鍵點(diǎn)(續(xù))：處理部分能夠采取C語(yǔ)言中關(guān)鍵詞如if、else、while等輔助描述，這么在時(shí)序、邏輯上更清楚；IPO缺一不可

有些情況下，輸入輸出可能不直觀，如：定時(shí)器超時(shí)事件、接口up/down事件等，但并不是沒(méi)有，不然處理什么。若認(rèn)為實(shí)在沒(méi)有，那最可能是功效需求分解不合理，所描述功效根本就不成為需求。不要將命令行作為功效需求描述單純命令行不能提供任何功效，只是用戶界面而已；每一命令行之后都承載著一詳細(xì)功效；命令行形式我們能夠自行定義，但其后功效我們無(wú)法自行定義；用戶真正需要是命令行承載功效。命令行形式，甚至是命令行是否必要，這些用戶并不會(huì)關(guān)心。第43頁(yè)練習(xí)2.1.1.取撥號(hào)口屬性函數(shù)1.Introduction介紹取以下配置：鏈路空閑掛斷時(shí)間：dialertimeridle；呼叫間隔時(shí)間：dialertimerenable；鏈路建立等候時(shí)間：dialertimerwait-carrier；競(jìng)爭(zhēng)等候時(shí)間：dialertimercompete；緩沖區(qū)報(bào)文數(shù)：dialerqueue-length2.Inputs輸入

NULL。3.Process處理遍歷全部全局DDR控制塊鏈表是Dialer接口和物理接口取DDRifnet

取全部撥號(hào)口屬性返回鏈表頭指針4.Output輸出撥號(hào)口屬性鏈表頭指針。1.在描述實(shí)現(xiàn)，按照這么IPO描述無(wú)法對(duì)其進(jìn)行驗(yàn)證；2.更應(yīng)該作為一個(gè)接口需求，而不是功效需求；第44頁(yè)詳細(xì)需求－性能需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求描述軟件或人機(jī)交互靜態(tài)和動(dòng)態(tài)量化需求。靜態(tài)量化需求支持終端數(shù)目支持并發(fā)用戶數(shù)目需處理文件和統(tǒng)計(jì)數(shù)目表和文件大小動(dòng)態(tài)量化需求可包含正常和滿負(fù)荷業(yè)務(wù)量條件下，某時(shí)間段（如一小時(shí)）內(nèi)處理事務(wù)和任務(wù)數(shù)目以及數(shù)據(jù)量。45第45頁(yè)詳細(xì)需求－性能需求舉例：性能需求寫作關(guān)鍵點(diǎn)：每條性能需求必須以可測(cè)量術(shù)語(yǔ)進(jìn)行描述，即應(yīng)給出明確量化指標(biāo)，包含度量單位；對(duì)于動(dòng)態(tài)性能指標(biāo)，除性能指標(biāo)外，還應(yīng)包含必要前置條件；前置條件交易能很快完成，操作員無(wú)須等候。95%事務(wù)應(yīng)在1秒內(nèi)被處理。電梯由靜止?fàn)顟B(tài)進(jìn)入正常勻速(2m/s)狀態(tài)時(shí)間限定在2~2.5s秒內(nèi)。第46頁(yè)詳細(xì)需求－接口需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求接口需求硬件接口軟件接口用戶接口通信接口軟件人機(jī)交互特征與系統(tǒng)硬件之間接口與其它軟件產(chǎn)品或應(yīng)用系統(tǒng)之間接口消息、回調(diào)函數(shù)等系統(tǒng)內(nèi)部通信接口第47頁(yè)詳細(xì)需求－接口需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求用戶接口示例：系統(tǒng)用戶經(jīng)過(guò)一個(gè)顯示終端進(jìn)行操作，需要描述：要求屏幕格式頁(yè)面布局以及匯報(bào)或菜單內(nèi)容輸入和輸出相關(guān)時(shí)序是否支持可編輯功效鍵第48頁(yè)詳細(xì)需求－接口需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求軟件接口描述怎樣使用其它軟件，針對(duì)每個(gè)所需軟件描述：名字助記符版本號(hào)起源描述與其它軟件接口，針對(duì)每個(gè)接口描述：接口目標(biāo)經(jīng)過(guò)消息和格式定義接口第49頁(yè)詳細(xì)需求－接口需求接口需求寫作關(guān)鍵點(diǎn)：用戶接口若是命令行，寫作需遵照操作手冊(cè)格式進(jìn)行；軟件接口小節(jié)，應(yīng)只描述本軟件/系統(tǒng)對(duì)外提供軟件接口，不包含外部提供給本軟件/系統(tǒng)接口，后者應(yīng)在依賴中給予描述；軟件接口若為函數(shù)，寫作能夠按照代碼中函數(shù)頭格式進(jìn)行，這么在后續(xù)階段能很方便地重用。如：1.R.INTF.SOFT.001認(rèn)證接口/********************************************************************************函數(shù)名稱:ATMLoginInProc*功效描述:讀取輸入用戶賬號(hào)名及密碼，保留到當(dāng)前用戶信息全局變量中，*并到賬務(wù)處理系統(tǒng)進(jìn)行認(rèn)證。*輸入:無(wú)*輸出:無(wú)*返回值:VOS_OK：表示登錄成功；VOS_ERR：表示登錄失敗。*調(diào)用關(guān)系:略*其它:無(wú)*******************************************************************************/50第50頁(yè)總體設(shè)計(jì)約束描述由標(biāo)準(zhǔn)、硬件、技術(shù)限制等造成對(duì)設(shè)計(jì)限制標(biāo)準(zhǔn)順從：描述來(lái)自現(xiàn)有標(biāo)準(zhǔn)和規(guī)則需求匯報(bào)格式數(shù)據(jù)命名協(xié)議硬件約束：描述支持軟件運(yùn)行硬件條件，如內(nèi)存限制技術(shù)限制：描述對(duì)使用特定技術(shù)限制，如數(shù)據(jù)庫(kù)、并行操作等總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求第51頁(yè)軟件質(zhì)量屬性可維護(hù)性可靠性安全性可移植性易用性......總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求第52頁(yè)軟件質(zhì)量屬性總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求可維護(hù)性描述支持軟件可維護(hù)詳細(xì)需求比如：跟蹤調(diào)試功效告警提醒功效對(duì)軟件模塊之間耦合度進(jìn)行考慮第53頁(yè)軟件質(zhì)量屬性總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求可靠性容錯(cuò)性在出現(xiàn)軟件故障時(shí)候依然能夠維持某種層次性能能力。可恢復(fù)性在出現(xiàn)故障時(shí)恢復(fù)能力和重新建立某種層次性能能力。比如：主備板熱備份通信鏈路中止重連第54頁(yè)軟件質(zhì)量屬性總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求安全性在此描述預(yù)防軟件遭到意外或惡意侵入、使用、修改、破壞或泄密原因。比如：使用特定加密技術(shù)保留詳細(xì)日志或歷史數(shù)據(jù)對(duì)不一樣模塊分配特定功效限制程序一些區(qū)域間進(jìn)行通信對(duì)主要數(shù)據(jù)計(jì)算校驗(yàn)和55第55頁(yè)軟件質(zhì)量屬性總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求可移植性描述把軟件從一個(gè)環(huán)境轉(zhuǎn)換到另一個(gè)環(huán)境時(shí)，所需要用戶程序、用戶接口兼容性限制等需求。第56頁(yè)軟件質(zhì)量屬性總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求易用性易懂性：用戶通曉邏輯概念花費(fèi)人力和軟件適用性易學(xué)性：用戶學(xué)習(xí)應(yīng)用程序花費(fèi)人力易操作性：用戶操作應(yīng)用程序所花費(fèi)人力第57頁(yè)依賴關(guān)系依賴關(guān)系解釋每一條需求內(nèi)部和外部依賴關(guān)系說(shuō)明：依賴關(guān)系也能夠在前面詳細(xì)介紹每一條需求時(shí)進(jìn)行描述總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求第58頁(yè)其它需求總體概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求數(shù)據(jù)庫(kù)操作當(dāng)?shù)鼗枨笃渌枨蟮?9頁(yè)附錄附錄I/O格式示例，成本分析研究描述，用戶調(diào)查結(jié)果有利于用戶閱讀SRS支持或背景信息軟件將處理問(wèn)題描述被支持組織歷史，背景，經(jīng)驗(yàn)和操作特征軟件需求與項(xiàng)目里程碑交叉參考表，指明哪些軟件需求將在哪些里程碑階段里完成為了符合安全、出口、安裝或其它需求，對(duì)代碼和介質(zhì)特殊包裝要求說(shuō)明：附錄不是必須要求內(nèi)容SRS中包含附錄時(shí)，應(yīng)明確申明附錄是否是需求一部分?？傮w概述詳細(xì)需求設(shè)計(jì)約束質(zhì)量屬性介紹附錄依賴關(guān)系其它需求60第60頁(yè)需求文檔寫作關(guān)鍵點(diǎn)僅關(guān)注“Whattodo”，即系統(tǒng)需提供什么功效。不要描述“Howtodo”，那是設(shè)計(jì)關(guān)注事情。1.功效需求部分不要出現(xiàn)“××函數(shù)”、“××數(shù)據(jù)結(jié)構(gòu)”、“××指針”、buildrun之類表述；2.站在客戶立場(chǎng)上來(lái)寫需求，而不是站在開發(fā)人員立場(chǎng)上。第61頁(yè)需求文檔寫作關(guān)鍵點(diǎn)功效需求劃分應(yīng)合理3.1FunctionalRequirements功效需求3.1.1配置要求經(jīng)過(guò)PPP協(xié)商從對(duì)端得到協(xié)商DNS地址1.Introduction介紹在接口視圖下經(jīng)過(guò)以下命令來(lái)配置要求經(jīng)過(guò)PPP主動(dòng)協(xié)商從對(duì)端得到DNS地址：pppipcpdnsrequest2.Inputs輸入用戶在某一封裝了PPP協(xié)議接口視圖下，輸入：pppipcpdnsrequest3.Process處理路由器解析此命令輸入正確后，將修改PPP協(xié)議中協(xié)商參數(shù)，使路由器在進(jìn)行PPP協(xié)商時(shí)候會(huì)要求對(duì)端分配協(xié)商DNS地址。4.Output輸出操作成功后，能夠經(jīng)過(guò)在當(dāng)前視圖下輸入displaythis命令來(lái)查看配置是否成功。不然顯示犯錯(cuò)提醒。3.1.2配置取消要求經(jīng)過(guò)PPP協(xié)商從對(duì)端得到協(xié)商DNS地址1.Introduction介紹在接口視圖下經(jīng)過(guò)以下命令來(lái)配置取消要求經(jīng)過(guò)PPP主動(dòng)協(xié)商從對(duì)端得到DNS地址：undopppipcpdnsrequest下一頁(yè)第62頁(yè)需求文檔寫作關(guān)鍵點(diǎn)2.Inputs輸入用戶在某一封裝了PPP協(xié)議接口視圖下，輸入：undopppipcpdnsrequest3.Process處理路由器解析此命令輸入正確后，將修改PPP協(xié)議中協(xié)商參數(shù)，使路由器在進(jìn)行PPP協(xié)商時(shí)候不會(huì)要求對(duì)端分配協(xié)商DNS地址。4.Output輸出操作成功后，能夠經(jīng)過(guò)在當(dāng)前視圖下輸入displaythis命令來(lái)查看先前配置是否被取消。不然顯示犯錯(cuò)提醒。3.1.3配置保留協(xié)商得到DNS地址，并可經(jīng)過(guò)命令displayinterface查看1.Introduction介紹保留從對(duì)端協(xié)商得到DNS地址，并可經(jīng)過(guò)查看接口信息displayinterface命令將得到DNS地址顯示出來(lái)。2.Inputs輸入取出協(xié)商得到DNS地址3.Process處理路由器保留協(xié)商得到DNS地址，并將其添加到接口信息中4.Output輸出操作成功后，協(xié)商得到DNS地址保留GotOptions里，并被添加到接口信息中，不然顯示犯錯(cuò)提醒，不會(huì)顯示在接口信息中。分析：前兩個(gè)功效點(diǎn)是在描述一條命令行，而后一功效點(diǎn)描述是另一條相關(guān)命令行。用戶需求是什么？是這兩條命令行嗎？命令行只是我們提供用戶界面，隱藏其后功效需求是什么？“支持經(jīng)過(guò)PPP協(xié)商獲取DNS地址”，就這一條。拆成三條，需求分解不合理，怎樣修正？一條功效需求（支持經(jīng)過(guò)PPP協(xié)商獲取DNS地址）

display命令修改能夠在功效需求輸出中提及。

一條接口需求（[undo]pppipcpdnsrequest

）第63頁(yè)需求文檔寫作關(guān)鍵點(diǎn)唐僧：唉唉唉！大家不要生氣，生氣會(huì)犯了嗔戒！悟空你也太調(diào)皮了，我跟你說(shuō)過(guò)，叫你不要亂扔?xùn)|西。亂扔?xùn)|西這么多……你看我還沒(méi)說(shuō)完呢，你把棍子又給扔掉了！月光寶盒是寶物，你把它扔掉會(huì)污染環(huán)境。唉，要是砸到兒童呢，怎么辦？就算沒(méi)有砸到兒童，砸到那些花花草草也是不正確呀！保持語(yǔ)句和段落簡(jiǎn)短。第64頁(yè)需求文檔寫作關(guān)鍵點(diǎn)需求陳說(shuō)應(yīng)該含有一致樣式。比如“系統(tǒng)必須……”或者“用戶必須……”，并緊跟一個(gè)行為動(dòng)作和可觀察結(jié)果。舉例：計(jì)算過(guò)程中出現(xiàn)除零錯(cuò)誤時(shí)，系統(tǒng)必須馬上彈出對(duì)話框顯示該錯(cuò)誤，并進(jìn)行聲音提醒。舉例：計(jì)算過(guò)程中出現(xiàn)除零錯(cuò)誤時(shí)，系統(tǒng)必須給出提醒信息。65第65頁(yè)需求文檔寫作關(guān)鍵點(diǎn)必須防止含糊、主觀術(shù)語(yǔ)，降低不確定性。 比如：可能、大約、可能、界面友好、輕易、簡(jiǎn)單、美觀、快速、有效、支持、許多、最新技術(shù)、優(yōu)越、可接收和健壯。........................美女.....................

!第66頁(yè)需求文檔寫作關(guān)鍵點(diǎn)防止使用比較性詞匯，比如：提升、最大化、最小化和最正確化。定量地說(shuō)明所需要提升程度或者說(shuō)清一些參數(shù)可接收最大值和最小值。提升文件柜高度?；镉?jì)2伙計(jì)3伙計(jì)1伙計(jì)1第67頁(yè)需求文檔寫作關(guān)鍵點(diǎn)不應(yīng)該把多個(gè)需求集中在一個(gè)冗長(zhǎng)敘述段落中。務(wù)必記?。翰灰谛枨笳f(shuō)明中使用“和/或”，“等等”之類連詞。C&C08交換機(jī)應(yīng)該提供呼叫等候和三方通話等新業(yè)務(wù)。C&C08交換機(jī)應(yīng)該提供呼叫等候功效。C&C08交換機(jī)應(yīng)該提供三方通話功效。C&C08交換機(jī)應(yīng)該提供呼叫轉(zhuǎn)移功效。C&C08交換機(jī)應(yīng)該提供鬧鐘服務(wù)功效。

這個(gè)“等”包含哪些內(nèi)容？怎么測(cè)試？測(cè)試人員第68頁(yè)需求范例69第69頁(yè)課程內(nèi)容為何要文檔化文檔寫作基本要求需求設(shè)計(jì)文檔模板需求文檔寫作設(shè)計(jì)文檔寫作第70頁(yè)設(shè)計(jì)文檔綱領(lǐng)(開發(fā)項(xiàng)目)零層設(shè)計(jì)一層設(shè)計(jì)二層設(shè)計(jì)配置和控制介紹模塊1詳設(shè)數(shù)據(jù)庫(kù)模塊n詳設(shè)……HLDLLD上下文定義設(shè)計(jì)思緒分解描述依賴性描述接口描述……分解描述依賴性描述接口描述……數(shù)據(jù)描述函數(shù)描述開發(fā)項(xiàng)目：系統(tǒng)總體設(shè)計(jì)子系統(tǒng)設(shè)計(jì)系統(tǒng)對(duì)外關(guān)系第71頁(yè)HLD分解層次普通不超出3層（0層、1層、2層），每層模塊數(shù)以2到4個(gè)為宜，最多不要超出7個(gè)。單元模塊函數(shù)總數(shù)也不超出7個(gè)；HLD階段將全部函數(shù)全部分解出來(lái)，LLD階段不再關(guān)注模塊分解；HLD使用結(jié)構(gòu)圖描述函數(shù)調(diào)用關(guān)系；函數(shù)分解規(guī)模以30~50行(非空非注釋)為宜，最大不超出200行。每個(gè)函數(shù)復(fù)雜度控制在10以內(nèi)，即：一個(gè)函數(shù)中不能有太多if，else，for,switch…case等邏輯；LLD階段寫偽碼，推薦在sourceinsight中寫，完成后嵌入LLD中。偽碼粗細(xì)程度以適宜作注釋為標(biāo)準(zhǔn)；設(shè)計(jì)文檔寫作關(guān)鍵點(diǎn)第72頁(yè)結(jié)構(gòu)圖(structurechart)描述了一個(gè)系統(tǒng)模塊劃分，表達(dá)了模塊之間層次、組織和通信關(guān)系示例：結(jié)構(gòu)圖第73頁(yè)偽碼又叫PDL(ProgramDesignLanguage)，是一個(gè)混合語(yǔ)言，用自然語(yǔ)言（如英語(yǔ)、漢語(yǔ)等）描述程序處理邏輯，用一定關(guān)鍵字語(yǔ)法（如if、else等）定義控制結(jié)構(gòu)和數(shù)據(jù)結(jié)構(gòu)。優(yōu)點(diǎn)：維護(hù)方便輕易評(píng)審作為代碼注釋缺點(diǎn)：不輕易掌握粗細(xì)輕易寫成代碼偽碼偽碼=關(guān)鍵字語(yǔ)法+自然語(yǔ)言描述第74頁(yè)偽碼使用C語(yǔ)言語(yǔ)法書寫偽代碼，使用標(biāo)準(zhǔn)符號(hào)，如：if,else,{},while等；用描述性語(yǔ)言來(lái)描述；if（接口是以太網(wǎng)接口）if（InterfaceType==ETHERNET)詳略得當(dāng)。用概括性語(yǔ)句來(lái)描述詳細(xì)處理，要求在每個(gè)邏輯處理分支用簡(jiǎn)練、概括性語(yǔ)言描述處理，而不要局限于處理細(xì)節(jié)。

封裝IP報(bào)文頭內(nèi)容;用收到報(bào)文源地址來(lái)設(shè)置發(fā)送報(bào)文目標(biāo)地址;用發(fā)送報(bào)文接口地址來(lái)設(shè)置發(fā)送報(bào)文源地址;偽碼寫作說(shuō)明：75第75頁(yè)設(shè)計(jì)樣例第76頁(yè)設(shè)計(jì)文檔綱領(lǐng)(增強(qiáng)、移植項(xiàng)目)移植或增強(qiáng)項(xiàng)目：修改分類1修改原因影響分析修改描述修改點(diǎn)1修改點(diǎn)n…………修改分類N第77頁(yè)增強(qiáng)、移植設(shè)計(jì)修改分類：對(duì)全部需要修改點(diǎn)進(jìn)行分類，一個(gè)修改分類包含一個(gè)或多個(gè)修改點(diǎn)，實(shí)現(xiàn)一相對(duì)獨(dú)立功效；每個(gè)修改分類都應(yīng)使用有明確含義標(biāo)題，如：“關(guān)于XXX修改”。修改分類一關(guān)于將MQC策略應(yīng)用到ATMPVC接口下修改修改點(diǎn)：一個(gè)修改點(diǎn)描述一處修改，如一個(gè)數(shù)據(jù)結(jié)構(gòu)修改，一個(gè)宏定義修改，一個(gè)函數(shù)修改等；修改點(diǎn)也應(yīng)使用有意義標(biāo)題，不要使用“修改點(diǎn)1”等。第78頁(yè)增強(qiáng)、移植設(shè)計(jì)修改原因：針對(duì)每個(gè)修改點(diǎn)，詳細(xì)闡述為何需要修改，如因?yàn)槟衬程幚砹鞒谈淖?，功效擴(kuò)展，界面改變，性能優(yōu)化等；不應(yīng)該描述修改什么，這是修改描述部分應(yīng)詳細(xì)介紹內(nèi)容；修改原因中描述應(yīng)有利于對(duì)