華為需求設(shè)計需求分析寫作培訓(xùn)

需求設(shè)計寫作培訓(xùn)質(zhì)量管理部小組2005.06第一頁，共九十一頁。課程范圍僅關(guān)注如何寫作文檔不涉及具體的需求分析和設(shè)計方法第二頁，共九十一頁。課程內(nèi)容為什么要文檔化文檔寫作基本要求需求設(shè)計文檔模板需求文檔寫作設(shè)計文檔寫作第三頁，共九十一頁。為什么要文檔化開發(fā)人員通過文檔化的過程查錯補(bǔ)遺；便于評審，在早期發(fā)現(xiàn)技術(shù)上的問題；后續(xù)階段開發(fā)任務(wù)可能由他人承擔(dān)，輸出文檔便于他們開展工作；維護(hù)人員開展維護(hù)工作需要；文檔是必要的交付件；…………可讀性就尤為關(guān)鍵第四頁，共九十一頁。為什么要文檔化“所有的過程分析都要形成文檔。我們現(xiàn)在有一個嚴(yán)重的問題是，大家好像不喜歡寫文檔，對于需要的實(shí)現(xiàn)方案，通常都是一個負(fù)責(zé)人在腦袋里想想該怎么實(shí)現(xiàn)，然后郵件或電話找?guī)讉€相關(guān)人員討論一下就算可以了，可能連個會議材料或會議紀(jì)要都沒有。而老外可不是這樣的，他們非常非常重視文檔，他們認(rèn)為一個人在腦袋里想的東西是不清晰也不全面的，有時候心里想的認(rèn)為很正確的方案實(shí)際上可能存在致命缺陷。他們要求必須把心里的想法形成文檔才能有效的避免這種問題。寫文檔的過程中，可以更加有效的、更進(jìn)一步去整理您原來心里的思路，很多問題在您寫過文檔的過程中您就能發(fā)現(xiàn)；另外，文檔寫作多使用圖表，浪費(fèi)口水的文字盡量少用，和我們一起工作的系統(tǒng)工程師在系統(tǒng)架構(gòu)分析中就畫了五六十張圖，就算看不懂他寫的英文，從圖中我們就能夠很清晰的指導(dǎo)整個產(chǎn)品的系統(tǒng)架構(gòu)。” ——摘自一位華為員工的瑞典出差報告5第五頁，共九十一頁。課程內(nèi)容為什么要文檔化文檔寫作基本要求需求設(shè)計文檔模板需求文檔寫作設(shè)計文檔寫作第六頁，共九十一頁。文檔寫作基本要求下面的文檔出自于我們開發(fā)人員的手筆，大家覺得如何？第七頁，共九十一頁。文檔寫作基本要求應(yīng)使用標(biāo)準(zhǔn)模板寫作；文檔封頁、頁眉頁腳、修訂記錄、附錄、參考文獻(xiàn)應(yīng)完善；關(guān)鍵詞、摘要、縮略語應(yīng)完整；目錄要及時更新；通篇文檔標(biāo)題、文字格式、間距應(yīng)協(xié)調(diào)美觀；所有文檔模板中的章節(jié)，只可增加，不可刪除；編寫建議是用來指導(dǎo)文檔寫作的，在利用完后要及時刪除；圖號置于圖形之下，表號置于表格之上；第八頁，共九十一頁。文檔寫作基本要求應(yīng)追求圖文并茂的效果；句子和段落要短；使用語言應(yīng)嚴(yán)謹(jǐn)，不要使用白話；采用主動語氣；不要出現(xiàn)“我們”、“你們”、“他們”這樣的稱謂，或“這個”、“那個”這樣的詞，應(yīng)使用“本××”、“該××”、“其”；表述清晰，避免引起歧義；通篇文檔細(xì)節(jié)上要保持一致；第九頁，共九十一頁。練習(xí) 房子南北走向，房子大門在東側(cè)中間位置。門廳長約3米，寬2米，門廳左面是主臥室，右面是廚房。廚房3米寬，4米長，廚房門對著門廳，廚房的頂頭還有一個北陽臺，與廚房同寬，長1米。主臥室寬3米，長5米左右，房間門對著客廳?？蛷d與餐廳連為一體，共7米長，4米寬，與客廳相連有一南陽臺，與客廳同寬，長1.5米。餐廳的北面是衛(wèi)生間，衛(wèi)生間與廚房相對，中間由1米寬，3米長的過道隔開；衛(wèi)生間門對著過道，南墻與廚房的南墻在一條直線上；衛(wèi)生間為長方形，南墻長3米，另一邊長2米。衛(wèi)生間的北面是次臥，同寬，門朝著過道，次臥長4米。過道的北端是書房門，書房南北長4米，書房有一個一米見方的門廳，書房的西墻長4米，包括1米長的門廳長度，西墻把書房和次臥分隔開。門廳東墻北端90角折向東，長2米，把書房和廚房北陽臺分隔開。大家認(rèn)為下面的描述如何？究竟長多少？?

