軟體公司如何在公司內部推行「寫文件」的公司文化 ? 6 點可以馬上開始實作的建議
2022/10/26閱讀時間約 3 分鐘
對公司團隊來說，培養「寫文件」文化是非常棒的事情。例如降低新人 onboarding 時的教育成本、跨團隊溝通的時間成本。
但多數的人都覺得「寫文件」是一件麻煩的事情。
如果你 (公司團隊) 要開始推行「寫文件」文化，應該如何做呢? 參考 Write the Doc 的建議與我的個人經驗，有 6 點建議:
- 從解決 1 個具體的問題開始
- 從產品/工程團隊開始
- 收集回饋
- 先建立文件分類
- 先建立模版
- 定期回顧推行成效
1. 從解決 1 個具體的問題開始
「寫文件」是一個很大的目標，對多數沒有習慣的人很難做到。
我們該從小做起，先解決組織中 1 個非常具體的「寫文件」問題。例如:
替「工程團隊」的「A 專案」的「產品」寫文件。
一次只從一個小點做起，就不會勞師動眾、受到大家先入為主的刻板印象。
2. 從產品/工程團隊開始
「寫文件」可以從工程團隊開始。
公司內部的團隊很多，但工程團隊/產品團隊是相對容易獲得「寫文件」的。可以寫的內容包含
- 專案文件: 例如專案目標、預算、WBS 規劃
- 流程文件: 例如 Code Playbook (工程師開發的操作指南)
- 最佳實踐: 例如在開發這一段 API 的串接流程時的細節
- Style Guides: 例如專案人員在寫 Jira ticket 時的任務格式
3. 收集回饋
讓討論的資訊透明。
管理者雖然希望團隊成員能參加規劃會議
- 但成員不必都來參加
- 只要確保討論結果都公開且容易收集到回饋
例如使用 Google Doc 撰寫會議記錄，並讓團隊成員能在有疑問的地方註記。
4. 先建立文件分類
多數公司的文件都是「有機生長 (aka 沒有組織規則)」，這讓其他團隊成員很難維護。
文件維護負責人可以預先建立「分類」，讓成員好整理資料。例如:
- Changelog(更新日誌)
- 開發資源
- 專案規劃
- 產品文件
- 會議記錄
當團隊成員紀錄文件後，按照分類放即可。
5. 先建立模版
建立模版讓同事可以立刻開始。
例如
- Jira ticket 模版，只要 3 秒鐘就能有文件大綱可以開始照著指引寫。
- 會議記錄模版，每個成員都能按照固定格式紀錄
- Bug report 模版，讓所有人能一次提供解 Bug 需要的資訊
有一套標準可以遵守時，每個人做事情才會有效率。
6. 定期回顧推行成效
定期回顧「寫文件」的推行狀況。
例如透過 1 周 1 次的公司會議，花 10 分鐘的時間快速走過寫文件進度並收集大家的回饋。
規劃 -> 實行 -> 檢查 -> 修正 -> 回到第一步。
喜歡我的文章嗎？以下是更多關於我的資訊。
▶ 關於文章
1/ 歡迎 訂閱電子報 加入 850+ 學習愛好者的行列，每週 1 個學習行動建議！ 2/ 常滑 Facebook 嗎？可以幫我的 Facebook 粉絲團 按個讚，就可以看到文章啦～ 3/ 想要掌握最新文章，可以點擊「追蹤」我～ 4/ 如果你覺得文章寫的不錯，可以對文章點愛心讓我知道 ❤️
▶ 關於我 Software Technical writer @ OwlTing 奧丁丁集團 我專注寫 1/ SaaS 軟體產品規劃 2/ 個人知識管理 3/ 線上寫作的文章 擁有 6+ 年的SaaS產品經理工作經驗，☕️ 歡迎講座邀約、諮詢或跟我喝杯咖啡聊聊天，我的信箱是 [email protected]
▶︎ 建立人脈 歡迎使用 LinkedIn 與我交流，你可以「加我為好友」建立連結 | LinkedIn @ Chi Chu 歡迎交流
留言0
查看全部