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

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

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%的功能了。

raw-image

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

How-to guide瞄準真實世界中遭遇的問題,目的是幫助使用者完成某些任務。

例如要教小朋友煎出一顆荷包蛋,步驟是:

  1. 從冰箱取出雞蛋,先上下搖晃雞蛋,使蛋白不黏蛋殼,減少浪費
  2. 大火加熱平底鍋,手感應到熱度後,轉小火
  3. 將雞蛋置在平底鍋內
  4. 加入兩湯匙水
  5. 蓋上鍋蓋,小火煎6分鐘 (參考《風生活-荷包蛋別只會加油煎》)

例如 SAP 教學「 CRM 自動化銷售(Sales Automation)」的設定步驟,一步步帶使用者完成「設定」這個任務。

raw-image

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

Reference的讀者通常是非常關心產品的技術規格的人,例如開發者、技術 PM。

例如一位對食材相當考究的「食材研究者」想要了解薑的「技術規格」,像是薑的出處、功效、化學組成、要如何被烹調才能完美發揮味道…等。SaaS 公司為了合作需求,會提供 API 串接文件給合作對象閱讀串接。

在台灣例如金流業者 Tappay、綠界科技 (EC Pay)、各大銀行 ; 在國外例如開店平台 Shopify, 金流業者 Stripe, 筆記軟體 Notion…等。

raw-image

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

Explanation瞄準的是非常有好奇心的讀者,目的是幫助使用者了解產品背後的 Why 。

例如有一本《教你成為厲害的大廚》,裡頭寫了關於烹飪的各種知識,像是:

  • 為什麼我們現在是這樣烹飪?
  • 什麼是不好的烹飪方式?
  • 什麼是良好的烹飪習慣?
  • 如何提升烹飪技巧? 內容可能跟快速上手烹飪、如何煎出荷包蛋、蛋的組成成分都無關,而是將重點放在「烹飪」相關的主題討論。在技術產品的脈絡中,則是介紹產品背後的 Why 以及相關產業知識。

例如 LISK 在 Understanding Blockchain 文件區塊中,詳細的解釋區塊鏈的架構、以及開發實作上要注意的細節。

raw-image
備註: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產品經理工作經驗,☕️ 歡迎講座邀約、諮詢或跟我喝杯咖啡聊聊天,我的信箱是 muhenry608@gmail.com

▶︎ 聯繫方式
• 📪 Email:muhenry608@gmail.com
• 💬 Facebook:請先加我 個人好友 並簡短說明想要諮詢的主題

▶︎ 建立人脈
歡迎使用 LinkedIn 與我交流,你可以「加我為好友」建立連結 | LinkedIn @ Chi Chu 歡迎交流

留言
avatar-img
留言分享你的想法!
avatar-img
朱騏的沙龍
217會員
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
創作者營運專員/經理(Operations Specialist/Manager)將負責對平台成長及收入至關重要的 Partnership 夥伴創作者開發及營運。你將發揮對知識與內容變現、影響力變現的精準判斷力,找到你心中的潛力新星或有聲量的中大型創作者加入 vocus。
Thumbnail
創作者營運專員/經理(Operations Specialist/Manager)將負責對平台成長及收入至關重要的 Partnership 夥伴創作者開發及營運。你將發揮對知識與內容變現、影響力變現的精準判斷力,找到你心中的潛力新星或有聲量的中大型創作者加入 vocus。
Thumbnail
在這篇文章中,我們將介紹工作與以前念書時期在開發流程上的差異,並深入瞭解CI/CD、Travis CI以及加解密的應用。 CI/CD是自動化的軟體開發實踐,而加解密則是保護機密資料安全的重要技術。
Thumbnail
在這篇文章中,我們將介紹工作與以前念書時期在開發流程上的差異,並深入瞭解CI/CD、Travis CI以及加解密的應用。 CI/CD是自動化的軟體開發實踐,而加解密則是保護機密資料安全的重要技術。
Thumbnail
這篇文章介紹了面試時以及開始工作後可能會遇到的問題,包括物件導向OOP、SOLID 設計原則、測試方式,以及 Cookie、Session 與 Cache 的相似處與不同處。提供了豐富的相關資訊。
Thumbnail
這篇文章介紹了面試時以及開始工作後可能會遇到的問題,包括物件導向OOP、SOLID 設計原則、測試方式,以及 Cookie、Session 與 Cache 的相似處與不同處。提供了豐富的相關資訊。
Thumbnail
本文整理了有關技術文件寫作的重要觀念,包括 docs as a product、內容優先,並說明如何構思文件架構。
Thumbnail
本文整理了有關技術文件寫作的重要觀念,包括 docs as a product、內容優先,並說明如何構思文件架構。
Thumbnail
工作兩年,我已經替 5 個 SaaS 產品寫了技術文件。過程中我發現:現代人很沒耐心。5 分鐘內他不知道產品怎麼用,就會關閉網頁再找其他試用品。公司失去了一個願意付費的潛在客戶。怎麼辦呢?你需要一份 Tutorial 技術文件!這篇文章我會分享 6 個你可以用來寫技術文件的訣竅。
Thumbnail
工作兩年,我已經替 5 個 SaaS 產品寫了技術文件。過程中我發現:現代人很沒耐心。5 分鐘內他不知道產品怎麼用,就會關閉網頁再找其他試用品。公司失去了一個願意付費的潛在客戶。怎麼辦呢?你需要一份 Tutorial 技術文件!這篇文章我會分享 6 個你可以用來寫技術文件的訣竅。
Thumbnail
本文靈感來自:How to Document Your Code Like a Pro 以下範例程式均為 Python 推薦插件:better comment 前言 程式碼的有效文件化是編程最重要的部分之一 Python 提升可讀性有以下方式: 註釋 類型提示 文檔字串 這些實踐可以提高程式碼的可讀
Thumbnail
本文靈感來自:How to Document Your Code Like a Pro 以下範例程式均為 Python 推薦插件:better comment 前言 程式碼的有效文件化是編程最重要的部分之一 Python 提升可讀性有以下方式: 註釋 類型提示 文檔字串 這些實踐可以提高程式碼的可讀
Thumbnail
其實要為專案建立操作介面的方式很多,除了網頁之外,還能另外寫個專門的手機 APP 連線,或是乾脆升級算法,讓我們能隨口喊一聲「嘿OO!」就搞定,不過⋯
Thumbnail
其實要為專案建立操作介面的方式很多,除了網頁之外,還能另外寫個專門的手機 APP 連線,或是乾脆升級算法,讓我們能隨口喊一聲「嘿OO!」就搞定,不過⋯
Thumbnail
SaaS 公司提供即時、線上的軟體產品/服務,因此讓小白使用者「好上手」是非常重要的。但使用者卡關時怎麼辦?一個不用浪費公司太多人力、又能讓使用者快速排除問題的方法就是:「提供技術文件」。如果你的公司內部/產品團隊沒有專門的Technical Writer,看完這篇文章可以讓你了解 4 種產品必要的
Thumbnail
SaaS 公司提供即時、線上的軟體產品/服務,因此讓小白使用者「好上手」是非常重要的。但使用者卡關時怎麼辦?一個不用浪費公司太多人力、又能讓使用者快速排除問題的方法就是:「提供技術文件」。如果你的公司內部/產品團隊沒有專門的Technical Writer,看完這篇文章可以讓你了解 4 種產品必要的
追蹤感興趣的內容從 Google News 追蹤更多 vocus 的最新精選內容追蹤 Google News