軟體公司如何在公司內部推行「寫文件」的公司文化 ? 6 點可以馬上開始實作的建議

朱騏-avatar-img
發佈於PM 的學習力工具箱 個房間
更新於 發佈於 閱讀時間約 4 分鐘

對公司團隊來說,培養「寫文件」文化是非常棒的事情。例如降低新人 onboarding 時的教育成本、跨團隊溝通的時間成本。

但多數的人都覺得「寫文件」是一件麻煩的事情。

如果你 (公司團隊) 要開始推行「寫文件」文化,應該如何做呢? 參考 Write the Doc 的建議與我的個人經驗,有 6 點建議:

  1. 從解決 1 個具體的問題開始
  2. 從產品/工程團隊開始
  3. 收集回饋
  4. 先建立文件分類
  5. 先建立模版
  6. 定期回顧推行成效

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產品經理工作經驗,☕️ 歡迎講座邀約、諮詢或跟我喝杯咖啡聊聊天,我的信箱是 muhenry608@gmail.com

▶︎ 聯繫方式 • 📪 Email:muhenry608@gmail.com • 💬 Facebook:請先加我 個人好友 並簡短說明想要諮詢的主題

▶︎ 建立人脈 歡迎使用 LinkedIn 與我交流,你可以「加我為好友」建立連結 | LinkedIn @ Chi Chu 歡迎交流


