不知道產品技術文件怎麼寫？ 分享 4 種 Technical Writer 常用的文件| 專家論點【朱騏】

SaaS 公司提供即時、線上的軟體產品/服務，因此讓小白使用者「好上手」是非常重要的。

但使用者卡關時怎麼辦？一個不用浪費公司太多人力、又能讓使用者快速排除問題的方法就是：「提供技術文件」。

當公司能提供好的文件時，使用者對產品的掌握度提高，也會更喜歡公司提供的產品與服務。但是技術文件的內容很多啊，技術文件要如何建立一個好的文件架構呢？這裡分享 Divio 提出的文件架構，它將技術文件分成 4 種，小至 1 人維護的 SideProject、大至使用者數百萬人的 Gitlab 服務都能夠使用。

4種技術文件的長相與目的完全不同。簡單說：

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

這禮拜先分享第一種文件 – Tutorial。

Tutorials（教學）瞄準的對象是超級新手、第一次使用產品的人。

想像我們在教一個小朋友下廚。教小孩煮什麼並不重要，重要的是讓他知道在廚房裡要注意些什麼、享受做菜的樂趣，最後成功做出一道菜（例如自己煎出荷包蛋！）。關鍵是「建立一些簡單的任務，讓使用者試著去完成看看」。

例如 Mac 上的軟體- Raycast 讓使用者快速完成 5 -10 個小任務，就學會產品80%的功能了。

你還有看過哪些產品的 Tutorial 呢？歡迎在下方分享唷！

瀏覽 4,129 次