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

2022/07/22閱讀時間約 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產品經理工作經驗,☕️ 歡迎講座邀約、諮詢或跟我喝杯咖啡聊聊天,我的信箱是 [email protected]
▶︎ 聯繫方式
• 📪 Email:[email protected]
• 💬 Facebook:請先加我 個人好友 並簡短說明想要諮詢的主題
▶︎ 建立人脈
歡迎使用 LinkedIn 與我交流,你可以「加我為好友」建立連結 | LinkedIn @ Chi Chu 歡迎交流
朱騏
朱騏
線上寫作教練,擁有 6 年的 SaaS 產品經理 & 2 年軟體技術寫手工作經驗。我專注寫 (1)技術寫作 (2)數位寫作 (3) 個人知識管理的文章 🤝 歡迎講座邀約、諮詢,可參考 www.chichu.co/training
留言0
查看全部
發表第一個留言支持創作者!