是左？還是右？大段的敘述，不利于理解！10第十頁，共九十一頁。練習(xí)1.房子南北走向，房子大門在東側(cè)中間位置。2.門廳長3米，寬2米，門廳左面是主臥室，右面是廚房。3.廚房3米寬，4米長，廚房門對著門廳，廚房的頂頭還有一個北陽臺，與廚房同寬，長1米。4.主臥室寬3米，長5米左右，房間門對著客廳。5.客廳與餐廳連為一體，共7米長，4米寬，與客廳相連有一南陽臺，與客廳同寬，長1.5米。6.餐廳的北面是衛(wèi)生間，衛(wèi)生間與廚房相對，中間由1米寬，3米長的過道隔開；衛(wèi)生間門對著過道，南墻與廚房的南墻在一條直線上；衛(wèi)生間為長方形，南墻長3米，另一邊長2米。7.衛(wèi)生間的北面是次臥，同寬，門朝著過道，次臥長4米。8.過道的北端是書房門，書房南北長4米，書房有一個一米見方的門廳，書房的西墻長4米，包括1米長的門廳長度，西墻把書房和次臥分隔開。門廳東墻北端90角折向東，長2米，把書房和廚房北陽臺分隔開。修改成如下描述之后呢？第十一頁，共九十一頁。練習(xí)主臥室次臥室廚房餐廳客廳陽臺陽臺衛(wèi)生間書房門廳過道北西再改成如下圖形描述呢？第十二頁，共九十一頁。練習(xí) 與配合實(shí)現(xiàn)認(rèn)證計費(fèi)的方案中，客戶（禁止多人同時使用的業(yè)務(wù)帳號）登陸通過認(rèn)證開始計費(fèi)后，如果出現(xiàn)重起的情況，處理方法分為兩種： 1.有時間芯片的（可以記錄時間的），設(shè)備重起后會使用設(shè)備時間戳的特性判斷出設(shè)備重起了，這時會將上的在線用戶刪除并按照最后一次計費(fèi)更新報文來終結(jié)計費(fèi)。用戶可再次正常登陸。 2.……下面的描述呢？白話修改成如下的描述呢？ ………… 1.使用時間芯片的LSW（支持記錄時間功能），利用設(shè)備時間戳特性可以檢測出設(shè)備是否重啟，設(shè)備重啟時將CAMS上的在線用戶刪除，并依據(jù)最后一次計費(fèi)更新報文終結(jié)計費(fèi)。用戶可再次正常登陸。第十三頁，共九十一頁。練習(xí)由于一臺設(shè)備可以設(shè)置多個服務(wù)器，也就是。用戶可以通過命令行來配置該服務(wù)器是否啟動設(shè)備重啟防吊死功能。由于一臺設(shè)備可以設(shè)置多個服務(wù)器，即。用戶可以通過命令行來配置該服務(wù)器是否啟動設(shè)備重啟防吊死功能。第十四頁，共九十一頁。練習(xí)收到該報文后會立即回應(yīng)一個5的計費(fèi)回應(yīng)報文，然后根據(jù)報文攜帶的和找到通過該設(shè)備認(rèn)證的用戶，并將他們的在線信息刪除。收到該報文后會立即回應(yīng)一個5的計費(fèi)回應(yīng)報文，然后根據(jù)報文攜帶的和找到通過該設(shè)備認(rèn)證的用戶，并將其在線信息刪除。15第十五頁，共九十一頁。練習(xí)修改原因：這個函數(shù)是將要發(fā)送的轉(zhuǎn)化為，系統(tǒng)原有函數(shù)是針對認(rèn)證用戶設(shè)計的，由于本特性為設(shè)備啟動后執(zhí)行，沒有用戶信息，所以在函數(shù)基礎(chǔ)上做了一些修改，形成該函數(shù)。修改原因：該函數(shù)實(shí)現(xiàn)將待發(fā)送的轉(zhuǎn)化為的功能，系統(tǒng)原有函數(shù)針對認(rèn)證用戶設(shè)計，由于本特性為設(shè)備啟動后執(zhí)行，沒有用戶信息，所以在函數(shù)基礎(chǔ)上做了一些修改，形成該函數(shù)。第十六頁，共九十一頁。練習(xí) 加強(qiáng)了網(wǎng)絡(luò)安全，阻止了對非法回應(yīng)進(jìn)行學(xué)習(xí)，并且通過周期的可以快速的探測到用戶是否下線。 在設(shè)備的接口上使能，該接口的動態(tài)學(xué)習(xí)功能被禁止。在某個接口上禁止動態(tài)學(xué)習(xí)，不影響其他接口的學(xué)習(xí)。 在禁止了動態(tài)學(xué)習(xí)的接口上，只能通過手工添加靜態(tài)，或者其他一些被允許的模塊才可以添加，這種被稱為，授權(quán)不再和其他的動態(tài)表項(xiàng)一樣老化，而是有自己的老化機(jī)制，后面會說明。就是這樣的一個模塊。 靜態(tài)的優(yōu)先級高于授權(quán)，也就是說可以覆蓋授權(quán)。1.與、與授權(quán)，使用術(shù)語應(yīng)該統(tǒng)一；2.應(yīng)先解釋后引用；3.“就是這樣的一個模塊”，是否相關(guān)？第十七頁，共九十一頁。課程內(nèi)容為什么要文檔化文檔寫作基本要求需求設(shè)計文檔模板需求文檔寫作設(shè)計文檔寫作第十八頁，共九十一頁。模板何處獲取需求文檔：01T01接口文檔：01T03設(shè)計概要設(shè)計：05T01詳細(xì)設(shè)計：05T03軟件設(shè)計：05T04移植設(shè)計：05T05需求設(shè)計合一來自華為北研所\\h301\軟件部規(guī)范\小特性開發(fā)規(guī)范\模板\需求設(shè)計需求設(shè)計文檔模板19第十九頁，共九十一頁。課程內(nèi)容為什么要文檔化文檔寫作基本要求需求設(shè)計文檔模板需求文檔寫作設(shè)計文檔寫作第二十頁，共九十一頁。什么是好的需求什么樣的需求是好的需求完整性清晰性可行性一致性可驗(yàn)證性第二十一頁，共九十一頁。練習(xí)2.1.11功能需求1修改設(shè)置命令1. 介紹在設(shè)置的同時，規(guī)定密碼顯示形式為明文和密文。2. 輸入1)密碼顯示形式。2)。3. 處理1)記錄密碼顯示形式。2)當(dāng)密碼顯示形式為時，直接設(shè)置為設(shè)置值；當(dāng)密碼顯示形式為時，如果設(shè)置值是密文，先將其進(jìn)行解密成明文再設(shè)置，如果是明文則直接設(shè)置。4. 輸出無5. 繼承性需要改進(jìn)大家看看下面的需求描述如何？1.介紹中描述的顯示形式有明文和密文兩種，但處理中描述的顯示形式卻是和，不一致；2.密碼允許輸入哪些字符，長度有無限制，均沒有交待。不完整3.輸出沒有嗎？不完整第二十二頁，共九十一頁。練習(xí)2.1.1配置或者取消配置系統(tǒng)功能1. 介紹在系統(tǒng)視圖下配置或者取消配置使能。2. 輸入系統(tǒng)視圖下:或3. 處理在系統(tǒng)視圖下配置或者取消使能。去系統(tǒng)使能時，將模塊的表清空，釋放所占內(nèi)存。初始化地址表相關(guān)指針。4. 輸出功能在系統(tǒng)中被使能或被去使能；去系統(tǒng)使能時，表被清空。5. 繼承性新增功能在前面沒有介紹的情況下，這里應(yīng)對縮略語進(jìn)行詳細(xì)解釋，否則不完整第二十三頁，共九十一頁。練習(xí)2.1.1 .001模塊支持交換時使用5，141. 介紹支持組的5和14是由8040波蘭提出的新需求，用戶希望能提供更高安全級別的安全密鑰，希望能支持3/4/5，但是3/4是由橢圓曲線來實(shí)現(xiàn)的，與1/2/5有很大的區(qū)別，且需要較大的工作量，因此本次特性開發(fā)暫且實(shí)現(xiàn)對5/14的支持。完整性：這種術(shù)語也應(yīng)該簡單介紹，畢竟不是算數(shù)學(xué)題第二十四頁，共九十一頁。練習(xí)2.2.18 .018支持堆疊……3處理當(dāng)時，處理端口刪除消息，把掉的端口從鏡像組中刪除，由此可能有相應(yīng)的鏡像組狀態(tài)的改變。當(dāng)收到消息時，本向其它發(fā)送端口鏡像同步消息。此消息包含本所配置的鏡像組信息。2.2.1 性能需求1. 1性能需求1 通話語音要求流暢?！翱赡堋?、“流暢”都是不清晰的，不同人理解不一樣。不清晰一般也不可驗(yàn)證。25第二十五頁，共九十一頁。大綱簡介目的范圍總體概述軟件概述軟件功能用戶特征假設(shè)和依賴關(guān)系需求建模建模工具具體需求功能需求性能需求外部接口需求總體設(shè)計約束標(biāo)準(zhǔn)符合性硬件約束技術(shù)限制軟件質(zhì)量屬性可維護(hù)性可靠性……依賴關(guān)系其他需求需求分級附錄第二十六頁，共九十一頁。簡介總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求目的范圍描述文檔目的指明文檔讀者軟件命名軟件要做什么，不做什么軟件的應(yīng)用要點(diǎn)：“目的”是針對文檔，“范圍”針對的是軟件功能。第二十七頁，共九十一頁。練習(xí)1 簡介1.1 目的本文用于描述增強(qiáng)項(xiàng)目中相關(guān)需求的需求及設(shè)計，滿足以下分配需求：1.在接口上禁止動態(tài)學(xué)習(xí)；2.允許添加授權(quán)；3；4.配置授權(quán)老化時間；5.如果刪除租約則應(yīng)刪除相應(yīng)的；6.刪除授權(quán)表項(xiàng)后刪除租約；本文適用于相關(guān)開發(fā)及維護(hù)人員，本文檔描述了300R002產(chǎn)品的軟件需求。1.2 范圍本文包括增強(qiáng)項(xiàng)目中相關(guān)需求的需求規(guī)格分析及軟件設(shè)計說明。本文不包括相關(guān)實(shí)現(xiàn)代碼、用戶指導(dǎo)及測試計劃。應(yīng)在范圍中描述范圍不是用來描述本文包括什么、不包括什么第二十八頁，共九十一頁。總體概述總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求假設(shè)和依賴關(guān)系總體概述軟件功能用戶特征軟件概述本節(jié)不對需求作具體描述，只是為了使那些需求更易于理解第二十九頁，共九十一頁。總體概述－軟件概述總體概述具體需求設(shè)計約束質(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第三十頁，共九十一頁。總體概述－軟件功能總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求提供軟件所實(shí)現(xiàn)功能的一個概要描述可以從更高層規(guī)格文檔直接引用清楚易懂顯示不同功能及其相互關(guān)系不描述具體需求功能3功能1功能2。。。第三十一頁，共九十一頁。總體概述－用戶特征總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求描述影響特定需求的最終用戶的一般特征最終用戶：操作人員、維護(hù)人員、系統(tǒng)管理人員等考慮方面：受教育程度、經(jīng)驗(yàn)、專業(yè)技術(shù)知識等第三十二頁，共九十一頁。總體概述－假設(shè)和依賴總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求假設(shè)尚不確定但又必須要的情況下，所設(shè)定的一個參考結(jié)果，與已知事實(shí)相對。依賴對外部條件的依賴，兩者之間存在明確的需求關(guān)系。第三十三頁，共九十一頁。練習(xí)1.本項(xiàng)目基于和應(yīng)用，是針對虛模板上的應(yīng)用的增強(qiáng)型項(xiàng)目，要求原有的模塊、模塊、模塊穩(wěn)定可靠。2.本項(xiàng)目依賴模塊的穩(wěn)定性，包括規(guī)則的維護(hù)、匹配等。3.本項(xiàng)目依賴提供的底層平臺，如內(nèi)存管理、定時器、消息和隊(duì)列等。4.本性能優(yōu)化項(xiàng)目基于的前提是，目前系統(tǒng)轉(zhuǎn)發(fā)性能的瓶頸在轉(zhuǎn)發(fā)流程，而非硬件限制。下面的描述是假設(shè)還是依賴？〔假設(shè)〕〔依賴〕〔依賴〕〔假設(shè)〕第三十四頁，共九十一頁。需求建模需求建模具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求總體概述樣例－在環(huán)境下模擬實(shí)現(xiàn)柜員機(jī)的功能需求分析方法更多的培訓(xùn)資料參見\\h301\軟件部規(guī)范\小特性開發(fā)規(guī)范\培訓(xùn)\需求設(shè)計35第三十五頁，共九十一頁。具體需求功能需求具體需求性能需求接口需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求逐條定義具體需求包含需求規(guī)格的所有細(xì)節(jié)一條需求必須有一個編號第三十六頁，共九十一頁。具體需求－功能需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求處理功能需求描述每一個需求的輸入怎樣被轉(zhuǎn)換成輸出，描述軟件必須執(zhí)行的基本動作，同時給出該規(guī)格的優(yōu)先級。輸入輸出第三十七頁，共九十一頁。具體需求－功能需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求功能需求描述介紹處理該功能的目的、使用方法和技巧，及相關(guān)背景介紹所有輸出數(shù)據(jù)的詳細(xì)描述從輸入數(shù)據(jù)和中間參數(shù)獲得輸出的所有操作所有輸入數(shù)據(jù)的詳細(xì)描述輸入輸出第三十八頁，共九十一頁。具體需求－功能需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求輸入數(shù)據(jù)的描述：輸入來源數(shù)量度量單位時序允許的輸入偏差范圍第三十九頁，共九十一頁。具體需求－功能需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求處理操作：輸入數(shù)據(jù)合法性檢測操作次序異常情況的響應(yīng)操作影響到的參數(shù)用于把系統(tǒng)輸入轉(zhuǎn)換到相應(yīng)輸出的所有方法，諸如方程式，數(shù)學(xué)算法，邏輯操作對輸出數(shù)據(jù)的合法性檢測溢出通信失敗錯誤處理40第四十頁，共九十一頁。具體需求－功能需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求輸出數(shù)據(jù)的描述輸出到何處（如打印機(jī)、文件等）數(shù)量度量單位時序允許的輸出偏差范圍對非法值的處理錯誤消息第四十一頁，共九十一頁。具體需求－功能需求功能需求寫作要點(diǎn)：每個功能需求分配唯一編號，且給出一有意義的標(biāo)題，便于檢索。標(biāo)題通常是動賓詞組，不要使用“功能需求一/二”這樣的描述。是描述，而不是；介紹部分描述“做什么”沒有意義，因?yàn)楹竺鏁敿?xì)介紹。應(yīng)描述有利于理解后續(xù)的內(nèi)容：，為什么會有此需求，什么時候/什么場合使用，如何使用對描述中將使用到的特殊術(shù)語的解釋與其它功能需求的聯(lián)系等第四十二頁，共九十一頁。具體需求－功能需求功能需求寫作要點(diǎn)(續(xù))：處理部分可以采用C語言中關(guān)鍵詞如、、等輔助描述，這樣在時序、邏輯上更清晰；缺一不可有些情況下，輸入輸出可能不直觀，如：定時器超時事件、接口事件等，但并不是沒有，否則處理什么。若認(rèn)為實(shí)在沒有，那最可能是功能需求分解不合理，所描述的功能根本就不成為需求。不要將命令行作為功能需求描述單純的命令行不能提供任何功能，只是用戶界面而已；每一命令行之后都承載著一具體功能；命令行的形式我們可以自行定義，但其后的功能我們無法自行定義；用戶真正需要的是命令行承載的功能。命令行形式，甚至是命令行是否必要，這些用戶并不會關(guān)心。第四十三頁，共九十一頁。練習(xí)2.1.1.取撥號口屬性函數(shù)1介紹取以下配置：鏈路空閑掛斷時間：；呼叫間隔時間：；鏈路建立等待時間：；競爭等待時間：；緩沖區(qū)報文數(shù)：2輸入。3處理遍歷所有的全局控制塊鏈表是接口和物理接口取的取所有的撥號口屬性返回鏈表頭指針4輸出撥號口屬性鏈表頭指針。1.在描述實(shí)現(xiàn)，按照這樣的描述無法對其進(jìn)行驗(yàn)證；2.更應(yīng)該作為一個接口需求，而不是功能需求；第四十四頁，共九十一頁。具體需求－性能需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求描述軟件或人機(jī)交互的靜態(tài)和動態(tài)量化需求。靜態(tài)的量化需求支持的終端數(shù)目支持的并發(fā)用戶數(shù)目需處理的文件和記錄的數(shù)目表和文件的大小動態(tài)的量化需求可包括正常和滿負(fù)荷業(yè)務(wù)量條件下，某時間段（如一小時）內(nèi)處理的事務(wù)和任務(wù)的數(shù)目以及數(shù)據(jù)量。45第四十五頁，共九十一頁。具體需求－性能需求舉例：性能需求寫作要點(diǎn)：每條性能需求必須以可測量的術(shù)語進(jìn)行描述，即應(yīng)給出明確的量化指標(biāo)，包括度量單位；對于動態(tài)性能指標(biāo)，除性能指標(biāo)外，還應(yīng)包含必要的的前置條件；前置條件交易能很快完成，操作員不必等待。95%的事務(wù)應(yīng)在1秒內(nèi)被處理。電梯由靜止?fàn)顟B(tài)進(jìn)入正常勻速(2)狀態(tài)時間限定在2~2.5s秒內(nèi)。第四十六頁，共九十一頁。具體需求－接口需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求接口需求硬件接口軟件接口用戶接口通信接口軟件人機(jī)交互特性與系統(tǒng)硬件之間的接口與其他軟件產(chǎn)品或應(yīng)用系統(tǒng)之間的接口消息、回調(diào)函數(shù)等系統(tǒng)內(nèi)部通信接口第四十七頁，共九十一頁。具體需求－接口需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求用戶接口示例：系統(tǒng)用戶通過一個顯示終端進(jìn)行操作，需要描述：要求的屏幕格式頁面布局以及報告或菜單的內(nèi)容輸入和輸出的相關(guān)時序是否支持可編輯功能鍵第四十八頁，共九十一頁。具體需求－接口需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求軟件接口描述如何使用其他軟件，針對每個所需軟件描述：名字助記符版本號來源描述與其他軟件的接口，針對每個接口描述：接口的目的通過消息和格式定義接口第四十九頁，共九十一頁。具體需求－接口需求接口需求寫作要點(diǎn)：用戶接口若是命令行，寫作需遵照操作手冊的格式進(jìn)行；軟件接口小節(jié)，應(yīng)只描述本軟件/系統(tǒng)對外提供的軟件接口，不包括外部提供給本軟件/系統(tǒng)的接口，后者應(yīng)在依賴中予以描述；軟件接口若為函數(shù)，寫作可以按照代碼中函數(shù)頭的格式進(jìn)行，這樣在后續(xù)階段能很方便地重用。如：1.001認(rèn)證接口/********************************************************************************函數(shù)名稱:*功能描述:讀取輸入的用戶的賬號名及密碼，保存到當(dāng)前用戶信息全局變量中，*并到賬務(wù)處理系統(tǒng)進(jìn)行認(rèn)證。*輸入:無*輸出:無*返回值:：表示登錄成功；：表示登錄失敗。*調(diào)用關(guān)系:略*其它:無*******************************************************************************/50第五十頁，共九十一頁。總體設(shè)計約束描述由標(biāo)準(zhǔn)、硬件、技術(shù)限制等造成的對設(shè)計的限制標(biāo)準(zhǔn)順從：描述來自現(xiàn)有標(biāo)準(zhǔn)和規(guī)則的需求報告格式數(shù)據(jù)命名協(xié)議硬件約束：描述支持軟件運(yùn)行的硬件條件，如內(nèi)存限制技術(shù)限制：描述對使用的特定技術(shù)的限制，如數(shù)據(jù)庫、并行操作等總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求第五十一頁，共九十一頁。軟件質(zhì)量屬性可維護(hù)性可靠性安全性可移植性易用性......總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求第五十二頁，共九十一頁。軟件質(zhì)量屬性總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求可維護(hù)性描述支持軟件可維護(hù)的具體需求例如：跟蹤調(diào)試功能告警提示功能對軟件模塊之間的耦合度進(jìn)行考慮第五十三頁，共九十一頁。軟件質(zhì)量屬性總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求可靠性容錯性在出現(xiàn)軟件故障的時候仍然能夠維持某種層次性能的能力?？苫謴?fù)性在出現(xiàn)故障時的恢復(fù)能力和重新建立某種層次性能的能力。例如：主備板熱備份通信鏈路中斷重連第五十四頁，共九十一頁。軟件質(zhì)量屬性總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求安全性在此描述防止軟件遭到意外或惡意的侵入、使用、修改、破壞或泄密的因素。例如：使用特定的加密技術(shù)保存詳細(xì)的日志或歷史數(shù)據(jù)對不同模塊分配特定的功能限制程序某些區(qū)域間進(jìn)行通信對重要的數(shù)據(jù)計算校驗(yàn)和55第五十五頁，共九十一頁。軟件質(zhì)量屬性總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求可移植性描述把軟件從一個環(huán)境轉(zhuǎn)換到另一個環(huán)境時，所需要的用戶程序、用戶接口兼容性限制等需求。第五十六頁，共九十一頁。軟件質(zhì)量屬性總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求易用性易懂性：用戶通曉邏輯概念花費(fèi)的人力和軟件的適用性易學(xué)性：用戶學(xué)習(xí)應(yīng)用程序花費(fèi)的人力易操作性：用戶操作應(yīng)用程序所花費(fèi)的人力第五十七頁，共九十一頁。依賴關(guān)系依賴關(guān)系解釋每一條需求的內(nèi)部和外部依賴關(guān)系說明：依賴關(guān)系也可以在前面具體介紹每一條需求時進(jìn)行描述總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求第五十八頁，共九十一頁。其它需求總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求數(shù)據(jù)庫操作本地化需求其它需求第五十九頁，共九十一頁。附錄附錄格式的示例，成本分析研究的描述，用戶調(diào)查的結(jié)果有助于用戶閱讀的支持或背景信息軟件將解決的問題的描述被支持組織的歷史，背景，經(jīng)驗(yàn)和操作特征軟件需求與項(xiàng)目里程碑的交叉參考表，指明哪些軟件需求將在哪些里程碑階段里完成為了符合安全、出口、安裝或其它需求，對代碼和介質(zhì)的特殊包裝要求說明：附錄不是必須要求的內(nèi)容中包含附錄時，應(yīng)明確聲明附錄是否是需求的一部分。總體概述具體需求設(shè)計約束質(zhì)量屬性簡介附錄依賴關(guān)系其它需求60第六十頁，共九十一頁。需求文檔寫作要點(diǎn)僅關(guān)注“”，即系統(tǒng)需提供什么功能。不要描述“”，那是設(shè)計關(guān)注的事情。1.功能需求部分不要出現(xiàn)“××函數(shù)”、“××數(shù)據(jù)結(jié)構(gòu)”、“××指針”、之類的表述；2.站在客戶的立場上來寫需求，而不是站在開發(fā)人員的立場上。第六十一頁，共九十一頁。需求文檔寫作要點(diǎn)功能需求劃分應(yīng)合理3.1功能需求3.1.1配置要求通過協(xié)商從對端得到協(xié)商的地址1介紹在接口視圖下通過以下命令來配置要求通過主動協(xié)商從對端得到地址：

