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

閱讀時間約 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 歡迎交流
210會員
129內容數
分享學習相關的技巧、工具與方法
留言0
查看全部
發表第一個留言支持創作者!
朱騏的沙龍 的其他內容
我曾經擔任 PM 將近 6 年的時間、在新職位 - Technical Writer 工作 9 個月的時間,這篇文章分享關於「寫文件」這件事 - 包含 Technical Writer 在做些什麼、跟「產品經理(Product Manager)」的差異。如果你對軟體產業有興趣,一起來看看這篇文章吧。
卡片盒筆記法的本質,其實是記錄「想法」與「想法的脈絡」這是跟傳統大家對於「筆記」的認知最大的不同。​ ​ 我們要分辨「筆記」與「想法」兩個字,前者是資訊的記錄、後者帶有自己的思考與感觸。​ ​ 那想法的脈絡是怎麼回事呢?其實就是將一連串相似的想法 (卡片) 用清單列下來,相近的卡片因為脈絡相同,就會
在職場工作 7 年了,我發現個人對於公司的喜好其實都表現在一些小事情上。由於多數人很難說清楚這些小事情是什麼,因此當晚輩請教時,還是只能說:「你若要挑到一個好公司,就要看企業文化呀、氛圍呀、組織架構。」但這有說等於沒說呀!如果不說大詞,那我們到底怎麼找到自己對於公司的喜好呢?我發現,「寫日記」可以派
申克博士前陣子在《卡片盒筆記》繁中版線上交流會上,分享了卡片盒「是什麼 vs 不是什麼」的10點快講。這篇文章也分享我近 1 年每天在 Obsidian 大量寫卡片、列索引、想盲點、改方法後,個人認為卡片盒筆記法的「是什麼 vs 不是什麼」5點快講。
在社會上打滾將近7年了,我發現定期的自我對話是一件極度重要的事情(甚至比無止盡的學習重要)。為什麼呢?因為沒有盤點的人生是很無序的、沒有方向的、容易迷失的。我們太常關注自己沒有的,忽略自己已經做完的。這篇文章分享一個有趣的自我盤點方法,概念是參考 Amazon 內部團隊在用的 Future prod
過去我看書有個毛病,喜歡摘抄金句,覺得好有成就感啊。但過了一陣子發現:「誒等等,這件事情我不是在書中看過怎麼解決了嗎,怎麼又犯錯了呢?」「知道」跟「做到」是兩碼子事情,我知道了不代表我就能做到。我們怎麼把書中的好觀念,真的應用在生活中、改變自己的行為?答案是:用日記作為「知道」與「行動」的橋樑。
我曾經擔任 PM 將近 6 年的時間、在新職位 - Technical Writer 工作 9 個月的時間,這篇文章分享關於「寫文件」這件事 - 包含 Technical Writer 在做些什麼、跟「產品經理(Product Manager)」的差異。如果你對軟體產業有興趣,一起來看看這篇文章吧。
卡片盒筆記法的本質,其實是記錄「想法」與「想法的脈絡」這是跟傳統大家對於「筆記」的認知最大的不同。​ ​ 我們要分辨「筆記」與「想法」兩個字,前者是資訊的記錄、後者帶有自己的思考與感觸。​ ​ 那想法的脈絡是怎麼回事呢?其實就是將一連串相似的想法 (卡片) 用清單列下來,相近的卡片因為脈絡相同,就會
在職場工作 7 年了,我發現個人對於公司的喜好其實都表現在一些小事情上。由於多數人很難說清楚這些小事情是什麼,因此當晚輩請教時,還是只能說:「你若要挑到一個好公司,就要看企業文化呀、氛圍呀、組織架構。」但這有說等於沒說呀!如果不說大詞,那我們到底怎麼找到自己對於公司的喜好呢?我發現,「寫日記」可以派
申克博士前陣子在《卡片盒筆記》繁中版線上交流會上,分享了卡片盒「是什麼 vs 不是什麼」的10點快講。這篇文章也分享我近 1 年每天在 Obsidian 大量寫卡片、列索引、想盲點、改方法後,個人認為卡片盒筆記法的「是什麼 vs 不是什麼」5點快講。
在社會上打滾將近7年了,我發現定期的自我對話是一件極度重要的事情(甚至比無止盡的學習重要)。為什麼呢?因為沒有盤點的人生是很無序的、沒有方向的、容易迷失的。我們太常關注自己沒有的,忽略自己已經做完的。這篇文章分享一個有趣的自我盤點方法,概念是參考 Amazon 內部團隊在用的 Future prod
過去我看書有個毛病,喜歡摘抄金句,覺得好有成就感啊。但過了一陣子發現:「誒等等,這件事情我不是在書中看過怎麼解決了嗎,怎麼又犯錯了呢?」「知道」跟「做到」是兩碼子事情,我知道了不代表我就能做到。我們怎麼把書中的好觀念,真的應用在生活中、改變自己的行為?答案是:用日記作為「知道」與「行動」的橋樑。
你可能也想看
Google News 追蹤
Thumbnail
這個秋,Chill 嗨嗨!穿搭美美去賞楓,裝備款款去露營⋯⋯你的秋天怎麼過?秋日 To Do List 等你分享! 秋季全站徵文,我們準備了五個創作主題,參賽還有機會獲得「火烤兩用鍋」,一起來看看如何參加吧~
Thumbnail
2024/03/29美股收盤頭條|股市多頭以 4 兆美元的反彈粉碎反對者:市場總結|標準普爾 500 指數上漲至新紀錄,第一季結束
Thumbnail
【本集主題】: 斷捨離進行中,可善用好方法?【方法篇】 【本集選書】:《新斷捨離》 【作者】:山下英子 【出版社】: 平安文化 ⭐️先丟一個「人」! ⭐️拒絕「多管閒事的歐巴桑」! ⭐️自我軸!我真的「不需要」! ⭐️原來這些,早就「不適合」我了!? ⭐️不忍了!「不舒服」丟掉磨腳高跟鞋!
Thumbnail
內政部日前(10/13)發布112年第2季住宅價格指數,本季全國住宅價格指數為130.80,相較上季上漲1.51%,較去(111)年同季上漲5.51%。內政部表示從近年房價趨勢觀察,全國住宅價格指數之年增率自111年第2季高點10.27%,已連續下修4季,在本季為5.51%,房價漲勢明顯收斂趨緩。
Thumbnail
繞著「寫作」與「自我對話」兩大核心,並隨書附贈一本能夠使人馬上實作的〈自我對話筆記〉已經列好模板的小巧筆記本,作者Kankoro傳遞著透過與自己的連結與對話,能夠將重拾散落在生活與生命中的自己,那些因為過往的負面經驗、現階段的憂愁煩惱、對未來的妄想恐懼而延伸的不安與虛無感,能藉由更加客觀與寬容的第三
Thumbnail
儲能不只電池,儲熱系統更適合重工業去碳! 位於美國加州的新創公司Antora Energy,最近獲得兩大低碳技術創投機構的投資,金額達5000萬美元(約14億台幣)...
Thumbnail
對於孩子而言,上學是一件人生大事!突然和熟悉的照顧者分開,以及獨自進入陌生的環境,孩子一定會感到害怕及不安。 想讓小寶貝適應,除了需要時間之外,我們採取的做法跟態度也很重要哦~作伴分享五個小技巧,幫助孩子適應幼稚園,一起度過分離焦慮!
Thumbnail
這件事情已經有很多專家針對柔道教練的教育方式進行評論,因此詳細的部分就不用再提了,以下僅用個人的一些經驗來談談台灣(或者應該說是整個華人社會)對於“教育”的態度這件事情。
Thumbnail
連續經歷著智慧語音的科技、同事聊天的酣暢、研究文獻的晦澀,有滿滿的虛擬數位、真人對話、文字思緒之體驗感,且是在數位與真實間的連續擺盪。 最近讀了施登騰所寫的【博物館科技系列:如果博物館能說話?!(新增補版)】(https://reurl.cc/Y1zLxa),對於文中介紹能「正常」對話的「數位語音聊
Thumbnail
每到藝博又是我攀親引戚的時節,2020台中藝術博覽會是疫病爆發後,台灣第一場大型藝術博覽會,是否能帶給我們滿滿的感動呢?以觀賞者的角度選出藝博中4件我覺得有趣的作品,雖然還是口袋淺淺,掏不出任何一毛錢,沒有要幫誰廣告,因此文章等藝博結束後發(燦笑)。
Thumbnail
這個秋,Chill 嗨嗨!穿搭美美去賞楓,裝備款款去露營⋯⋯你的秋天怎麼過?秋日 To Do List 等你分享! 秋季全站徵文,我們準備了五個創作主題,參賽還有機會獲得「火烤兩用鍋」,一起來看看如何參加吧~
Thumbnail
2024/03/29美股收盤頭條|股市多頭以 4 兆美元的反彈粉碎反對者:市場總結|標準普爾 500 指數上漲至新紀錄,第一季結束
Thumbnail
【本集主題】: 斷捨離進行中,可善用好方法?【方法篇】 【本集選書】:《新斷捨離》 【作者】:山下英子 【出版社】: 平安文化 ⭐️先丟一個「人」! ⭐️拒絕「多管閒事的歐巴桑」! ⭐️自我軸!我真的「不需要」! ⭐️原來這些,早就「不適合」我了!? ⭐️不忍了!「不舒服」丟掉磨腳高跟鞋!
Thumbnail
內政部日前(10/13)發布112年第2季住宅價格指數,本季全國住宅價格指數為130.80,相較上季上漲1.51%,較去(111)年同季上漲5.51%。內政部表示從近年房價趨勢觀察,全國住宅價格指數之年增率自111年第2季高點10.27%,已連續下修4季,在本季為5.51%,房價漲勢明顯收斂趨緩。
Thumbnail
繞著「寫作」與「自我對話」兩大核心,並隨書附贈一本能夠使人馬上實作的〈自我對話筆記〉已經列好模板的小巧筆記本,作者Kankoro傳遞著透過與自己的連結與對話,能夠將重拾散落在生活與生命中的自己,那些因為過往的負面經驗、現階段的憂愁煩惱、對未來的妄想恐懼而延伸的不安與虛無感,能藉由更加客觀與寬容的第三
Thumbnail
儲能不只電池,儲熱系統更適合重工業去碳! 位於美國加州的新創公司Antora Energy,最近獲得兩大低碳技術創投機構的投資,金額達5000萬美元(約14億台幣)...
Thumbnail
對於孩子而言,上學是一件人生大事!突然和熟悉的照顧者分開,以及獨自進入陌生的環境,孩子一定會感到害怕及不安。 想讓小寶貝適應,除了需要時間之外,我們採取的做法跟態度也很重要哦~作伴分享五個小技巧,幫助孩子適應幼稚園,一起度過分離焦慮!
Thumbnail
這件事情已經有很多專家針對柔道教練的教育方式進行評論,因此詳細的部分就不用再提了,以下僅用個人的一些經驗來談談台灣(或者應該說是整個華人社會)對於“教育”的態度這件事情。
Thumbnail
連續經歷著智慧語音的科技、同事聊天的酣暢、研究文獻的晦澀,有滿滿的虛擬數位、真人對話、文字思緒之體驗感,且是在數位與真實間的連續擺盪。 最近讀了施登騰所寫的【博物館科技系列:如果博物館能說話?!(新增補版)】(https://reurl.cc/Y1zLxa),對於文中介紹能「正常」對話的「數位語音聊
Thumbnail
每到藝博又是我攀親引戚的時節,2020台中藝術博覽會是疫病爆發後,台灣第一場大型藝術博覽會,是否能帶給我們滿滿的感動呢?以觀賞者的角度選出藝博中4件我覺得有趣的作品,雖然還是口袋淺淺,掏不出任何一毛錢,沒有要幫誰廣告,因此文章等藝博結束後發(燦笑)。