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

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

我曾經擔任 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
留言分享你的想法!
Thomas Tang-avatar-img
2022/07/22
把技術語言翻譯成大家看得懂的文字,相當不容易啊
朱騏-avatar-img
發文者
2022/07/29
其實工作的內容跟 PM 有點像,只是比較專注在寫成「文件」XD
avatar-img
朱騏的沙龍
216會員
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
TOMICA第一波推出吉伊卡哇聯名小車車的時候馬上就被搶購一空,一直很扼腕當時沒有趕緊入手。前陣子閒來無事逛蝦皮,突然發現幾家商場都又開始重新上架,價格也都回到正常水準,估計是官方又再補了一批貨,想都沒想就立刻下單! 同文也跟大家分享近期蝦皮購物紀錄、好用推薦、蝦皮分潤計畫的聯盟行銷!
Thumbnail
TOMICA第一波推出吉伊卡哇聯名小車車的時候馬上就被搶購一空,一直很扼腕當時沒有趕緊入手。前陣子閒來無事逛蝦皮,突然發現幾家商場都又開始重新上架,價格也都回到正常水準,估計是官方又再補了一批貨,想都沒想就立刻下單! 同文也跟大家分享近期蝦皮購物紀錄、好用推薦、蝦皮分潤計畫的聯盟行銷!
Thumbnail
每年4月、5月都是最多稅要繳的月份,當然大部份的人都是有機會繳到「綜合所得稅」,只是相當相當多人還不知道,原來繳給政府的稅!可以透過一些有活動的銀行信用卡或電子支付來繳,從繳費中賺一點點小確幸!就是賺個1%~2%大家也是很開心的,因為你們把沒回饋變成有回饋,就是用卡的最高境界 所得稅線上申報
Thumbnail
每年4月、5月都是最多稅要繳的月份,當然大部份的人都是有機會繳到「綜合所得稅」,只是相當相當多人還不知道,原來繳給政府的稅!可以透過一些有活動的銀行信用卡或電子支付來繳,從繳費中賺一點點小確幸!就是賺個1%~2%大家也是很開心的,因為你們把沒回饋變成有回饋,就是用卡的最高境界 所得稅線上申報
Thumbnail
這是 30 天寫作挑戰的第 29 天。今天換個視角來分享:工程師要怎麼和 PM 解釋技?
Thumbnail
這是 30 天寫作挑戰的第 29 天。今天換個視角來分享:工程師要怎麼和 PM 解釋技?
Thumbnail
近期剛好擔任資訊種子培訓計畫的職涯 Mentor,開始思考如何從 0 到 1 培養一位對產品經理有興趣的學員,以下我會分成職涯規劃、學習路徑、成長飛輪來分享我的帶領方式。
Thumbnail
近期剛好擔任資訊種子培訓計畫的職涯 Mentor,開始思考如何從 0 到 1 培養一位對產品經理有興趣的學員,以下我會分成職涯規劃、學習路徑、成長飛輪來分享我的帶領方式。
Thumbnail
如何讓一個產品誕生:S/W RD S/W RD是Software 工程師(軟體工程師)的意思。在講今天的”軟體工程師”之前,先聊一聊大家心目中的軟體工程師在做的是什麼事?寫APP,大概是一個第一直覺會產生的印象。寫遊戲軟體,這也是一種印象。大概很多在大學時代修習資訊或計算機相關科系的人不少在選系之前
Thumbnail
如何讓一個產品誕生:S/W RD S/W RD是Software 工程師(軟體工程師)的意思。在講今天的”軟體工程師”之前,先聊一聊大家心目中的軟體工程師在做的是什麼事?寫APP,大概是一個第一直覺會產生的印象。寫遊戲軟體,這也是一種印象。大概很多在大學時代修習資訊或計算機相關科系的人不少在選系之前
Thumbnail
這篇文章將會講述企劃的技術面和知識面,從硬知識到軟知識的介紹。
Thumbnail
這篇文章將會講述企劃的技術面和知識面,從硬知識到軟知識的介紹。
Thumbnail
產品經理需要的技能非常多樣且複雜。跨團隊合作、產品定義、溝通、利害關係人管理等…。其中最重要的,就是對產品的核心思想。
Thumbnail
產品經理需要的技能非常多樣且複雜。跨團隊合作、產品定義、溝通、利害關係人管理等…。其中最重要的,就是對產品的核心思想。
Thumbnail
我曾經擔任 PM 將近 6 年的時間、在新職位 - Technical Writer 工作 9 個月的時間,這篇文章分享關於「寫文件」這件事 - 包含 Technical Writer 在做些什麼、跟「產品經理(Product Manager)」的差異。如果你對軟體產業有興趣,一起來看看這篇文章吧。
Thumbnail
我曾經擔任 PM 將近 6 年的時間、在新職位 - Technical Writer 工作 9 個月的時間,這篇文章分享關於「寫文件」這件事 - 包含 Technical Writer 在做些什麼、跟「產品經理(Product Manager)」的差異。如果你對軟體產業有興趣,一起來看看這篇文章吧。
Thumbnail
產品開發是產品部工作的一部份,不過還有很多很多其他的瑣事。 -產品部的生活,就是這麼樸實無華 -魔鬼藏在細節中。 -如何化被動為主動 -年度Line review -以新制舊,以舊避險
Thumbnail
產品開發是產品部工作的一部份,不過還有很多很多其他的瑣事。 -產品部的生活,就是這麼樸實無華 -魔鬼藏在細節中。 -如何化被動為主動 -年度Line review -以新制舊,以舊避險
Thumbnail
大家好,我是月刊寫手 S 子。因為上一篇被方格子選中了,士氣大振,忍不住就開始燃燒殘存的生命力,分享最近看到的產品團隊新職種:PMM。
Thumbnail
大家好,我是月刊寫手 S 子。因為上一篇被方格子選中了,士氣大振,忍不住就開始燃燒殘存的生命力,分享最近看到的產品團隊新職種:PMM。
Thumbnail
我發現雖然很多公司都把碼字的工種直接叫做文案。但事實上文案、編輯、內容運營是不一樣的工種,各自工作的側重點也不同。雖然在實際工作中,一個碼字的人經常會同時涉及到這三個工種的工作,但是做的時候不做具體區分,就會陷入只是做,卻不知道為什麼要這麼做的尷尬境地。 那到底這三個工作有什麼區別呢?
Thumbnail
我發現雖然很多公司都把碼字的工種直接叫做文案。但事實上文案、編輯、內容運營是不一樣的工種,各自工作的側重點也不同。雖然在實際工作中,一個碼字的人經常會同時涉及到這三個工種的工作,但是做的時候不做具體區分,就會陷入只是做,卻不知道為什麼要這麼做的尷尬境地。 那到底這三個工作有什麼區別呢?
Thumbnail
「技術寫作」也是文字工作者的一條出路,只是比較少為人知。
Thumbnail
「技術寫作」也是文字工作者的一條出路,只是比較少為人知。
追蹤感興趣的內容從 Google News 追蹤更多 vocus 的最新精選內容追蹤 Google News