2輸入用戶在某一封裝了協(xié)議的接口視圖下，輸入：3處理路由器解析此命令輸入正確后，將修改協(xié)議中的協(xié)商參數(shù)，使的路由器在進(jìn)行協(xié)商的時候會要求對端分配協(xié)商的地址。4輸出操作成功后，可以通過在當(dāng)前視圖下輸入命令來查看配置是否成功。否則顯示出錯提示。3.1.2配置取消要求通過協(xié)商從對端得到協(xié)商的地址1介紹在接口視圖下通過以下命令來配置取消要求通過主動協(xié)商從對端得到地址：下一頁第六十二頁，共九十一頁。需求文檔寫作要點(diǎn)2輸入用戶在某一封裝了協(xié)議的接口視圖下，輸入：3處理路由器解析此命令輸入正確后，將修改協(xié)議中的協(xié)商參數(shù)，使的路由器在進(jìn)行協(xié)商的時候不會要求對端分配協(xié)商的地址。4輸出操作成功后，可以通過在當(dāng)前視圖下輸入命令來查看先前配置是否被取消。否則顯示出錯提示。3.1.3配置保存協(xié)商得到的地址，并可通過命令查看1介紹保存從對端協(xié)商得到的地址，并可通過查看接口信息的命令將得到的地址顯示出來。2輸入取出協(xié)商得到的地址3處理路由器保存協(xié)商得到的地址，并將其添加到接口信息中4輸出操作成功后，協(xié)商得到的地址保存里，并被添加到接口信息中，否則顯示出錯提示，不會顯示在接口信息中。分析：前兩個功能點(diǎn)是在描述一條命令行，而后一功能點(diǎn)描述的是另一條相關(guān)的命令行。用戶的需求是什么？是這兩條命令行嗎？命令行只是我們提供的用戶界面，隱藏其后的功能需求是什么？“支持通過協(xié)商獲取地址”，就這一條。拆成三條，需求分解不合理，如何修正？一條功能需求（支持通過協(xié)商獲取地址）命令的修改可以在功能需求的輸出中提及。一條接口需求（[]）第六十三頁，共九十一頁。需求文檔寫作要點(diǎn)唐僧：唉唉唉！大家不要生氣，生氣會犯了嗔戒的！悟空你也太調(diào)皮了，我跟你說過，叫你不要亂扔?xùn)|西。亂扔?xùn)|西這么多……你看我還沒說完呢，你把棍子又給扔掉了！月光寶盒是寶物，你把它扔掉會污染環(huán)境。唉，要是砸到小朋友呢，怎么辦？就算沒有砸到小朋友，砸到那些花花草草也是不對的呀！保持語句和段落的簡短。第六十四頁，共九十一頁。需求文檔寫作要點(diǎn)需求陳述應(yīng)該具有一致的樣式。例如“系統(tǒng)必須……”或者“用戶必須……”，并緊跟一個行為動作和可觀察的結(jié)果。舉例：計算過程中出現(xiàn)除零錯誤時，系統(tǒng)必須立即彈出對話框顯示該錯誤，并進(jìn)行聲音提示。舉例：計算過程中出現(xiàn)除零錯誤時，系統(tǒng)必須給出提示信息。65第六十五頁，共九十一頁。需求文檔寫作要點(diǎn)必須避免模糊的、主觀的術(shù)語，減少不確定性。 例如：也許、大概、可能、界面友好、容易、簡單、美觀、迅速、有效、支持、許多、最新技術(shù)、優(yōu)越的、可接受的和健壯的。........................美女.....................

