課程簡介
在敏捷實踐越來越深入和普及的現(xiàn)代化研發(fā)團隊,隨著團隊規(guī)模的發(fā)展和項目規(guī)模的變大,逐漸出現(xiàn)了敏捷輕文檔和高復雜度項目需要文檔規(guī)范之間的矛盾。前線員工越忙就越?jīng)]時間寫文檔,項目參與人數(shù)越多就越增加了對文檔的需求。本課程圍繞文檔對項目的核心價值,謹慎控制文檔的數(shù)量、重點聚焦文檔的質量。由講師的實際項目經(jīng)驗,分享敏捷、效率、文檔、規(guī)范之間的平衡策略,有當堂演示講師的實際項目文檔管理成果。并分享文檔背后更深層次的如何系統(tǒng)化、結構化地梳理思路、做好設計,以及跨團隊協(xié)作時的文檔內(nèi)容評審確認機制。盡量在有限的時間投入下,盡可能最大化文檔價值輸出對項目的未來指引、執(zhí)行保證、各方共識以及知識傳承,既不會墮入重型文檔的枷鎖,也不會任由完全反文檔的失控。
目標收益
1、掌握文檔精簡方法:學會如何在敏捷開發(fā)中平衡文檔數(shù)量與質量。
2、提升文檔復用性:通過模板和架構設計提高文檔的通用性和效率。
3、明確文檔核心價值:理解文檔對項目執(zhí)行、共識和知識傳承的作用。
4、優(yōu)化文檔確認流程:掌握需求、設計、測試、運維文檔的確認實踐。
5、避免文檔管理誤區(qū):從講師親身經(jīng)歷中反思重型文檔與無文檔的代價。
6、構建文檔生命周期管理:學習如何歸檔、維護和測試文檔,確保長期價值。
培訓對象
1、研發(fā)團隊成員:包括開發(fā)、測試、運維等技術人員。
2、項目經(jīng)理:負責項目管理和跨團隊協(xié)作的人員。
3、技術團隊負責人:需要制定研發(fā)規(guī)范和文檔策略的管理者。
4、敏捷實踐者:希望在敏捷開發(fā)中優(yōu)化文檔管理的團隊成員。
5、文檔管理人員:負責文檔編寫、審核和維護的人員。
6、新入職員工:需要快速上手項目文檔的新人。
課程大綱
文檔的價值與代價 |
1、后敏捷時代重新思考文檔的價值 -傳統(tǒng)方法太依賴文檔;敏捷太反對文檔,從一個極端跳到另一個極端的代價與反思 -實例分享:講師在兩家公司的親身經(jīng)歷: (1)重型文檔帶來的痛苦、(2)完全反文檔付出的代價 -文檔:對大團隊和小團隊是不同的概念 -何為成熟團隊的“剛剛好”的文檔 2、哪些文檔該精簡、哪些文檔該發(fā)力 -討論:如何定義“沒用的”文檔 -如何定義必須的文檔 -必須遵守的規(guī)范 -經(jīng)常查閱的手冊 -必須記錄的要項 -不能靠口頭傳達的規(guī)格 3、文檔哲學 -文檔是對過去的記錄? -文檔是對未來的指導? -文檔是結論? -文檔是討論? |
第一步:文檔清晰 |
1、文檔不寫則以,寫則清晰 -文檔清晰的管理標準 -文檔與流程的結合 -實例分享:需求、開發(fā)、測試、運維天天互相撕,都要求對方“立字據(jù)”! -反思與解決 2、高質量文檔模板 -需求文檔清晰度及穩(wěn)定度考量 -高質量設計文檔書寫技巧 -高質量測試文檔核心價值點 -高質量運維文檔要素 3、信息完備度 -操作系統(tǒng)級別的軟件,如何做到任何一個細節(jié)都有據(jù)可查 |
第二步 文檔確認 |
1、文檔的確認 -對需求文檔的確認流程實踐 -對設計文檔的確認流程實踐 -對測試文檔的確認流程實踐 -對運維文檔的確認流程實踐 2、文檔的生命周期管理 -工具分享:用什么工具管理文檔 -文檔的狀態(tài)定義及管理 -文檔不能寫完白寫,文檔是后續(xù)工作的指導和規(guī)范 -文檔的歸檔 3、用戶文檔的測試 -用戶文檔的書寫分工 -多語言用戶文檔的翻譯及管理 -用戶文檔的測試 |
第三步 文檔簡化 |
提升文檔的復用性 -精雕模板、以一擋百 -技能轉換、經(jīng)驗共享 -文檔也有架構、通用及分層 -從需求到測試,一“板”到底 |
文檔類型 |
1、研發(fā)技術類文檔 -實例分享:研發(fā)過程文檔有哪些必須的文檔類型 -實例分享:研發(fā)規(guī)范性文檔有哪些必須的文檔類型 -運維及基礎設施有哪些必須的文檔類型 2、團隊日常管理文檔 -員工入職離職的組內(nèi)準備項文檔 -新人入職(技術崗)快速上手的文檔及實踐 3、工具使用類的文檔 -版本管理工具文檔 -文檔管理工具文檔 -公司內(nèi)部系統(tǒng)使用文檔 |
總結 |
1、高質量的文檔是積累出來的,不是趕工趕出來的 2、總結本課提到的每種文檔由誰來寫 3、實例分享:我們文檔雖多,但每個人文檔負擔不重。在時間上、空間上拉松,永遠重視文檔的質量多過數(shù)量 4、精簡、有深度的文檔是一種修養(yǎng) |
文檔的價值與代價 1、后敏捷時代重新思考文檔的價值 -傳統(tǒng)方法太依賴文檔;敏捷太反對文檔,從一個極端跳到另一個極端的代價與反思 -實例分享:講師在兩家公司的親身經(jīng)歷: (1)重型文檔帶來的痛苦、(2)完全反文檔付出的代價 -文檔:對大團隊和小團隊是不同的概念 -何為成熟團隊的“剛剛好”的文檔 2、哪些文檔該精簡、哪些文檔該發(fā)力 -討論:如何定義“沒用的”文檔 -如何定義必須的文檔 -必須遵守的規(guī)范 -經(jīng)常查閱的手冊 -必須記錄的要項 -不能靠口頭傳達的規(guī)格 3、文檔哲學 -文檔是對過去的記錄? -文檔是對未來的指導? -文檔是結論? -文檔是討論? |
第一步:文檔清晰 1、文檔不寫則以,寫則清晰 -文檔清晰的管理標準 -文檔與流程的結合 -實例分享:需求、開發(fā)、測試、運維天天互相撕,都要求對方“立字據(jù)”! -反思與解決 2、高質量文檔模板 -需求文檔清晰度及穩(wěn)定度考量 -高質量設計文檔書寫技巧 -高質量測試文檔核心價值點 -高質量運維文檔要素 3、信息完備度 -操作系統(tǒng)級別的軟件,如何做到任何一個細節(jié)都有據(jù)可查 |
第二步 文檔確認 1、文檔的確認 -對需求文檔的確認流程實踐 -對設計文檔的確認流程實踐 -對測試文檔的確認流程實踐 -對運維文檔的確認流程實踐 2、文檔的生命周期管理 -工具分享:用什么工具管理文檔 -文檔的狀態(tài)定義及管理 -文檔不能寫完白寫,文檔是后續(xù)工作的指導和規(guī)范 -文檔的歸檔 3、用戶文檔的測試 -用戶文檔的書寫分工 -多語言用戶文檔的翻譯及管理 -用戶文檔的測試 |
第三步 文檔簡化 提升文檔的復用性 -精雕模板、以一擋百 -技能轉換、經(jīng)驗共享 -文檔也有架構、通用及分層 -從需求到測試,一“板”到底 |
文檔類型 1、研發(fā)技術類文檔 -實例分享:研發(fā)過程文檔有哪些必須的文檔類型 -實例分享:研發(fā)規(guī)范性文檔有哪些必須的文檔類型 -運維及基礎設施有哪些必須的文檔類型 2、團隊日常管理文檔 -員工入職離職的組內(nèi)準備項文檔 -新人入職(技術崗)快速上手的文檔及實踐 3、工具使用類的文檔 -版本管理工具文檔 -文檔管理工具文檔 -公司內(nèi)部系統(tǒng)使用文檔 |
總結 1、高質量的文檔是積累出來的,不是趕工趕出來的 2、總結本課提到的每種文檔由誰來寫 3、實例分享:我們文檔雖多,但每個人文檔負擔不重。在時間上、空間上拉松,永遠重視文檔的質量多過數(shù)量 4、精簡、有深度的文檔是一種修養(yǎng) |