軟體產業中的 Technical Writer 在做些什麼,為什麼「寫文件」這件事情不都交給 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 歡迎交流
210會員
129內容數
分享學習相關的技巧、工具與方法
留言0
查看全部
發表第一個留言支持創作者!
朱騏的沙龍 的其他內容
卡片盒筆記法的本質,其實是記錄「想法」與「想法的脈絡」這是跟傳統大家對於「筆記」的認知最大的不同。​ ​ 我們要分辨「筆記」與「想法」兩個字,前者是資訊的記錄、後者帶有自己的思考與感觸。​ ​ 那想法的脈絡是怎麼回事呢?其實就是將一連串相似的想法 (卡片) 用清單列下來,相近的卡片因為脈絡相同,就會
在職場工作 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
這個秋,Chill 嗨嗨!穿搭美美去賞楓,裝備款款去露營⋯⋯你的秋天怎麼過?秋日 To Do List 等你分享! 秋季全站徵文,我們準備了五個創作主題,參賽還有機會獲得「火烤兩用鍋」,一起來看看如何參加吧~
Thumbnail
11/20日NVDA即將公布最新一期的財報, 今天Sell Side的分析師, 開始調高目標價, 市場的股價也開始反應, 未來一週NVDA將重新回到美股市場的焦點, 今天我們要分析NVDA Sell Side怎麼看待這次NVDA的財報預測, 以及實際上Buy Side的倉位及操作, 從
Thumbnail
Hi 大家好,我是Ethan😊 相近大家都知道保濕是皮膚保養中最基本,也是最重要的一步。無論是在畫室裡長時間對著畫布,還是在旅途中面對各種氣候變化,保持皮膚的水分平衡對我來說至關重要。保濕化妝水不僅能迅速為皮膚補水,還能提升後續保養品的吸收效率。 曾經,我的保養程序簡單到只包括清潔和隨意上乳液
Thumbnail
在經營社群的過程中,我時不時會收到有讀者來詢問轉職到博弈領域相關的疑問,其中有部分並不是因為理解到對部分非本科工程師來說,博弈或是區塊鏈相關的產業是一個門檻較低的領域所以才來詢問轉職方向,而是單純薪資高,所以想要嘗試轉職進博弈或是區塊鏈產業⋯⋯
Thumbnail
越南科技業已在成為軟體代工的新興。臺灣筆電製造業約15%至20%的比重在越南,新加坡則被視為晶片採購大國。新加坡的晶圓製造產能佔全球5%,並在全球半導體設備市佔高達19%,政府致力發展人工智慧、自駕車、金融科技等。對香港而言,中國政府對數家科技公司採取監管行動,挑戰和機遇並存。
Thumbnail
去年也說明過了,就是機器人的產業崛起想像 我們目前頂多習慣LEVEL 2~3 而下一個等級是系統全自動,這需要更多的法規還有硬體+軟體進步 我還是跟2020年看法一樣.電動車2025年群雄割據結束後,就會邁入下一個階段 之後就是軟體也會開始有成長期空間 2020年說要先硬體普及後才能開
Thumbnail
社群媒體對人們的負面影響與操縱已成為矽谷巨頭公司前骨幹成員討論的焦點。透過這些平臺,使用者的時間與個人資料被轉化成商品販售給廠商,因此社群媒體平臺為了獲取更多商業利益,不惜一切手段搶佔使用者的注意力。此外,社群媒體的出現導致了青少年的自殺率上升,讓人更脆弱、焦慮、憂鬱。同時,社群媒體還無形中建立同溫層,讓人無法接受外面的世界,更容易被操縱。這些市場行為和效應不僅對個人,甚至可能對國家和世界產生深遠的影響。
Thumbnail
投資理財內容聲明 文內如有投資理財相關經驗、知識、資訊等內容,皆為作者個人分享行為。 有價證券、指數與衍生性商品之數據資料,僅供輔助說明之用,不代表創作者投資決策之推介及建議。 閱讀同時,請審慎思考自身條件及自我決策,並應有為決策負責之事前認知。 希望您能從這些分享內容汲取投資養份,養成獨立
Thumbnail
聽 Manny & Angela 最新的曼報 podcast,我覺得本文標題這句話是關鍵,也引發我對軟體產業本質的思考。
Thumbnail
去年下半年開始了幾個工廠設備的監控專案顧問開發。 有別於以往比較多接觸的消費者端應用,情境確實比較不一樣。系統開發很重要的一個點是因時制宜、因地制宜,這次就算是一個很好的案例。 本篇文章紀錄一下值得分享的心得。
Thumbnail
最近收到雲門教室的面試邀請..在談銷售通路之前,要先知道年度營收目標是什麼 ( PBF - Product Business Fit )才有意義。有了年度營收目標,才能進而決定相對應的 multi-segment 市場定價策略,擬定穩定新客轉換 ( PGF - Product Growth Fit)
Thumbnail
  【寫在前面的三言二語】 新冠肺炎池持續延燒,各種的變種病毒也紛紛出籠,想要有效防堵,萬變不離其宗就是疫苗打好打滿才有防護力,人類世界如此,電腦虛擬數位科技世界更是亦然,想要免受到電腦病毒的騷擾侵襲,一定要安裝好可靠的電腦防毒軟體,全球電腦知名防毒軟體廠商-趨勢科技PC-cillin 2021 雲