!第六十六頁，共九十一頁。需求文檔寫作要點(diǎn)避免使用比較性的詞匯，例如：提高、最大化、最小化和最佳化。定量地說明所需要提高的程度或者說清一些參數(shù)可接受的最大值和最小值。提高文件柜的高度?；镉?伙計3伙計1伙計1第六十七頁，共九十一頁。需求文檔寫作要點(diǎn)不應(yīng)該把多個需求集中在一個冗長的敘述段落中。務(wù)必記?。翰灰谛枨笳f明中使用“和/或”，“等等”之類的連詞。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ù)功能。

這個“等”包含哪些內(nèi)容？怎么測試？測試人員第六十八頁，共九十一頁。需求范例69第六十九頁，共九十一頁。課程內(nèi)容為什么要文檔化文檔寫作基本要求需求設(shè)計文檔模板需求文檔寫作設(shè)計文檔寫作第七十頁，共九十一頁。設(shè)計文檔大綱(開發(fā)項(xiàng)目)零層設(shè)計一層設(shè)計二層設(shè)計配置和控制簡介模塊1詳設(shè)數(shù)據(jù)庫模塊n詳設(shè)……上下文定義設(shè)計思路分解描述依賴性描述接口描述……分解描述依賴性描述接口描述……數(shù)據(jù)描述函數(shù)描述開發(fā)項(xiàng)目：系統(tǒng)總體設(shè)計子系統(tǒng)設(shè)計系統(tǒng)對外關(guān)系第七十一頁，共九十一頁。分解層次一般不超過3層（0層、1層、2層），每層的模塊數(shù)以2到4個為宜，最多不要超過7個。單元模塊函數(shù)總數(shù)也不超過7個；階段將所有函數(shù)全部分解出來，階段不再關(guān)注模塊分解；使用結(jié)構(gòu)圖描述函數(shù)的調(diào)用關(guān)系；函數(shù)分解規(guī)模以30~50行(非空非注釋)為宜，最大不超過200行。每個函數(shù)的復(fù)雜度控制在10以內(nèi)，即：一個函數(shù)中不能有太多的，，,…等邏輯；階段寫偽碼，推薦在中寫，完成后嵌入中。偽碼的粗細(xì)程度以適宜作注釋為標(biāo)準(zhǔn)；設(shè)計文檔寫作要點(diǎn)第七十二頁，共九十一頁。結(jié)構(gòu)圖()描述了一個系統(tǒng)的模塊劃分，體現(xiàn)了模塊之間的層次、組織和通信關(guān)系示例：結(jié)構(gòu)圖第七十三頁，共九十一頁。偽碼又叫()，是一種混合語言，用自然語言（如英語、漢語等）描述程序的處理邏輯，用一定的關(guān)鍵字語法（如、等）定義控制結(jié)構(gòu)和數(shù)據(jù)結(jié)構(gòu)。優(yōu)點(diǎn)：維護(hù)方便容易評審作為代碼注釋缺點(diǎn)：不容易掌握粗細(xì)容易寫成代碼偽碼偽碼=關(guān)鍵字語法+自然語言描述第七十四頁，共九十一頁。偽碼使用C語言的語法書寫偽代碼，使用標(biāo)準(zhǔn)符號，如：,,{},等；用描述性語言來描述；（接口是以太網(wǎng)接口）（)詳略得當(dāng)。用概括性的語句來描述具體的處理，要求在每個邏輯處理分支用簡練、概括性的語言描述處理，而不要局限于處理的細(xì)節(jié)。封裝報文頭的內(nèi)容;用收到報文的源地址來設(shè)置發(fā)送報文的目的地址;用發(fā)送報文接口的地址來設(shè)置發(fā)送報文的源地址;偽碼寫作說明：75第七十五頁，共九十一頁。設(shè)計樣例第七十六頁，共九十一頁。設(shè)計文檔大綱(增強(qiáng)、移植項(xiàng)目)移植或增強(qiáng)項(xiàng)目：修改分類1修改原因影響分析修改描述修改點(diǎn)1修改點(diǎn)n…………修改分類N第七十七頁，共九十一頁。增強(qiáng)、移植設(shè)計修改分類：對所有需要的修改點(diǎn)進(jìn)行分類，一個修改分類包含一個或多個修改點(diǎn)，實(shí)現(xiàn)一相對獨(dú)立的功能；每個修改分類都應(yīng)使用有明確含義的標(biāo)題，如：“關(guān)于的修改”。修改分類一關(guān)于將策略應(yīng)用到接口下的修改修改點(diǎn)：一個修改點(diǎn)描述一處修改，如一個數(shù)據(jù)結(jié)構(gòu)的修改，一個宏定義的修改，一個函數(shù)的修改等；修改點(diǎn)也應(yīng)使用有意義的標(biāo)題，不要使用“修改點(diǎn)1”等。第七十八頁，共九十一頁。增強(qiáng)、移植設(shè)計修改原因：針對每個修改點(diǎn)，具體闡述為什么需要修改，如因?yàn)槟衬程幚砹鞒痰淖兓δ艿臄U(kuò)展，界面的變化，性能的優(yōu)化等；不應(yīng)該描述修改什么，這是修改描述部分應(yīng)詳細(xì)介紹的內(nèi)容；修改原因中的描述應(yīng)有助于對修改描述的理解。修改原因影響分析修改描述第七十九頁，共九十一頁。增強(qiáng)、移植設(shè)計影響分析：應(yīng)評估修改對原模塊有無沖擊，從功能、性能、接口等多方面進(jìn)行評估；應(yīng)評估修改對系統(tǒng)資源的消耗情況；應(yīng)描述為了配合此修改點(diǎn)還需要作哪些修改，即將各修改點(diǎn)關(guān)聯(lián)起來。還應(yīng)考慮對測試的影響，即如何充分地驗(yàn)證這些修改。影響分析修改原因修改描述80第八十頁，共九十一頁。增強(qiáng)、移植設(shè)計修改描述：使用合適的標(biāo)注方式描述修改，修改前后對比要明顯；