軟體產業中的 Technical Writer 在做些什麼,為什麼「寫文件」這件事情不都交給 PM 做就好?

朱騏-avatar-img
發佈於PM 的學習力工具箱 個房間
更新於 發佈於 閱讀時間約 5 分鐘
我曾經擔任 PM 將近 6 年的時間、在新職位 — Technical Writer 工作也已經快9 個月的時間,這篇文章想分享關於「寫文件」這件事情。
一開始有許多朋友和我討論說「為什麼不交給 PM 做就好?」在親身體驗與想過之後,我發現這兩者的定位與價值是完全不同的。這篇文章分享 Technical Writer 在做些什麼,以及簡單比較跟「產品經理(Product Manager)」的差異。
如果你對軟體產業有興趣、正在當 PM 的人、或是潛在想當 Technical Writer 的人看 (有這樣的朋友嗎),一起來看看這篇文章吧。
(備註:請留意此篇文章的脈絡都是以「軟體開發」的角度來談。)

1. Technical Writer 到底要幹嘛?

簡單說,就是替公司的產品寫一份「攻略本」。
攻略本是電玩產業的詞,能幫助新手玩家快速學會操作方法、了解遊戲目標,接著就可以比較開心的在遊戲的世界中玩耍。
而「技術寫作( Technical Writing )」就是替公司的產品寫使用文件,用來引導消費者更好地使用公司產品。技術寫作也可以視為公司品牌、產品使用體驗的一環,能影響消費者對於公司產品的整體觀感。
這就像「攻略本」會先告訴新手玩家基本的操作方法,讓玩家在別在超大的遊戲世界中不知所措的亂跑、被怪打死而感到挫折(可能一開始連「基礎戰鬥知識」都沒有就跑出新手村)。
好的技術文件,應該能夠把公司產品複雜的功能與規格,在適當的時間點、用適當的方式告訴使用者。

2. 為什麼需要 Technical Writer ?

對呀,為什麼不由最熟悉產品功能與規格的程式開發者或產品經理,來寫技術文件就好了呢?
先從「軟體開發者」的角度來說。由於技術文件(例如API Documentation )是技術含量相當高的文件,最好的寫作者當然是由開發者來寫。
然而多數的開發者在寫文件的時候,容易從非常技術的角度撰寫文件 — 多數狀況是「只解釋程式功能,但不解釋程式對於使用者的目的」。由於程式往往有自己的商業邏輯(例如建立訂單的流程、訂單對帳與請款的方式),使用者在不清楚商業邏輯的前提下直接閱讀,往往一頭霧水。
因此 Technical Writier 誕生了,這個職位結合「內容寫作 (Content writing)」和「技術寫作 (Technical Writing)」的專業,可以將硬梆梆的技術內容、轉換成一般使用者也能好理解的技術+商業內容。
Technical writer 像是一位翻譯員,要把「技術」國家的語言翻譯給「商業」國家的人理解。

3. 為什麼不由PM來寫技術文件?

行行好,放過PM吧!
PM的工作包山包海,要跟業務單位/客戶對需求、花時間整理規格、跟設計師/工程師/QA/營運團隊溝通。
PM職責範圍確實也包含寫產品的規格與規劃,例如:
  • 使用者故事 (User Story): 即 As a (使用者), I want (做什麼事情), so that (得到什麼成果),讓產品團隊理解每個功能為誰而做、要做什麼、做完成果。
  • User Story Acceptance Criteria Test Cases:寫完 User Story 後,必須要進一步描述這個功能的細節,透過「Given (在什麼情況下),When(當使用者做了什麼),Then(會發生什麼事情)」才能讓工程師與 QA (測試工程師) 執行。
  • Product Roadmap:告訴C字輩的老闆接下來的產品發展,這一季要做什麼、為什麼要做、要打哪些用戶、如何衡量成效、成效好與不好的相對應措施是什麼。
