Technical Writer 不只是寫產品說明書的

Technical Writer 不只是寫產品說明書的

來自專欄技術傳播那些事兒5 人贊了文章

Foreword

2018 年 3 月 28 日的時候,我和 Queeny 一起回北京大學軟體與微電子學院給在讀的學弟學妹們做了一個分享。

之後一個學妹找我諮詢論文相關的事情,因為她寫的論文是關於技術寫作的。我根據自己從事技術寫作的一些經驗和積累的知識,回答了她幾個問題。然後她跟我說,「一般的人都以為咱技術寫作就是寫說明書的,學姐有時間了可以專門寫一篇推送」。

當別人讓你解釋 Technical Writer 是幹嘛的時,回答說寫說明書的或許可以讓對方快速理解。但那只是一個方面而已,並不能涵蓋 Technical Writer 的所有工作。

Technical Writer 可能遭遇的尷尬

你有沒有遇到過不知該如何給別人解釋清楚 Technical Writer 到底是做什麼的尷尬境地?尤其是當父母或其他長輩們問起的時候……

說的多了吧,他們可能理解不了,也不想理解;說的少了吧,他們可能覺得你的工作就是干這麼點兒事兒啊。最後想想,算了,佛系回答吧~

之前跟大家分享過兩分鐘趣味解讀 Technical Writer 的一個小視頻,還附上了一個 Technical Writer 怎麼跟別人解釋自己的工作的漫畫版。

最近還在網上看到一個用 DITA 寫技術文檔的 Technical Communicator 跟別人解釋自己工作的對話,好奇的小夥伴可以去看一下。地址:techwhirl.com/integrate

你以為的不一定是真的

很多尚未進入或者剛剛進入 Technical Writer 這一行的小夥伴可能對技術寫作的種類仍然存在認知偏差,認為技術寫作就只是寫產品說明書的。同時,對 Technical Writer 這一職業本身的認識也有待刷新。

或許,用另外一個表達可以在某種程度上減輕這種認知偏差,即 Technical Communicator。

業內對這類崗位的叫法不一,Technical Writer 是相對來講比較普遍的叫法,中文叫法一般為「技術文檔工程師」,也有叫 Information Developer 或 Content Strategist 的,這樣聽起來就高大上多了有木有~

另外,這個崗位在有些公司是設立在研發部門中的。

這裡所說的技術寫作的種類 (Technical Writing Categories) 即 Technical Writer 可提供的 deliverables 的種類。

在分工很細的大外企里,Technical Writer 或許只負責某個技術寫作種類中特定部分的工作,輕易不會改變。相比之下,在其它企業尤其是創業公司里,Technical Writer 這個名稱就完全不能涵蓋實際承擔的工作了,已不能從傳統的認知去理解。

有的外企 Technical Writer 或許工作幾年也只接觸到一種類型而已;而在快速發展的技術型創業公司里,Technical Writer 就會快速接觸到多種技術寫作的類型,雖然承擔的工作內容多了,但有利於個人快速成長。

Technical Writer 到底在寫些什麼文檔

如果細數起來,Technical Writer 寫的文檔包括許多種類,這裡先跟大家分享一些常見的,你如果進入 Technical Writer 這一行很可能會接觸到的文檔類型。如下所示:

  • User Guide
  • Administrator Guide
  • Troubleshooting
  • FAQs
  • How To Guide
  • Release Notes
  • Weekly
  • White Paper
  • Case Study
  • Knowledge Base Articles
  • Training Course Materials

只看上面這些詞,或許有點一知半解。沒關係,我會在稍後的文章中對這些文檔類型做一個具體而直觀的分享。

Afterword

時代在變化,行業和崗位也在變化,所以我們要經常地刷新一下自己的認知。

很好奇 Technical Writer 小夥伴們有沒有這樣的經歷呀,覺得自己很機智地跟別人解釋了自己的工作?

歡迎留言交流哦~

你可能想讀

技術文檔誕生記 | 完整的技術寫作流程是怎樣的?

Technical Writer 日常工作中好用的小工具

技術翻譯需要有 Technical Writer 的 sense

深度解析關於技術翻譯的六個認知誤區

如何讓你的內容輸出更加專業更有設計感?

書單 | 有哪些技術傳播從業者必知必看的書籍?

有哪些適合技術傳播從業者關注的優質博客?(一)

有哪些適合技術傳播從業者關注的優質博客?(二)

經驗分享 | 來自 11 位 Technical Writer 前輩的職業發展建議(上篇)

經驗分享 | 來自 11 位 Technical Writer 前輩的職業發展建議(下篇)

英語技術文檔的標題到底該大寫還是小寫?

如何使用正則表達式批量添加和刪除字元?

Markdown:寫技術文檔、個人博客和讀書筆記都很好用的輕量級標記語言

如何為 Markdown 文件自動生成目錄?

技術寫作實例解析 | 簡潔即是美

兩分鐘趣味解讀 Technical Writer

若脫離理解,直譯得再正確又有何意?

優質譯文不應止於正確,還要 Well-Organized

寫在入職技術型創業公司 PingCAP 一個月之後

揭秘 Technical Writer 的工作環境 | 加入 PingCAP 五個月的員工體驗記

-END-

推薦閱讀:

讀書筆記到底怎麼記?其實答案超級簡單
山風入林正好眠
250條國學名句,為你的申論寫作錦上添花!
《清潔工》之六
35年憑筆吃飯,摩羯大叔村上春樹的小說寫作習慣養成術

TAG:技術 | 寫作 | 文檔 |