金字塔原理與軟件項目文檔寫作技巧

|編號：ITOP-07課時：12小時/2天 |
|金字塔原理與軟件項目文檔寫作技巧V1.5 |
| |
|----提高軟件項目文檔寫作技能 |

|課程前言 |

在軟件文檔編寫時，有時有話要說，卻不知所措；有時千言萬語，卻找不到順序；有
時內(nèi)容豐富，閱讀者不知所云；有時找個模板，卻不知該如何去填。軟件文檔，是軟件
研發(fā)過程中關(guān)鍵的信息載體，是項目管理溝通、開發(fā)的依據(jù)，是項目成功關(guān)鍵之一。軟
件文檔不僅反映了作者的能力水平，更是項目產(chǎn)品的生產(chǎn)根據(jù)之一，在組織不同的層別
中，其作用意義各不相同，它是重要的、常用的信息載體之一。

本課程介紹金字塔原理--
思考、寫作、解決問題的邏輯，國內(nèi)大型CMMI企業(yè)文檔模板及近百份最佳實踐文檔實例
，敏捷開發(fā)思想對文檔的挑戰(zhàn)，結(jié)合講師十幾年軟件行業(yè)經(jīng)驗及的文檔審計經(jīng)驗，共同
探討軟件文檔的編寫之道，幫助研發(fā)人員編寫高質(zhì)量的軟件文檔，建立企業(yè)的文檔層級
和結(jié)構(gòu)。

|特色收益 |

←
理論聯(lián)系實際：學(xué)習(xí)《金字塔原理》一書管理思想，與軟件文檔的編寫相結(jié)合；
←
文檔系統(tǒng)化：全面介紹管理體系的文件級別及文檔架構(gòu)，對軟件文檔有立體的認(rèn)
識；
← 典型文檔模板：展示通過CMMI5持續(xù)改進的文檔模板、經(jīng)典案例；
←
最佳實踐實例：從上百個項目實踐中、從組織級財富庫，精選典型的實踐實例；


← 文檔與應(yīng)用結(jié)合：不因為講文檔而文檔，闡述各文檔的作用、意見、流向。
|課程對象 |


項目經(jīng)理、需求分析工程師、系統(tǒng)設(shè)計工程師、軟件開發(fā)工程師、軟件測試工程師、
系統(tǒng)維護工程師、質(zhì)量保證工程師、配置管理工程師、過程改進工程師等興趣愛好者。


|課程大綱 |


第1天 09：00——17：00
第1章 金字塔原理----學(xué)習(xí)目標(biāo)：掌握金字塔的寫作原理、方法、結(jié)構(gòu)
□ 文檔的作用意義
□ 表達過程中常出現(xiàn)的問題
□ 如何才能講清楚、寫明白
□ 培養(yǎng)結(jié)構(gòu)化的思維方式
□ 結(jié)構(gòu)化表達的四個原則
□ 自上而下
□ 層次清晰的表達原則
□ 結(jié)構(gòu)簡單的表達原則
□ 重點突出的表達原則
□ 重點突出的表達技巧
□ 如何進行結(jié)構(gòu)化的表達
□ 演繹的表達方式
□ 歸納的表達方式
□ 如何進行書面/口頭表達
案例分析：正反面案例


□ 如何進行結(jié)構(gòu)化表達
□ 要有一個清晰的中心思想
□ 自上而下的表達
□ 分組表達
□ 表達與匯報思路
□ 用圖表說話
□ 小結(jié)


第2章 體系文檔層級及文檔管理----
學(xué)習(xí)目標(biāo)：理解體系文檔的層級、結(jié)構(gòu)及各類文檔的作用意義，掌握文檔評估、
復(fù)用、管理的方法措施
□ 體系的來源
□ 體系文檔的層級及結(jié)構(gòu)
□ 各層級文檔的作用間義
□ 層級文檔案例說明
□ 一級文級
□ 二級文級
□ 三級文級
□ 文檔的質(zhì)量評估標(biāo)準(zhǔn)
□ 軟件文檔的配置管理
□ 軟件文檔的評審
□ 文檔編寫常見的問題
□ 文檔復(fù)用的方法技巧
□ 項目文檔的剪裁
□ 小結(jié)

