你的公司有提供「對外」的產品文件給使用者參考嗎? | 專家論點【朱騏】

Hi 大家好,我是朱騏​

▋簡單自我介紹​

我過往的工作經驗都是在 SaaS 軟體產業,曾經擔任 PM 將近 6 年的時間、在新職位 — Technical Writer 工作也已經快 9 個月的時間,這篇文章想跟大家討論關於「寫產品文件」這件事情。​

歡迎來看看我的自我介紹更認識我​

https://www.technice.com.tw/profession/​

▋公司的「產品文件」很重要!​

公司的產品文件可以簡單分為「對外」以及「對內」,這篇文章先來講「對外」的文件。​

什麼是「對外」的產品文件呢?簡單說,就是替公司的產品寫一份「攻略本」。攻略本是電玩產業的詞,能幫助新手玩家快速學會操作方法、了解遊戲目標,接著就可以比較開心的在遊戲的世界中玩耍。​

在職位分工比較細的軟體公司中,會特別將「對外」的產品文件交給Technical Writer (技術寫手) 來做,他們寫作的內容就稱為「技術寫作( Technical Writing )」。這種文件有以下的功用 :​

  • 能夠引導消費者更好地使用公司產品
  • 可以視為公司品牌、產品使用體驗的一環
  • 能影響消費者對於公司產品的整體觀感。(想想看,如果你今天使用一款複雜的電器產品,但沒有說明書應該會很崩潰吧!)​

這就像「攻略本」會先告訴新手玩家基本的操作方法,讓玩家在別在超大的遊戲世界中不知所措的亂跑、被怪打死而感到挫折(可能一開始連「基礎戰鬥知識」都沒有就跑出新手村)。好的技術文件,應該能夠把公司產品複雜的功能與規格,在適當的時間點、用適當的方式告訴使用者。​

想問問大家,你目前待的公司、或你知道哪些公司有提供「對外產品文件」給使用者參考呢?

瀏覽 1,603 次

覺得不錯的話就分享出去吧!

5 Comments

  1. 經過原PO簡單易懂的解釋了解對外的產品文件意思了XDD

    遊戲攻略本超直白~說明書真的要簡單易懂才能解決使用者問題!

    想請問原PO擔任 Technical Writer是否有什麼樣的條件具備?

  2. 我從使用者的角度來談,買個電子產品,

    如果是默默無聞公司出的,可能是 (1)一張很簡陋的圖示說明 (2)直接印在產品外盒上。

    跨國大公司這點做得比較好些,買個消費性電子產品,通常會有一疊(或一本)產品說明書。

    不過,有的時候厚厚一本,裡面各國語系都有,翻到繁體中文部分還是很簡陋。

  3. 就我所知,台灣很多電腦零組件公司是有專門團隊負責「產品攻略」的,有些甚至還分成不同語系,不過這也造成一個問題,就是產出的東西不夠精準,很多用語都是模稜兩可,讓使用者有看沒有懂。

    所以比較好的作法誠如您所言,由PM甚至是測試工程師來執筆是最佳的,但相對會增加這兩個部門的工作量,我還曾經聽某位工程師說:如果我會寫文章,就換我來PM就好啦!!!

  4. 謝謝以上大家的留言,下面我針對「擔任 Technical Writer是否有什麼樣的條件具備?」做回答。

    Technical Writier 的價值來自用簡單、直白的語言來解釋複雜的技術。

    多數的開發者在寫文件的時候,容易從非常技術的角度撰寫文件 – 多數狀況是「只解釋程式功能,但不解釋程式對於使用者的目的」。由於程式往往有自己的商業邏輯(例如建立訂單的流程、訂單對帳與請款的方式),使用者在不清楚商業邏輯的前提下直接閱讀,往往一頭霧水。

    Technical Writer 就是要來解決這個問題。

    這個職位結合「內容寫作 (Content writing)」和「技術寫作 (Technical Writing)」的專業,可以將硬梆梆的技術內容、轉換成一般使用者也能好理解的技術+商業內容。

    因此我們可以從這兩大面向切入討論。

    ▋在「內容寫作」上

    •敘事能力:使用直白的語言、舉體的例子清楚地敘述一件事情

    •編輯能力:將文章內容編排的容易閱讀

    •圖解能力:許多概念用文字非常難表達清楚,此時簡單的圖解 (例如流程圖) 能夠協助讀者快速理解概念

    ▋在「技術寫作」上

    •資訊整理能力:自己要能搜集與整理所有可以用到的內容、順好邏輯,才能寫出簡單易讀、流程清楚的文章

    •技術能力:除了要跟工程師溝通之外,自己也需要具備基礎的技術能力,例如使用 Github 管理文件版本 (version control)

    •組織能力:一份文件的內容組織方式決定了讀者的閱讀體驗

    以上是我認為一位 Technical Writer 需要具備的 6 種能力,謝謝提問 !

發佈留言

Back to top button