[網路部落格]技術文件Writer的問題

| | | | | | 9則回應

    

第一個問題 ─ 慢，不能按照我們的期待把文件交出來。

我原以為，這問題在於 Technical Writer 太少，使得一個 Technical Writer 要負責的產品太多；如果 writer 無法分辨不同產品、專案與文件何者優先，就容易 delay。

第二個問題 ─ 自以為是，照自己的意思想法寫，而不是照事實寫。

Technical Writer 通常不是專家，因此我們都會指派幾位工程師擔任 subject matter expert (SME)，把 user documentation 先打個草稿，再交給 writer 做 editing and formatting。然而，我們常遇到的狀況是，writer 改完的東西，意思全部都變了，好像他在開 spec，要我們加上新 feature，而不是描述目前的產品長什麼樣子、該怎麼使用。

有些工程師對自己的英文沒有自信，不敢質疑 writer，以為是自己不對、人家才對，結果就把錯誤的 user documentation 送了出去。

為了克服「慢」與「自以為是」這兩個問題，我們一方面增加 writer 的人數，疏解人力不足的困境，另一方面，我們也注意工程師的英文能力，並使用 Comment-able PDF 格式，讓大家便於提出自己的意見。

但是，隨著這些改善，情況並未大幅好轉，我才發現真正的 root cause。

第三個問題，Writer 仍有嚴重的 knowledge gap，不懂我們的產品，我懷疑其因來自，他們自己不看也不用這些軟體。

因為 writer 不使用軟體，writer 不易縮小其 knowledge gap，看不懂工程師做的草稿與意見，所以 writer 還是「自以為是」，描述自己心中那個東西的樣子，而非產品實際的樣子，於是乎，rework time 還是很長；或者，writer 不敢下筆寫，要 SME 自己改到內容、文法都無誤了，writer 連 editing 都不用做了，只需要做 formatting。

我曾數度要求 writer，自己安裝幾次，看看自己有沒有辦法照著自己寫的 Installation Guide 來安裝？有沒有辦法照著自己寫的 Admin Guide 來執行一些工作？很遺憾，writer 說，「我不會」。那麼我安排 training 給你好嗎？很遺憾，writer 說，「沒時間」。怎麼會有人，能為自己沒看過、沒用過的東西寫使用手冊呢？如果 writer 依舊不看也不用，我們有辦法讓文件準時交付，改善顧客對文件的滿意度嗎？

我終於想到了改善的方法，就是自己下海做 technical writer，自己做文件。我以為，這些不看也不用的 writer，還不足以讓我為他們冠上「Technical」這個字，雖然我的英文沒那麼好，但是比之於 writer，我 technical 的含量還是高一些，至少我會看、會用、還會安裝。

※後記：有朋友要我消消氣，送來一張照片。寫錯了，就笑一笑咩！

(credit/ 喲哪桑部落格)

本[網路部落格]文章僅反映作者個人意見，不代表ZDNET立場，並已獲作者同意以CC授權轉載。原文請見：作者部落格。