【正文】 需求設(shè)計(jì)寫作培訓(xùn) 質(zhì)量管理部 SQA小組 課程范圍 ?僅關(guān)注如何寫作文檔 ?不涉及具體的需求分析和設(shè)計(jì)方法 課程內(nèi)容 ?為什么要文檔化 ?文檔寫作基本要求 ?需求設(shè)計(jì)文檔模板 ?需求文檔寫作 ?設(shè)計(jì)文檔寫作 為什么要文檔化 ? 開發(fā)人員通過文檔化的過程查錯(cuò)補(bǔ)遺； ? 便于評審，在早期發(fā)現(xiàn)技術(shù)上的問題； ? 后續(xù)階段開發(fā)任務(wù)可能由他人承擔(dān)，輸出文檔便于他們開展工作； ? 維護(hù)人員開展維護(hù)工作需要； ? 文檔是必要的交付件； ?………… 可讀性就尤為關(guān)鍵 為什么要文檔化 “所有的過程分析都要形成文檔。我們現(xiàn)在有一個(gè)嚴(yán)重的問題是，大家好像不喜歡寫文檔，對于需要的實(shí)現(xiàn)方案，通常都是一個(gè)負(fù)責(zé)人在腦袋里想想該怎么實(shí)現(xiàn)，然后郵件或電話找?guī)讉€(gè)相關(guān)人員討論一下就算可以了， 可能連個(gè)會議材料或會議紀(jì)要都沒有。 而老外可不是這樣的，他們非常非常重視文檔，他們認(rèn)為 一個(gè)人在腦袋里想的東西是不清晰也不全面的，有時(shí)候心里想的認(rèn)為很正確的方案實(shí)際上可能存在致命缺陷。他們要求必須把心里的想法形成文檔才能有效的避免這種問題。 寫文檔的過程中，可以更加有效的、更進(jìn)一步去整理您原來心里的思路，很多問題在您寫過文檔的過程中您就能發(fā)現(xiàn)；另外，文檔寫作多使用圖表，浪費(fèi)口水的文字盡量少用，和我們一起工作的系統(tǒng)工程師在系統(tǒng)架構(gòu)分析中就畫了五六十張圖， 就算看不懂他寫的英文，從圖中我們就能夠很清晰的指導(dǎo)整個(gè)產(chǎn)品的系統(tǒng)架構(gòu) ?！? —— 摘自一位華為員工的瑞典出差報(bào)告 5 課程內(nèi)容 ?為什么要文檔化 ?文檔寫作基本要求 ?需求設(shè)計(jì)文檔模板 ?需求文檔寫作 ?設(shè)計(jì)文檔寫作 文檔寫作基本要求 下面的文檔出自于我們開發(fā)人員的手筆，大家覺得如何？ 文檔寫作基本要求 ? 應(yīng)使用標(biāo)準(zhǔn)模板寫作； ? 文檔封頁、頁眉頁腳、修訂記錄、附錄、參考文獻(xiàn)應(yīng)完善； ? 關(guān)鍵詞、摘要、縮略語應(yīng)完整； ? 目錄要及時(shí)更新； ? 通篇文檔標(biāo)題、文字格式、間距應(yīng)協(xié)調(diào)美觀； ? 所有文檔模板中的章節(jié)，只可增加，不可刪除； ? 編寫建議是用來指導(dǎo)文檔寫作的，在利用完后要及時(shí)刪除； ? 圖號置于圖形之下，表號置于表格之上； 文檔寫作基本要求 ? 應(yīng)追求圖文并茂的效果； ? 句子和段落要短； ? 使用語言應(yīng)嚴(yán)謹(jǐn)，不要使用白話； ? 采用主動語氣； ? 不要出現(xiàn)“我們”、“你們”、“他們”這樣的稱謂，或“這個(gè)”、“那個(gè)”這樣的詞，應(yīng)使用“本”、“該”、“其”； ? 表述清晰，避免引起歧義； ? 通篇文檔細(xì)節(jié)上要保持一致； 練習(xí) 房子南北走向，房子大門在東側(cè)中間位置。門廳長約 3米，寬 2米，門廳左面是主臥室，右面是廚房。廚房 3米寬， 4米長，廚房門對著門廳，廚房的頂頭還有一個(gè)北陽臺，與廚房同寬，長 1米。主臥室寬 3米，長 5米左右，房間門對著客廳?？蛷d與餐廳連為一體，共 7米長， 4米寬，與客廳相連有一南陽臺，與客廳同寬，長 。餐廳的北面是衛(wèi)生間，衛(wèi)生間與廚房相對，中間由 1米寬， 3米長的過道隔開；衛(wèi)生間門對著過道，南墻與廚房的南墻在一條直線上；衛(wèi)生間為長方形，南墻長 3米，另一邊長 2米。衛(wèi)生間的北面是次臥，同寬，門朝著過道，次臥長 4米。過道的北端是書房門，書房南北長 4米，書房有一個(gè)一米見方的門廳，書房的西墻長 4米，包括 1米長的門廳長度，西墻把書房和次臥分隔開。門廳東墻北端 90角折向東，長 2米，把書房和廚房北陽臺分隔開。 大家認(rèn)為下面的描述如何？ 究竟長多 少？ ? 是左？ 還是右？ 大段的敘述，不利于理解！ 10 練習(xí) ，房子大門在東側(cè)中間位置。 長 3米，寬 2米，門廳左面是主臥室，右面是廚房。 3米寬， 4米長，廚房門對著門廳，廚房的頂頭還有一個(gè)北陽臺，與廚房同寬，長 1米。 寬 3米，長 5米左右，房間門對著客廳。 與餐廳連為一體，共 7米長， 4米寬，與客廳相連有一南陽臺，與客廳同寬，長 。 衛(wèi)生間 ，衛(wèi)生間與廚房相對，中間由 1米寬， 3米長的過道隔開；衛(wèi)生間門對著過道，南墻與廚房的南墻在一條直線上；衛(wèi)生間為長方形，南墻長 3米，另一邊長 2米。 次臥 ，同寬，門朝著過道，次臥長 4米。 書房 門，書房南北長 4米，書房有一個(gè)一米見方的門廳，書房的西墻長 4米，包括 1米長的門廳長度，西墻把書房和次臥分隔開。門廳東墻北端 90角折向東，長 2米，把書房和廚房北陽臺分隔開。 修改成如下描述之后呢？ 練習(xí) 主臥室 次臥室 廚房 餐廳 客廳 陽臺 陽臺 衛(wèi)生間 書房 門廳 過道 北 西 再改成如下圖形描述呢？ 練習(xí) LSW與 CAMS配合實(shí)現(xiàn)認(rèn)證計(jì)費(fèi)的方案中，客戶（禁止多人同時(shí)使用的業(yè)務(wù)帳號）登陸通過認(rèn)證開始計(jì)費(fèi)后，如果出現(xiàn) LSW重起的情況，處理方法分為兩種： LSW（可以記錄時(shí)間的），設(shè)備重起后會使用設(shè)備時(shí)間戳的特性判斷出設(shè)備重起了，這時(shí)會將 CAMS上的在線用戶刪除并按照最后一次計(jì)費(fèi)更新報(bào)文來終結(jié)計(jì)費(fèi)。用戶可再次正常登陸。 2.…… 下面的描述呢？ 白話 修改成如下的描述呢？ ………… LSW（ 支持記錄時(shí)間功能 ），利用設(shè)備時(shí)間戳特性可以檢測出設(shè)備 是否重啟 ， 設(shè)備重啟時(shí) 將 CAMS上的在線用戶刪除，并依據(jù)最后一次計(jì)費(fèi)更新報(bào)文終結(jié)計(jì)費(fèi)。用戶可再次正常登陸。 練習(xí) 由于一臺設(shè)備可以設(shè)置多個(gè) radius服務(wù)器，也就是radius scheme。用戶可以通過命令行來配置該 radius服務(wù)器是否啟動設(shè)備重啟防吊死功能。 由于一臺設(shè)備可以設(shè)置多個(gè) radius服務(wù)器，即 radius scheme。用戶可以通過命令行來配置該 radius服務(wù)器是否啟動設(shè)備重啟防吊死功能。 練習(xí) CAMS收到該報(bào)文后會立即回應(yīng)一個(gè) code=5的計(jì)費(fèi)回應(yīng)報(bào)文，然后根據(jù) accountingon報(bào)文攜帶的 NASIP和 NASID找到通過該設(shè)備認(rèn)證的用戶，并將他們的在線信息刪除。 CAMS收到該報(bào)文后會立即回應(yīng)一個(gè) code=5的計(jì)費(fèi)回應(yīng)報(bào)文，然后根據(jù) accountingon報(bào)文攜帶的 NASIP和 NASID找到通過該設(shè)備認(rèn)證的用戶，并將 其 在線信息刪除。 15 練習(xí) 修改原因： 這個(gè)函數(shù)是將要發(fā)送的 packet轉(zhuǎn)化為 buffer，系統(tǒng)原有函數(shù)RD_PutPacketToBuffer是針對認(rèn)證用戶設(shè)計(jì)的，由于本特性為設(shè)備啟動后執(zhí)行，沒有用戶信息，所以在 RD_PutPacketToBuffer函數(shù)基礎(chǔ)上做了一些修改，形成該函數(shù)。 修改原因： 該函數(shù)實(shí)現(xiàn)將待發(fā)送的 packet轉(zhuǎn)化為 buffer的功能，系統(tǒng)原有函數(shù)RD_PutPacketToBuffer針對認(rèn)證用戶設(shè)計(jì)，由于本特性為設(shè)備啟動后執(zhí)行，沒有用戶信息，所以在 RD_PutPacketToBuffer函數(shù)基礎(chǔ)上做了一些修改，形成該函數(shù)。 練習(xí) ARP Authorized加強(qiáng)了網(wǎng)絡(luò)安全，阻止了 DHCP server對非法 ARP回應(yīng)進(jìn)行學(xué)習(xí)，并且通過周期的 ARP ping可以快速的探測到用戶是否下線。 在設(shè)備的接口上使能 ARP Authorized，該接口的 ARP動態(tài)學(xué)習(xí)功能被禁止。在某個(gè)接口上禁止 arp動態(tài)學(xué)習(xí)，不影響其他接口的 arp學(xué)習(xí)。 在禁止了 arp動態(tài)學(xué)習(xí)的接口上，只能通過手工添加靜態(tài) arp，或者其他一些被允許的模塊才可以添加 arp，這種 arp被稱為 ARP Authorized，授權(quán) arp不再和其他的動態(tài)表項(xiàng)一樣老化，而是有自己的老化機(jī)制，后面會說明。 DHCP server就是這樣的一個(gè)模塊。 靜態(tài) arp的優(yōu)先級高于授權(quán) arp，也就是說可以覆蓋授權(quán) arp。 1. ARP與 arp、 ARP Authorized與授權(quán) arp，使用術(shù)語應(yīng)該統(tǒng)一； 2. ARP Authorized應(yīng)先解釋后引用； 3. “ DHCP server就是這樣的一個(gè)模塊”，是否相關(guān)？ 課程內(nèi)容 ?為什么要文檔化 ?文檔寫作基本要求 ?需求設(shè)計(jì)文檔模板 ?需求文檔寫作 ?設(shè)計(jì)文檔寫作 模板 何處獲取 需求 SRS文檔： REP01T01 接口文檔： REP01T03 設(shè)計(jì) 概要設(shè)計(jì)： DVP05T01 詳細(xì)設(shè)計(jì)：