第3章 軟件文檔編寫技巧（組織管理）----
學(xué)習(xí)目標(biāo)：理解組織管理過程文檔編寫方法技巧。重點涉及組織管理、內(nèi)審管理
、文檔控制、文檔體系等。
□ 組織管理過程文檔
□ 質(zhì)量目標(biāo)管理文檔
□ 過程定義和改進文檔
□ 內(nèi)部質(zhì)量體系審核文檔
□ 質(zhì)量記錄控制文檔

第4章 軟件文檔編寫技巧（項目管理）----
學(xué)習(xí)目標(biāo)：理解項目管理過程文檔編寫方法技巧。重點涉及項目啟動、項目策劃
、項目結(jié)束等關(guān)鍵文檔。
□ PMP與PRINCE2簡介
□ 軟件項目管理簡介
□ 軟件項目管理過程文檔
□ 項目合同管理文檔
□ 項目啟動管理文檔
□ 項目計劃管理文檔
項目計劃
項目從屬計劃
項目過程裁剪文檔
練習(xí)：項目過程書和項目計劃


□ 項目質(zhì)量保證文檔
□ 項目過程監(jiān)控文檔
□ 項目分包控制文檔
□ 項目驗收交付文檔
□ 項目總結(jié)評價文檔
項目結(jié)項申請
項目結(jié)項報告
□ 案例分析：基于CMMI5裁剪的WS事業(yè)部項目管理規(guī)范

第2天 09：00——17：00
第5章 軟件文檔編寫技巧（軟件工程）----
學(xué)習(xí)目標(biāo)：理解工程管理過程文檔編寫方法技巧。
□ 軟件研發(fā)模型簡介
□ 軟件工程過程簡介
□ 軟件產(chǎn)品立項文檔
項目立項報告
□ 軟件需求文檔
用戶需求說明書
需求變更報告
需求跟蹤矩陣
練習(xí)：繪制完整的業(yè)務(wù)流程圖，掌握軟件文檔的核心思想
案例分析：《上海XX交通網(wǎng)絡(luò)監(jiān)控方案編寫案例分析》與《XXXX
ERP軟件需求規(guī)格說明書編寫案例分析》。
□ 軟件設(shè)計文檔
詳細設(shè)計說明書
數(shù)據(jù)庫說明書
PDM
□ 軟件測評與實現(xiàn)
用戶操作手冊
軟件測試用例
軟件測試報告
練習(xí)：編寫測試用例


第6章 軟件文檔編寫技巧（支持管理、服務(wù)管理）----
學(xué)習(xí)目標(biāo)：理解支持管理、服務(wù)管理過程文檔編寫方法技巧。
□ ITIL與ITSM簡介
□ 服務(wù)提供文檔
服務(wù)級別協(xié)議
服務(wù)目錄
服務(wù)報告
用戶投訴處理表
客戶回訪單
□ 服務(wù)支持文檔
事件和服務(wù)請求處理單
重大事件報告
問題單模板
變更&發(fā)布單
軟件發(fā)布申請單
□ 小測驗：《金字塔原理與軟件項目文檔寫作技巧 測驗》

第7章 軟件文檔最佳實踐----
學(xué)習(xí)目標(biāo)：了解CMMI5持續(xù)改進文檔模板與最佳案例。
□ CMMI簡介
□ CMMI案例文檔展示
□ 文檔財富庫
□ 工程類文檔
□ 案例分析：CMMI5參評項目體系文檔模板

第8章 真的需要很多文檔----
學(xué)習(xí)目標(biāo)：剖析敏捷開發(fā)思想，挑戰(zhàn)傳統(tǒng)的文檔，提煉一套項目文檔。
□ 什么是敏捷AGILE？
□ 敏捷AGILE思想SCRUM方法簡介
□ 敏捷開發(fā)的文檔
□ 敏捷開發(fā)文檔VS CMMI模型文檔
□ 研討：
1. 所有項目文檔要求都是一樣的嗎？
2.
一個項目最低配置的文檔是哪些？不同項目的文檔數(shù)量要求是什么？質(zhì)量等級
要求是什么？
□ 觀點：建立一套組織級、項目級的文檔規(guī)范。

李遠佳老師的其它課程