可以看到,PM的寫作文件通常是「對內」,告訴團隊接下來要做些什麼、不做些什麼;但 Technical Writer 通常是「對外 (外部使用者)」,告訴使用者產品從哪裡開始用、要完成對應的事情該怎麼做、技術細節要到哪裡去查…等。
PM 和Technical Writer 的技能樹不同,前者更多在溝通、後者更多在引導。

喜歡我的文章嗎?以下是更多關於我的資訊。
▶ 關於文章
1/ 歡迎 訂閱電子報 加入 650+ 學習愛好者的行列,每週 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
發表第一個留言支持創作者!
朱騏的沙龍 的其他內容
卡片盒筆記法的本質,其實是記錄「想法」與「想法的脈絡」這是跟傳統大家對於「筆記」的認知最大的不同。​ ​ 我們要分辨「筆記」與「想法」兩個字,前者是資訊的記錄、後者帶有自己的思考與感觸。​ ​ 那想法的脈絡是怎麼回事呢?其實就是將一連串相似的想法 (卡片) 用清單列下來,相近的卡片因為脈絡相同,就會
在職場工作 7 年了,我發現個人對於公司的喜好其實都表現在一些小事情上。由於多數人很難說清楚這些小事情是什麼,因此當晚輩請教時,還是只能說:「你若要挑到一個好公司,就要看企業文化呀、氛圍呀、組織架構。」但這有說等於沒說呀!如果不說大詞,那我們到底怎麼找到自己對於公司的喜好呢?我發現,「寫日記」可以派
申克博士前陣子在《卡片盒筆記》繁中版線上交流會上,分享了卡片盒「是什麼 vs 不是什麼」的10點快講。這篇文章也分享我近 1 年每天在 Obsidian 大量寫卡片、列索引、想盲點、改方法後,個人認為卡片盒筆記法的「是什麼 vs 不是什麼」5點快講。
在社會上打滾將近7年了,我發現定期的自我對話是一件極度重要的事情(甚至比無止盡的學習重要)。為什麼呢?因為沒有盤點的人生是很無序的、沒有方向的、容易迷失的。我們太常關注自己沒有的,忽略自己已經做完的。這篇文章分享一個有趣的自我盤點方法,概念是參考 Amazon 內部團隊在用的 Future prod
過去我看書有個毛病,喜歡摘抄金句,覺得好有成就感啊。但過了一陣子發現:「誒等等,這件事情我不是在書中看過怎麼解決了嗎,怎麼又犯錯了呢?」「知道」跟「做到」是兩碼子事情,我知道了不代表我就能做到。我們怎麼把書中的好觀念,真的應用在生活中、改變自己的行為?答案是:用日記作為「知道」與「行動」的橋樑。
你在學習上這樣的困擾嗎?透過反覆閱讀、反覆抄寫筆記,但知識還是記不住…不經懷疑:「難道是我記憶力特別差?」其實這不是我們的錯,遺忘是大腦天生運作的機制。 這篇文章就來了解遺忘跟大腦的關係,以及我們如何克服它、加強自己的學習能力。
卡片盒筆記法的本質,其實是記錄「想法」與「想法的脈絡」這是跟傳統大家對於「筆記」的認知最大的不同。​ ​ 我們要分辨「筆記」與「想法」兩個字,前者是資訊的記錄、後者帶有自己的思考與感觸。​ ​ 那想法的脈絡是怎麼回事呢?其實就是將一連串相似的想法 (卡片) 用清單列下來,相近的卡片因為脈絡相同,就會
在職場工作 7 年了,我發現個人對於公司的喜好其實都表現在一些小事情上。由於多數人很難說清楚這些小事情是什麼,因此當晚輩請教時,還是只能說:「你若要挑到一個好公司,就要看企業文化呀、氛圍呀、組織架構。」但這有說等於沒說呀!如果不說大詞,那我們到底怎麼找到自己對於公司的喜好呢?我發現,「寫日記」可以派
申克博士前陣子在《卡片盒筆記》繁中版線上交流會上,分享了卡片盒「是什麼 vs 不是什麼」的10點快講。這篇文章也分享我近 1 年每天在 Obsidian 大量寫卡片、列索引、想盲點、改方法後,個人認為卡片盒筆記法的「是什麼 vs 不是什麼」5點快講。
在社會上打滾將近7年了,我發現定期的自我對話是一件極度重要的事情(甚至比無止盡的學習重要)。為什麼呢?因為沒有盤點的人生是很無序的、沒有方向的、容易迷失的。我們太常關注自己沒有的,忽略自己已經做完的。這篇文章分享一個有趣的自我盤點方法,概念是參考 Amazon 內部團隊在用的 Future prod
過去我看書有個毛病,喜歡摘抄金句,覺得好有成就感啊。但過了一陣子發現:「誒等等,這件事情我不是在書中看過怎麼解決了嗎,怎麼又犯錯了呢?」「知道」跟「做到」是兩碼子事情,我知道了不代表我就能做到。我們怎麼把書中的好觀念,真的應用在生活中、改變自己的行為?答案是:用日記作為「知道」與「行動」的橋樑。
你在學習上這樣的困擾嗎?透過反覆閱讀、反覆抄寫筆記,但知識還是記不住…不經懷疑:「難道是我記憶力特別差?」其實這不是我們的錯,遺忘是大腦天生運作的機制。 這篇文章就來了解遺忘跟大腦的關係,以及我們如何克服它、加強自己的學習能力。
你可能也想看
Google News 追蹤
Thumbnail
隨著理財資訊的普及,越來越多台灣人不再將資產侷限於台股,而是將視野拓展到國際市場。特別是美國市場,其豐富的理財選擇,讓不少人開始思考將資金配置於海外市場的可能性。 然而,要參與美國市場並不只是盲目跟隨標的這麼簡單,而是需要策略和方式,尤其對新手而言,除了選股以外還會遇到語言、開戶流程、Ap
Thumbnail
嘿,大家新年快樂~ 新年大家都在做什麼呢? 跨年夜的我趕工製作某個外包設計案,在工作告一段落時趕上倒數。 然後和兩個小孩過了一個忙亂的元旦。在深夜時刻,看到朋友傳來的解籤網站,興致勃勃熬夜體驗了一下,覺得非常好玩,或許有人玩過了,但還是想寫上來分享紀錄一下~
在產品管理 (PM) 的領域,Technical PM (技術型產品經理) 與 Non-Technical PM (非技術型產品經理) 的角色與職責經常被混淆。雖然兩者都屬於產品經理,但在背景、專注領域和工作方式上有明顯的差異。 以下分享兩者的不同之處: ▋背景與技能要求
Thumbnail
在產品經理這個職位上,常需要撰寫各種產品文件,像是產品需求文件、產品教學手冊、產品路線圖、產品維運常見問題等,這篇想整理過往以產品經理的角色需要維護哪些文件。
Thumbnail
寫作對產品經理來說有著重要的作用,不僅促進自我審視,還有助於邏輯思維和溝通技巧的培養。此外,透過寫作,產品經理可以與全球頂級的專業人士進行交流,提高自己的技能和保持競爭力。
Thumbnail
PMM 產品行銷經理在軟體產業中扮演著愈來愈重要的角色。這篇文章藉著 McKiney 對 PMM 職能的研究,分享 PMM 職責、與一般行銷的不同之處、需要與產品開發團隊協作等等內容。
Thumbnail
本文淺談專案管理(PM)在公司中的重要性,以及圍繞在 PM 周圍的各單位分工。介紹了專案範圍管理、專案成本管理、專案溝通管理、專案風險管理、專案整合管理等專案管理的相關內容,並著重介紹了 TPM、EPM、OPM、Sales Product Manager 等常見的專案管理角色。
Thumbnail
本文整理了有關技術文件寫作的重要觀念,包括 docs as a product、內容優先,並說明如何構思文件架構。
Thumbnail
近期在準備產品經理的職涯訪談,剛好把一些產品思維紀錄一下,包含對於產品工作的理解、產品規劃流程、和產品經理的自我反思,這篇不代表最正確的答案,僅代表個人在產品經理道路上的思維。
Thumbnail
產品經理做每個產品決策時,都不斷會被客戶、客戶經理、產品主管詢問各種為什麼,像是為什麼這樣設計?出發點是什麼?影響是什麼?因此這篇想記錄我在工作中遇到的各種產品問答,包含影響我哪些產品思維和框架。
上一篇主要在說如何做決定的,這篇就來寫寫面試前該做什麼準備。
在企業管理中,產品經理(Product Management)與專案經理(Project Management)這兩個角色雖然都被簡稱為「PM」,但實際上存在著相異之處與部分重疊。
Thumbnail
隨著理財資訊的普及,越來越多台灣人不再將資產侷限於台股,而是將視野拓展到國際市場。特別是美國市場,其豐富的理財選擇,讓不少人開始思考將資金配置於海外市場的可能性。 然而,要參與美國市場並不只是盲目跟隨標的這麼簡單,而是需要策略和方式,尤其對新手而言,除了選股以外還會遇到語言、開戶流程、Ap
Thumbnail
嘿,大家新年快樂~ 新年大家都在做什麼呢? 跨年夜的我趕工製作某個外包設計案,在工作告一段落時趕上倒數。 然後和兩個小孩過了一個忙亂的元旦。在深夜時刻,看到朋友傳來的解籤網站,興致勃勃熬夜體驗了一下,覺得非常好玩,或許有人玩過了,但還是想寫上來分享紀錄一下~
在產品管理 (PM) 的領域,Technical PM (技術型產品經理) 與 Non-Technical PM (非技術型產品經理) 的角色與職責經常被混淆。雖然兩者都屬於產品經理,但在背景、專注領域和工作方式上有明顯的差異。 以下分享兩者的不同之處: ▋背景與技能要求
Thumbnail
在產品經理這個職位上,常需要撰寫各種產品文件,像是產品需求文件、產品教學手冊、產品路線圖、產品維運常見問題等,這篇想整理過往以產品經理的角色需要維護哪些文件。
Thumbnail
寫作對產品經理來說有著重要的作用,不僅促進自我審視,還有助於邏輯思維和溝通技巧的培養。此外,透過寫作,產品經理可以與全球頂級的專業人士進行交流,提高自己的技能和保持競爭力。
Thumbnail
PMM 產品行銷經理在軟體產業中扮演著愈來愈重要的角色。這篇文章藉著 McKiney 對 PMM 職能的研究,分享 PMM 職責、與一般行銷的不同之處、需要與產品開發團隊協作等等內容。
Thumbnail
本文淺談專案管理(PM)在公司中的重要性,以及圍繞在 PM 周圍的各單位分工。介紹了專案範圍管理、專案成本管理、專案溝通管理、專案風險管理、專案整合管理等專案管理的相關內容,並著重介紹了 TPM、EPM、OPM、Sales Product Manager 等常見的專案管理角色。
Thumbnail
本文整理了有關技術文件寫作的重要觀念,包括 docs as a product、內容優先,並說明如何構思文件架構。
Thumbnail
近期在準備產品經理的職涯訪談,剛好把一些產品思維紀錄一下,包含對於產品工作的理解、產品規劃流程、和產品經理的自我反思,這篇不代表最正確的答案,僅代表個人在產品經理道路上的思維。
Thumbnail
產品經理做每個產品決策時,都不斷會被客戶、客戶經理、產品主管詢問各種為什麼,像是為什麼這樣設計?出發點是什麼?影響是什麼?因此這篇想記錄我在工作中遇到的各種產品問答,包含影響我哪些產品思維和框架。
上一篇主要在說如何做決定的,這篇就來寫寫面試前該做什麼準備。
在企業管理中,產品經理(Product Management)與專案經理(Project Management)這兩個角色雖然都被簡稱為「PM」,但實際上存在著相異之處與部分重疊。