留言
avatar-img
留言分享你的想法!
avatar-img
朱騏的沙龍
215會員
129內容數
分享學習相關的技巧、工具與方法
朱騏的沙龍的其他內容
2024/08/21
忙碌的現代人常面臨學習效率低的問題。我也是愛買課程的人,直到整理出四步驟學習系統:起心動念、拆解目標、開始學習、檢視成果。首先,找到學習的動機,確保學習有明確的目的。接著,運用SMART原則拆解學習目標,讓目標具體可行。第三步,直接在實際場景中學習。最後,通過AAR檢視學習成果,提升下一次學習效果。
Thumbnail
2024/08/21
忙碌的現代人常面臨學習效率低的問題。我也是愛買課程的人,直到整理出四步驟學習系統:起心動念、拆解目標、開始學習、檢視成果。首先,找到學習的動機,確保學習有明確的目的。接著,運用SMART原則拆解學習目標,讓目標具體可行。第三步,直接在實際場景中學習。最後,通過AAR檢視學習成果,提升下一次學習效果。
Thumbnail
2023/09/22
我已經在 Facebook 和部落格上連續寫作超過 365 天了。 2 年前還不太會寫作時,早上坐捷運時腦中都有個聲音:「完蛋了,今天不知道要寫什麼啊啊啊!」 後來我發現,建立容易達成的小習慣很有用。 下面的 3 個小習慣,幫我能夠克服這個困難。 允許自己可以寫出垃圾:根據作家 Anne L
Thumbnail
2023/09/22
我已經在 Facebook 和部落格上連續寫作超過 365 天了。 2 年前還不太會寫作時,早上坐捷運時腦中都有個聲音:「完蛋了,今天不知道要寫什麼啊啊啊!」 後來我發現,建立容易達成的小習慣很有用。 下面的 3 個小習慣,幫我能夠克服這個困難。 允許自己可以寫出垃圾:根據作家 Anne L
Thumbnail
2023/07/25
Source: Nicolas Cole — Medium 這是一個特殊的職業。 世界上有一種人,專門幫那些腦袋有非常多專業知識,但沒有時間的人寫文章。 他們叫做 Ghostwriter (影子寫手),通常為公司老闆代筆。 Nicolas Cole 曾經擔任過 100+ 位公司老闆的 G
2023/07/25
Source: Nicolas Cole — Medium 這是一個特殊的職業。 世界上有一種人,專門幫那些腦袋有非常多專業知識,但沒有時間的人寫文章。 他們叫做 Ghostwriter (影子寫手),通常為公司老闆代筆。 Nicolas Cole 曾經擔任過 100+ 位公司老闆的 G
看更多
你可能也想看
Thumbnail
大家好,我是一名眼科醫師,也是一位孩子的媽 身為眼科醫師的我,我知道視力發展對孩子來說有多關鍵。 每到開學季時,診間便充斥著許多憂心忡忡的家屬。近年來看診中,兒童提早近視、眼睛疲勞的案例明顯增加,除了3C使用過度,最常被忽略的,就是照明品質。 然而作為一位媽媽,孩子能在安全、舒適的環境
Thumbnail
大家好,我是一名眼科醫師,也是一位孩子的媽 身為眼科醫師的我,我知道視力發展對孩子來說有多關鍵。 每到開學季時,診間便充斥著許多憂心忡忡的家屬。近年來看診中,兒童提早近視、眼睛疲勞的案例明顯增加,除了3C使用過度,最常被忽略的,就是照明品質。 然而作為一位媽媽,孩子能在安全、舒適的環境
Thumbnail
我的「媽」呀! 母親節即將到來,vocus 邀請你寫下屬於你的「媽」故事——不管是紀錄爆笑的日常,或是一直想對她表達的感謝,又或者,是你這輩子最想聽她說出的一句話。 也歡迎你曬出合照,分享照片背後的點點滴滴 ♥️ 透過創作,將這份情感表達出來吧!🥹
Thumbnail
我的「媽」呀! 母親節即將到來,vocus 邀請你寫下屬於你的「媽」故事——不管是紀錄爆笑的日常,或是一直想對她表達的感謝,又或者,是你這輩子最想聽她說出的一句話。 也歡迎你曬出合照,分享照片背後的點點滴滴 ♥️ 透過創作,將這份情感表達出來吧!🥹
Thumbnail
去年的職涯歷程由「一人行銷」晉階帶領新人,同時也帶領大專院生參與電商大賽並獲獎。這段過程有很多收穫和啟發。原本自己一個人可以從頭到尾,把一件事情完整執行,轉變為必須建立系統方法,才能把已知的事務傳遞給新手,並且協助他們也把事情做好。 這段過程,發現建立順暢的工作流程和文件,相當重要。
Thumbnail
去年的職涯歷程由「一人行銷」晉階帶領新人,同時也帶領大專院生參與電商大賽並獲獎。這段過程有很多收穫和啟發。原本自己一個人可以從頭到尾,把一件事情完整執行,轉變為必須建立系統方法,才能把已知的事務傳遞給新手,並且協助他們也把事情做好。 這段過程,發現建立順暢的工作流程和文件,相當重要。
Thumbnail
大家常常會說,專案的起案是最重要的 一個專案起的好,後面就順了;起得不好,往往會失敗收場 但是在一間企業,案子的啟動方式往往百百種 今天就來聊聊,各種起案的方式
Thumbnail
大家常常會說,專案的起案是最重要的 一個專案起的好,後面就順了;起得不好,往往會失敗收場 但是在一間企業,案子的啟動方式往往百百種 今天就來聊聊,各種起案的方式
Thumbnail
自今年起,我開始接手了公司的GLP規範之章程的建立,從零開始,到今年也建構了一年,過程中也對流程建立也有些心得,也深刻理解這不是件容易的事情,一方面需要釐清目標與現況資源的差距,在有意義的規範下河有限的資源創造出最可行的規範,是一門專業。此篇跟大家聊聊,如何從零到有。
Thumbnail
自今年起,我開始接手了公司的GLP規範之章程的建立,從零開始,到今年也建構了一年,過程中也對流程建立也有些心得,也深刻理解這不是件容易的事情,一方面需要釐清目標與現況資源的差距,在有意義的規範下河有限的資源創造出最可行的規範,是一門專業。此篇跟大家聊聊,如何從零到有。
Thumbnail
對公司團隊來說,培養「寫文件」文化是非常棒的事情。例如降低新人 onboarding 時的教育成本、跨團隊溝通的時間成本。但多數的人都覺得「寫文件」是一件麻煩的事情。如果公司團隊要開始推行「寫文件」文化,應該如何做呢? 我有 6 點建議。
Thumbnail
對公司團隊來說,培養「寫文件」文化是非常棒的事情。例如降低新人 onboarding 時的教育成本、跨團隊溝通的時間成本。但多數的人都覺得「寫文件」是一件麻煩的事情。如果公司團隊要開始推行「寫文件」文化,應該如何做呢? 我有 6 點建議。
Thumbnail
團隊的建立重點在於企業文化的養成 企業文化的意象通常來自老闆與高階經理人,建立有效率的團隊,必須先塑造團隊文化,在任何專案執行的精神,遇到執行瓶頸的態度,是重要的經營關鍵,企業文化的盛衰與團隊榮枯互為因果。了解每個成員的優勢,提高團隊的效率,是管理者最重要的工作。
Thumbnail
團隊的建立重點在於企業文化的養成 企業文化的意象通常來自老闆與高階經理人,建立有效率的團隊,必須先塑造團隊文化,在任何專案執行的精神,遇到執行瓶頸的態度,是重要的經營關鍵,企業文化的盛衰與團隊榮枯互為因果。了解每個成員的優勢,提高團隊的效率,是管理者最重要的工作。
Thumbnail
目前在群眾集資平台擔任平台專員,a.k.a 客戶成功專員(Customer Success Specialist),從初期規範建立,到後期慢慢找出與不同客戶的應對進退方式,這篇想分享我在平台端面對客戶時的心法-如何與客戶應對進退。
Thumbnail
目前在群眾集資平台擔任平台專員,a.k.a 客戶成功專員(Customer Success Specialist),從初期規範建立,到後期慢慢找出與不同客戶的應對進退方式,這篇想分享我在平台端面對客戶時的心法-如何與客戶應對進退。
Thumbnail
從其他人的經驗結合個人現況,總結成下面3點來跟大家聊聊: 1. 趁一個人做事的空檔,學讓一群人把專案做好的方法 2. 用正確心態面對管理,建立問題工具箱 3. 在直屬主管建立的流程下,接手自己可以扛的工作
Thumbnail
從其他人的經驗結合個人現況,總結成下面3點來跟大家聊聊: 1. 趁一個人做事的空檔,學讓一群人把專案做好的方法 2. 用正確心態面對管理,建立問題工具箱 3. 在直屬主管建立的流程下,接手自己可以扛的工作
Thumbnail
在某些行業之中,寫作也是工作的一部分;而企業寫作跟個人業餘寫作不同的地方,在於寫的內容必定有優先順序和目的、並且追求某些效益,所以必須遵守某些基本規範。本文是我教授企業寫作的部分課程綱要,提供給有興趣、或是跟工作內容剛好相關的訂戶參考。
Thumbnail
在某些行業之中,寫作也是工作的一部分;而企業寫作跟個人業餘寫作不同的地方,在於寫的內容必定有優先順序和目的、並且追求某些效益,所以必須遵守某些基本規範。本文是我教授企業寫作的部分課程綱要,提供給有興趣、或是跟工作內容剛好相關的訂戶參考。
Thumbnail
因疫在家工作後,原本以為減少了人事應酬可以有很多的時間做事情,結果反而更忙了,還不知道自己在瞎忙什麼,原來問題全卡在溝通成本上。
Thumbnail
因疫在家工作後,原本以為減少了人事應酬可以有很多的時間做事情,結果反而更忙了,還不知道自己在瞎忙什麼,原來問題全卡在溝通成本上。
Thumbnail
團隊的建立必須談到企業文化的養成,企業文化的意象通常來自老闆與高階經理人,建立有效率的團隊,必須先塑造團隊文化,在任何專案執行的精神,遇到執行瓶頸的態度,都是重要關鍵,企業文化的盛衰與團隊榮枯互為因果。
Thumbnail
團隊的建立必須談到企業文化的養成,企業文化的意象通常來自老闆與高階經理人,建立有效率的團隊,必須先塑造團隊文化,在任何專案執行的精神,遇到執行瓶頸的態度,都是重要關鍵,企業文化的盛衰與團隊榮枯互為因果。
追蹤感興趣的內容從 Google News 追蹤更多 vocus 的最新精選內容追蹤 Google News