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

朱騏-avatar-img
發佈於PM 的學習力工具箱 個房間
更新於 發佈於 閱讀時間約 3 分鐘
對公司團隊來說,培養「寫文件」文化是非常棒的事情。例如降低新人 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
211會員
129內容數
分享學習相關的技巧、工具與方法
留言0
查看全部
avatar-img
發表第一個留言支持創作者!
朱騏的沙龍 的其他內容
「為什麼非產品部門的同事,對產品操作會這麼不熟悉呢?」這是許多產品團隊都可能遭遇的問題。這篇文章分享我在公司舉辦 Workshop (工作坊)的經驗。包含 3 部分:(1) 為什麼要舉辦 Workshop? (2) 如何準備 Workshop?(3) 我從 Workshop 學到的 3 點經驗教訓
SaaS 公司提供即時、線上的軟體產品/服務,因此讓小白使用者「好上手」是非常重要的。但使用者卡關時怎麼辦?一個不用浪費公司太多人力、又能讓使用者快速排除問題的方法就是:「提供技術文件」。如果你的公司內部/產品團隊沒有專門的Technical Writer,看完這篇文章可以讓你了解 4 種產品必要的
我曾經擔任 PM 將近 6 年的時間、在新職位 - Technical Writer 工作 9 個月的時間,這篇文章分享關於「寫文件」這件事 - 包含 Technical Writer 在做些什麼、跟「產品經理(Product Manager)」的差異。如果你對軟體產業有興趣,一起來看看這篇文章吧。
換新工作滿半年了,這是我入職場7年第一次轉換不同職能的工作,在心境上有很多的感觸跟自我對話,其中最重要的就是「身份認同」這件事情,這篇文章分享 4 點感觸給同為想要轉換職能的人。
「為什麼非產品部門的同事,對產品操作會這麼不熟悉呢?」這是許多產品團隊都可能遭遇的問題。這篇文章分享我在公司舉辦 Workshop (工作坊)的經驗。包含 3 部分:(1) 為什麼要舉辦 Workshop? (2) 如何準備 Workshop?(3) 我從 Workshop 學到的 3 點經驗教訓
SaaS 公司提供即時、線上的軟體產品/服務,因此讓小白使用者「好上手」是非常重要的。但使用者卡關時怎麼辦?一個不用浪費公司太多人力、又能讓使用者快速排除問題的方法就是:「提供技術文件」。如果你的公司內部/產品團隊沒有專門的Technical Writer,看完這篇文章可以讓你了解 4 種產品必要的
我曾經擔任 PM 將近 6 年的時間、在新職位 - Technical Writer 工作 9 個月的時間,這篇文章分享關於「寫文件」這件事 - 包含 Technical Writer 在做些什麼、跟「產品經理(Product Manager)」的差異。如果你對軟體產業有興趣,一起來看看這篇文章吧。
換新工作滿半年了,這是我入職場7年第一次轉換不同職能的工作,在心境上有很多的感觸跟自我對話,其中最重要的就是「身份認同」這件事情,這篇文章分享 4 點感觸給同為想要轉換職能的人。
你可能也想看
Google News 追蹤
Thumbnail
現代社會跟以前不同了,人人都有一支手機,只要打開就可以獲得各種資訊。過去想要辦卡或是開戶就要跑一趟銀行,然而如今科技快速發展之下,金融App無聲無息地進到你生活中。但同樣的,每一家銀行都有自己的App時,我們又該如何選擇呢?(本文係由國泰世華銀行邀約) 今天我會用不同角度帶大家看這款國泰世華CUB
Thumbnail
嘿,大家新年快樂~ 新年大家都在做什麼呢? 跨年夜的我趕工製作某個外包設計案,在工作告一段落時趕上倒數。 然後和兩個小孩過了一個忙亂的元旦。在深夜時刻,看到朋友傳來的解籤網站,興致勃勃熬夜體驗了一下,覺得非常好玩,或許有人玩過了,但還是想寫上來分享紀錄一下~
Thumbnail
寫作對產品經理來說有著重要的作用,不僅促進自我審視,還有助於邏輯思維和溝通技巧的培養。此外,透過寫作,產品經理可以與全球頂級的專業人士進行交流,提高自己的技能和保持競爭力。
Thumbnail
專案經理在專案管理中與不同角色進行溝通和談判的藝術。通過定期會議和主動傾聽建立團隊信任,定期更新和展示同理心管理客戶期望,雙贏思維和充分準備協調三方合作夥伴,以及數據驅動的簡潔匯報獲得高層支持。案例展示靈活應用這些策略,確保專案按時按質完成。
你是否曾經因為不知道如何寫企劃書而感到困惑?或者你是否需要一個完整的範本來幫助你快速上手?無論你是新手還是有經驗的專業人士,這篇文章將提供你最完整的教學、範例與範本,讓你輕鬆掌握寫企劃書的技巧。快來看看,讓你的企劃書脫穎而出!
Thumbnail
會議,是許多中小企業最喜歡做的事情。 曾經看過一個團隊一周最少開7-10個會議,有時會更多,最後的結果大都議而不決,不斷地探討特殊個案的解方,或是調整企畫內容去符合某些小眾的需求。  換個角度來看,這些在職場的日子上,我們有多少企劃、多少的專案提報,總是過不了上面主管、頂層老闆的首肯。
Thumbnail
大部分企劃和PM的工作,完全可以被正確的溝通工具和扎實的寫作文化所取代。
Thumbnail
本文整理了有關技術文件寫作的重要觀念,包括 docs as a product、內容優先,並說明如何構思文件架構。
Thumbnail
在產品開發過程中,及早分享文檔初稿並從團隊成員那裡收集反饋是非常關鍵的。這樣做不僅可以在早期階段發現潛在的問題,而且還能讓團隊成員對文檔的發展有所貢獻,從而提高他們對最終產品的接受度。當文檔在創建過程中被共享,它成為了一個動態的工具,可以根據團隊的反饋進行調整和完善。
Thumbnail
這篇文章分享創業團隊在管理壓力和溝通上的心法和經驗,並提到適當的小里程碑能夠維持團隊的前進動力,以及創造溝通環境的自由性,減少溝通上的不安。
Thumbnail
在會議中進行口頭報告時,要具有結構化的能力,以提高效率。結構化思考和表達可以節省雙方更多時間,提高效率。本文介紹了結構化報告的技巧,包括先行結論、提供證據支持、歸類分組和邏輯遞進。透過結構化的報告,可以幫助自己整理資料、整理思路,同時能讓對方快速理解和同意觀點,提升業務處理能力。
專案報告怎麼寫?有沒有模版範例?當然!我們已經為你整理好了豐富多樣的各類型專案報告範例,讓你可以按需選擇,一鍵下載就開始使用!也為你準備了專案報告撰寫教學,快跟著我們一起簡單 8 步學會寫各種專案報告!更有高效專案管理工具推薦,為你助力數據整理,寫出更加專業且具吸引力的專案報告!
Thumbnail
現代社會跟以前不同了,人人都有一支手機,只要打開就可以獲得各種資訊。過去想要辦卡或是開戶就要跑一趟銀行,然而如今科技快速發展之下,金融App無聲無息地進到你生活中。但同樣的,每一家銀行都有自己的App時,我們又該如何選擇呢?(本文係由國泰世華銀行邀約) 今天我會用不同角度帶大家看這款國泰世華CUB
Thumbnail
嘿,大家新年快樂~ 新年大家都在做什麼呢? 跨年夜的我趕工製作某個外包設計案,在工作告一段落時趕上倒數。 然後和兩個小孩過了一個忙亂的元旦。在深夜時刻,看到朋友傳來的解籤網站,興致勃勃熬夜體驗了一下,覺得非常好玩,或許有人玩過了,但還是想寫上來分享紀錄一下~
Thumbnail
寫作對產品經理來說有著重要的作用,不僅促進自我審視,還有助於邏輯思維和溝通技巧的培養。此外,透過寫作,產品經理可以與全球頂級的專業人士進行交流,提高自己的技能和保持競爭力。
Thumbnail
專案經理在專案管理中與不同角色進行溝通和談判的藝術。通過定期會議和主動傾聽建立團隊信任,定期更新和展示同理心管理客戶期望,雙贏思維和充分準備協調三方合作夥伴,以及數據驅動的簡潔匯報獲得高層支持。案例展示靈活應用這些策略,確保專案按時按質完成。
你是否曾經因為不知道如何寫企劃書而感到困惑?或者你是否需要一個完整的範本來幫助你快速上手?無論你是新手還是有經驗的專業人士,這篇文章將提供你最完整的教學、範例與範本,讓你輕鬆掌握寫企劃書的技巧。快來看看,讓你的企劃書脫穎而出!
Thumbnail
會議,是許多中小企業最喜歡做的事情。 曾經看過一個團隊一周最少開7-10個會議,有時會更多,最後的結果大都議而不決,不斷地探討特殊個案的解方,或是調整企畫內容去符合某些小眾的需求。  換個角度來看,這些在職場的日子上,我們有多少企劃、多少的專案提報,總是過不了上面主管、頂層老闆的首肯。
Thumbnail
大部分企劃和PM的工作,完全可以被正確的溝通工具和扎實的寫作文化所取代。
Thumbnail
本文整理了有關技術文件寫作的重要觀念,包括 docs as a product、內容優先,並說明如何構思文件架構。
Thumbnail
在產品開發過程中,及早分享文檔初稿並從團隊成員那裡收集反饋是非常關鍵的。這樣做不僅可以在早期階段發現潛在的問題,而且還能讓團隊成員對文檔的發展有所貢獻,從而提高他們對最終產品的接受度。當文檔在創建過程中被共享,它成為了一個動態的工具,可以根據團隊的反饋進行調整和完善。
Thumbnail
這篇文章分享創業團隊在管理壓力和溝通上的心法和經驗,並提到適當的小里程碑能夠維持團隊的前進動力,以及創造溝通環境的自由性,減少溝通上的不安。
Thumbnail
在會議中進行口頭報告時,要具有結構化的能力,以提高效率。結構化思考和表達可以節省雙方更多時間,提高效率。本文介紹了結構化報告的技巧,包括先行結論、提供證據支持、歸類分組和邏輯遞進。透過結構化的報告,可以幫助自己整理資料、整理思路,同時能讓對方快速理解和同意觀點,提升業務處理能力。
專案報告怎麼寫?有沒有模版範例?當然!我們已經為你整理好了豐富多樣的各類型專案報告範例,讓你可以按需選擇,一鍵下載就開始使用!也為你準備了專案報告撰寫教學,快跟著我們一起簡單 8 步學會寫各種專案報告!更有高效專案管理工具推薦,為你助力數據整理,寫出更加專業且具吸引力的專案報告!