4 種技術文件幫助 SaaS 公司提供更好的產品/服務體驗 (提升使用者與合作夥伴對產品的掌握度，更喜歡公司提供的產)
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瞄準真實世界中遭遇的問題，目的是幫助使用者完成某些任務。
例如要教小朋友煎出一顆荷包蛋，步驟是：
- 從冰箱取出雞蛋，先上下搖晃雞蛋，使蛋白不黏蛋殼，減少浪費
- 大火加熱平底鍋，手感應到熱度後，轉小火
- 將雞蛋置在平底鍋內
- 加入兩湯匙水
- 蓋上鍋蓋，小火煎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/ 如果你覺得文章寫的不錯，可以對文章點愛心讓我知道 ❤️
2/ 常滑 Facebook 嗎？可以幫我的 Facebook 粉絲團 按個讚，就可以看到文章啦～
3/ 想要掌握最新文章，可以點擊「追蹤」我～
4/ 如果你覺得文章寫的不錯，可以對文章點愛心讓我知道 ❤️
▶ 關於我
Software Technical writer @ OwlTing 奧丁丁集團 我專注寫
1/ SaaS 軟體產品規劃
2/ 個人知識管理
3/ 線上寫作的文章
擁有 6+ 年的SaaS產品經理工作經驗，☕️ 歡迎講座邀約、諮詢或跟我喝杯咖啡聊聊天，我的信箱是 muhenry608@gmail.com
Software Technical writer @ OwlTing 奧丁丁集團 我專注寫
1/ SaaS 軟體產品規劃
2/ 個人知識管理
3/ 線上寫作的文章
擁有 6+ 年的SaaS產品經理工作經驗，☕️ 歡迎講座邀約、諮詢或跟我喝杯咖啡聊聊天，我的信箱是 muhenry608@gmail.com
▶︎ 建立人脈
歡迎使用 LinkedIn 與我交流，你可以「加我為好友」建立連結 | LinkedIn @ Chi Chu 歡迎交流
歡迎使用 LinkedIn 與我交流，你可以「加我為好友」建立連結 | LinkedIn @ Chi Chu 歡迎交流
即將進入廣告，捲動後可繼續閱讀
為什麼會看到廣告
留言0
查看全部
你可能也想看
Google News 追蹤
隨著理財資訊的普及，越來越多台灣人不再將資產侷限於台股，而是將視野拓展到國際市場。特別是美國市場，其豐富的理財選擇，讓不少人開始思考將資金配置於海外市場的可能性。
然而，要參與美國市場並不只是盲目跟隨標的這麼簡單，而是需要策略和方式，尤其對新手而言，除了選股以外還會遇到語言、開戶流程、Ap
嘿，大家新年快樂~ 新年大家都在做什麼呢？
跨年夜的我趕工製作某個外包設計案，在工作告一段落時趕上倒數。
然後和兩個小孩過了一個忙亂的元旦。在深夜時刻，看到朋友傳來的解籤網站，興致勃勃熬夜體驗了一下，覺得非常好玩，或許有人玩過了，但還是想寫上來分享紀錄一下~
本文介紹開始烘焙前，你應該要知道的基本知識
除了介紹烘焙常見的專有名詞、動作之外，還會提供注意事項和小撇步！
本篇文章將為大家分享開始烘焙前，應該要準備好的工具，包括鋼盆、打蛋器、烤箱、烤盤、電子秤等等，讓讀者瞭解必要的設備。
這篇文章詳細介紹了烘焙新手所需要準備的各種材料，包括麵粉、油脂類、牛奶、糖類、雞蛋、泡打粉、奶油乳酪、香草精、可可粉、抹茶粉、焙茶粉、吉利丁等。這些材料的選擇和品牌使用也都有詳細介紹，對於剛開始學習烘焙的人來說非常實用。
這篇文章介紹了面試時以及開始工作後可能會遇到的問題，包括物件導向OOP、SOLID 設計原則、測試方式，以及 Cookie、Session 與 Cache 的相似處與不同處。提供了豐富的相關資訊。
不知道大家會不會有這種感覺，在使用現今的一些預訓練模型時，雖然好用，但是實際在場域部屬時總感覺殺雞焉用牛刀，實際使用下去後續又沒有時間讓你去優化它，只好將錯就錯反正能用的想法持續使用，現在有個不錯的方法讓你在一開始就可以用相對低廉的成本去優化這個模型，讓後續使用不再懊悔。
每位作者，都必須是自己的產品經理。
一篇文章就是一件產品: 產品先看包裝，文章先讀標題；產品要外觀無暇，文章要摘要大綱；產品功能要運作正常、文章上下連貫引發聯想。好產品會推薦親友、好文章會轉發朋友。
本文整理了有關技術文件寫作的重要觀念，包括 docs as a product、內容優先，並說明如何構思文件架構。
在設計有四年快五年的時間，大部分都是從實戰經驗中去不斷摸索產品開發的流程。從視覺傳達的背景出來，在用戶體驗的經驗都是在實際開發中去摸索出來的。不是理論派，只是根據我本人的經驗摸索出來的設計方法，也不會用太多高深的詞彙說明。
以前搜尋怎麼做產品設計？究竟是要從什麼步驟開始的這件事情，大部分看到的
這是一篇關於如何提升諮詢技巧的文章，內容包括了一門SCPC錄播課程的內容和推薦的4大原因。諮詢技巧在職場中十分重要，這篇文章將為你解釋為什麼需要提升你的諮詢技巧以及如何透過技術課程來達到。確保你的業務能夠成功地面對商界或學界個案
書裡面是這麼說的，如果給你一份內容詳盡的食譜，相信你也能烤出一塊美味蛋糕。但是萬一家裡沒有食譜中的食材呢？萬一你對牛奶過敏呢？如果不能深入了解食材的特色，就不知道相互影響的力量。就像學習，不能只是照做，還要知道這些方法背後隱藏著哪些原理。
隨著理財資訊的普及，越來越多台灣人不再將資產侷限於台股，而是將視野拓展到國際市場。特別是美國市場，其豐富的理財選擇，讓不少人開始思考將資金配置於海外市場的可能性。
然而，要參與美國市場並不只是盲目跟隨標的這麼簡單，而是需要策略和方式，尤其對新手而言，除了選股以外還會遇到語言、開戶流程、Ap
嘿，大家新年快樂~ 新年大家都在做什麼呢？
跨年夜的我趕工製作某個外包設計案，在工作告一段落時趕上倒數。
然後和兩個小孩過了一個忙亂的元旦。在深夜時刻，看到朋友傳來的解籤網站，興致勃勃熬夜體驗了一下，覺得非常好玩，或許有人玩過了，但還是想寫上來分享紀錄一下~
本文介紹開始烘焙前，你應該要知道的基本知識
除了介紹烘焙常見的專有名詞、動作之外，還會提供注意事項和小撇步！
本篇文章將為大家分享開始烘焙前，應該要準備好的工具，包括鋼盆、打蛋器、烤箱、烤盤、電子秤等等，讓讀者瞭解必要的設備。
這篇文章詳細介紹了烘焙新手所需要準備的各種材料，包括麵粉、油脂類、牛奶、糖類、雞蛋、泡打粉、奶油乳酪、香草精、可可粉、抹茶粉、焙茶粉、吉利丁等。這些材料的選擇和品牌使用也都有詳細介紹，對於剛開始學習烘焙的人來說非常實用。
這篇文章介紹了面試時以及開始工作後可能會遇到的問題，包括物件導向OOP、SOLID 設計原則、測試方式，以及 Cookie、Session 與 Cache 的相似處與不同處。提供了豐富的相關資訊。
不知道大家會不會有這種感覺，在使用現今的一些預訓練模型時，雖然好用，但是實際在場域部屬時總感覺殺雞焉用牛刀，實際使用下去後續又沒有時間讓你去優化它，只好將錯就錯反正能用的想法持續使用，現在有個不錯的方法讓你在一開始就可以用相對低廉的成本去優化這個模型，讓後續使用不再懊悔。
每位作者，都必須是自己的產品經理。
一篇文章就是一件產品: 產品先看包裝，文章先讀標題；產品要外觀無暇，文章要摘要大綱；產品功能要運作正常、文章上下連貫引發聯想。好產品會推薦親友、好文章會轉發朋友。
本文整理了有關技術文件寫作的重要觀念，包括 docs as a product、內容優先，並說明如何構思文件架構。
在設計有四年快五年的時間，大部分都是從實戰經驗中去不斷摸索產品開發的流程。從視覺傳達的背景出來，在用戶體驗的經驗都是在實際開發中去摸索出來的。不是理論派，只是根據我本人的經驗摸索出來的設計方法，也不會用太多高深的詞彙說明。
以前搜尋怎麼做產品設計？究竟是要從什麼步驟開始的這件事情，大部分看到的
這是一篇關於如何提升諮詢技巧的文章，內容包括了一門SCPC錄播課程的內容和推薦的4大原因。諮詢技巧在職場中十分重要，這篇文章將為你解釋為什麼需要提升你的諮詢技巧以及如何透過技術課程來達到。確保你的業務能夠成功地面對商界或學界個案
書裡面是這麼說的，如果給你一份內容詳盡的食譜，相信你也能烤出一塊美味蛋糕。但是萬一家裡沒有食譜中的食材呢？萬一你對牛奶過敏呢？如果不能深入了解食材的特色，就不知道相互影響的力量。就像學習，不能只是照做，還要知道這些方法背後隱藏著哪些原理。