學會這 4 種技術文件，可以幫助你的公司產品變得更易使用 | 專家論點【朱騏】

上篇文章 我提到了技術文件可以簡單分為 4 種 :

• Tutorial ：讓使用者快速上手產品
• How-to guide：幫助使用者達成某個任務
• Reference：提供詳細的產品技術規格
• Explanation：讓使用者理解產品的背景與概念

我已經對 Tutorial 做了介紹，這篇文章我們把剩下 3 種說完。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

備註：LISK是一家區塊鏈SaaS 公司，提供開發者 SDK 與現成開發工具、目標是幫助開發者快速打造區塊鏈的應用程式

這裡想問問大家，你在生活周遭有沒有看過這 4 種文件呢 ? 歡迎留言討論唷！

瀏覽 1,011 次