4 種技術文件幫助 SaaS 公司提供更好的產品/服務體驗 (提升使用者與合作夥伴對產品的掌握度，更喜歡公司提供的產)

朱騏
朱騏
發佈於PM 的學習力工具箱
2022/07/29閱讀時間約 5 分鐘
SaaS 公司提供即時、線上的軟體產品/服務，因此讓小白使用者「好上手」是非常重要的。
但使用者卡關時怎麼辦？一個不用浪費公司太多人力、又能讓使用者快速排除問題的方法就是：「提供技術文件」。
當公司能提供好的文件時，使用者對產品的掌握度提高，也會更喜歡公司提供的產品與服務。但是技術文件的內容很多啊，技術文件要如何建立一個好的文件架構呢？這篇文章分享 Divio 提出的文件架構，它將技術文件分成 4 種，小至 1 人維護的 SideProject、大至使用者數百萬人的 Gitlab 服務都能夠使用。
如果你的公司內部/產品團隊沒有專門的Technical Writer，看完這篇文章可以讓你了解 4 種產品必要的技術文件。
（註解：Divio是專門提供技術文件寫作與部署服務的SaaS公司）

技術文件區分成哪4種？

Divio 將文件分成 Tutorial, How-to guide, Reference 跟 Explanation。
4種技術文件的長相與目的完全不同。簡單說：
  • Tutorial ：讓使用者快速上手產品
  • How-to guide：幫助使用者達成某個任務
  • Reference：提供詳細的產品技術規格
  • Explanation：讓使用者理解產品的背景與概念
區分這4者的文件內容，能讓使用者找資訊時更方便。

1.Tutorials : 讓使用者快速上手產品

Tutorials（教學）瞄準的對象是超級新手、第一次使用產品的人。
想像我們在教一個小朋友下廚。教小孩煮什麼並不重要，重要的是讓他知道在廚房裡要注意些什麼、享受做菜的樂趣，最後成功做出一道菜（例如自己煎出荷包蛋！）。關鍵是「建立一些簡單的任務，讓使用者試著去完成看看」。
例如 Mac 上的軟體- Raycast 讓使用者快速完成 5 -10 個小任務，就學會產品80%的功能了。

2.How to guide：幫助使用者達成某個任務

How-to guide瞄準真實世界中遭遇的問題，目的是幫助使用者完成某些任務。
例如要教小朋友煎出一顆荷包蛋，步驟是：
  1. 從冰箱取出雞蛋，先上下搖晃雞蛋，使蛋白不黏蛋殼，減少浪費
  2. 大火加熱平底鍋，手感應到熱度後，轉小火
  3. 將雞蛋置在平底鍋內
  4. 加入兩湯匙水
  5. 蓋上鍋蓋，小火煎6分鐘 （參考《風生活-荷包蛋別只會加油煎》）
例如 SAP 教學「 CRM 自動化銷售（Sales Automation）」的設定步驟，一步步帶使用者完成「設定」這個任務。

3.Reference：提供詳細的產品技術規格

Reference的讀者通常是非常關心產品的技術規格的人，例如開發者、技術 PM。
例如一位對食材相當考究的「食材研究者」想要了解薑的「技術規格」，像是薑的出處、功效、化學組成、要如何被烹調才能完美發揮味道…等。SaaS 公司為了合作需求，會提供 API 串接文件給合作對象閱讀串接。
在台灣例如金流業者 Tappay、綠界科技 (EC Pay)、各大銀行 ; 在國外例如開店平台 Shopify, 金流業者 Stripe, 筆記軟體 Notion…等。

4.Explanation：讓使用者理解產品的背景與概念

Explanation瞄準的是非常有好奇心的讀者，目的是幫助使用者了解產品背後的 Why 。
例如有一本《教你成為厲害的大廚》，裡頭寫了關於烹飪的各種知識，像是：
  • 為什麼我們現在是這樣烹飪？
  • 什麼是不好的烹飪方式？
  • 什麼是良好的烹飪習慣？
  • 如何提升烹飪技巧？ 內容可能跟快速上手烹飪、如何煎出荷包蛋、蛋的組成成分都無關，而是將重點放在「烹飪」相關的主題討論。在技術產品的脈絡中，則是介紹產品背後的 Why 以及相關產業知識。
例如 LISK 在 Understanding Blockchain 文件區塊中，詳細的解釋區塊鏈的架構、以及開發實作上要注意的細節。
備註：LISK是一家區塊鏈SaaS 公司，提供開發者 SDK 與現成開發工具、目標是幫助開發者快速打造區塊鏈的應用程式
在寫技術文件的時候，清楚地區分 4 種文件可以提升溝通效果。
不同的目標讀者能夠 (1) 快速 (2) 讀到符合需求的文件 (3)不會迷失在複雜的文件資訊中。
公司若沒有專門的 Technical Writer，可以參考 4 種文件的架構建立清楚的產品文件。
喜歡我的文章嗎？以下是更多關於我的資訊。
▶ 關於文章
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
查看全部
發表第一個留言支持創作者！