Thumbnail
這個秋,Chill 嗨嗨!穿搭美美去賞楓,裝備款款去露營⋯⋯你的秋天怎麼過?秋日 To Do List 等你分享! 秋季全站徵文,我們準備了五個創作主題,參賽還有機會獲得「火烤兩用鍋」,一起來看看如何參加吧~
Thumbnail
11/20日NVDA即將公布最新一期的財報, 今天Sell Side的分析師, 開始調高目標價, 市場的股價也開始反應, 未來一週NVDA將重新回到美股市場的焦點, 今天我們要分析NVDA Sell Side怎麼看待這次NVDA的財報預測, 以及實際上Buy Side的倉位及操作, 從
Thumbnail
Hi 大家好,我是Ethan😊 相近大家都知道保濕是皮膚保養中最基本,也是最重要的一步。無論是在畫室裡長時間對著畫布,還是在旅途中面對各種氣候變化,保持皮膚的水分平衡對我來說至關重要。保濕化妝水不僅能迅速為皮膚補水,還能提升後續保養品的吸收效率。 曾經,我的保養程序簡單到只包括清潔和隨意上乳液
Thumbnail
在經營社群的過程中,我時不時會收到有讀者來詢問轉職到博弈領域相關的疑問,其中有部分並不是因為理解到對部分非本科工程師來說,博弈或是區塊鏈相關的產業是一個門檻較低的領域所以才來詢問轉職方向,而是單純薪資高,所以想要嘗試轉職進博弈或是區塊鏈產業⋯⋯
Thumbnail
越南科技業已在成為軟體代工的新興。臺灣筆電製造業約15%至20%的比重在越南,新加坡則被視為晶片採購大國。新加坡的晶圓製造產能佔全球5%,並在全球半導體設備市佔高達19%,政府致力發展人工智慧、自駕車、金融科技等。對香港而言,中國政府對數家科技公司採取監管行動,挑戰和機遇並存。
Thumbnail
去年也說明過了,就是機器人的產業崛起想像 我們目前頂多習慣LEVEL 2~3 而下一個等級是系統全自動,這需要更多的法規還有硬體+軟體進步 我還是跟2020年看法一樣.電動車2025年群雄割據結束後,就會邁入下一個階段 之後就是軟體也會開始有成長期空間 2020年說要先硬體普及後才能開
Thumbnail
社群媒體對人們的負面影響與操縱已成為矽谷巨頭公司前骨幹成員討論的焦點。透過這些平臺,使用者的時間與個人資料被轉化成商品販售給廠商,因此社群媒體平臺為了獲取更多商業利益,不惜一切手段搶佔使用者的注意力。此外,社群媒體的出現導致了青少年的自殺率上升,讓人更脆弱、焦慮、憂鬱。同時,社群媒體還無形中建立同溫層,讓人無法接受外面的世界,更容易被操縱。這些市場行為和效應不僅對個人,甚至可能對國家和世界產生深遠的影響。
Thumbnail
投資理財內容聲明 文內如有投資理財相關經驗、知識、資訊等內容,皆為作者個人分享行為。 有價證券、指數與衍生性商品之數據資料,僅供輔助說明之用,不代表創作者投資決策之推介及建議。 閱讀同時,請審慎思考自身條件及自我決策,並應有為決策負責之事前認知。 希望您能從這些分享內容汲取投資養份,養成獨立
Thumbnail
聽 Manny & Angela 最新的曼報 podcast,我覺得本文標題這句話是關鍵,也引發我對軟體產業本質的思考。
Thumbnail
去年下半年開始了幾個工廠設備的監控專案顧問開發。 有別於以往比較多接觸的消費者端應用,情境確實比較不一樣。系統開發很重要的一個點是因時制宜、因地制宜,這次就算是一個很好的案例。 本篇文章紀錄一下值得分享的心得。
Thumbnail
最近收到雲門教室的面試邀請..在談銷售通路之前,要先知道年度營收目標是什麼 ( PBF - Product Business Fit )才有意義。有了年度營收目標,才能進而決定相對應的 multi-segment 市場定價策略,擬定穩定新客轉換 ( PGF - Product Growth Fit)
Thumbnail
  【寫在前面的三言二語】 新冠肺炎池持續延燒,各種的變種病毒也紛紛出籠,想要有效防堵,萬變不離其宗就是疫苗打好打滿才有防護力,人類世界如此,電腦虛擬數位科技世界更是亦然,想要免受到電腦病毒的騷擾侵襲,一定要安裝好可靠的電腦防毒軟體,全球電腦知名防毒軟體廠商-趨勢科技PC-cillin 2021 雲