我如何從英語教學專業 (TESOL major) 成為技術文件工程師 (Technical Writer) ？

8月 20, 2024

我如何從英語教學專業 (TESOL major) 成為技術文件工程師 (Technical Writer) ？

會接觸到這行業純粹誤打誤撞，原本是打定要當英文老師才唸英語教學所，結果唸書時，有機會在外面教美國移民英文，接觸到不論是中東、歐洲或亞洲移民，他們都比我年長非常多，人生歷練比我多，常跟我分享他們的人生故事，我才發現，我喜歡教學是因為跟這些人分享交流自己專長的事情，教育本身亦是資訊傳播，而資訊傳播不一定要透過教學才可以做到，所以畢業後，沒有去找教學相關工作，反而希望可以進入業界，找一個技術專長，透過此技術專長進行資訊傳播，最後朝著科技業中需要語言的工作尋找，而成為了 Technical writer。

進來後發現在我們公司的技術文件部門，除了來自美國、加拿大、菲律賓等外籍同事外，台灣同事背景大多來自於外文系、語言所、翻譯所、外文所等系所，公司同事同質性很高，可以作為英文相關學系就業參考。

Tech writer 在做什麼？

作為 Tech writer，不論是在跟朋友解釋，或是面試提到上一份工作時，不可避免都會問到：Tech writer 到底在做什麼？技術文件不是一般由 RD 來撰寫及維護嗎？對於這職位充滿各式各樣的想像，可能會覺得是翻譯、或寫文案的。

簡單來說，Tech writer 工作範圍可說是包含一個產品上市所需的所有技術文件，技術取向的包含 White paper、API Guide (Developer’s Guide)、Deployment Guide，一般用戶端則包含 String、Help、FAQ、Tutorial、Community post、App Store 簡介、Hardware Installation Guide、Datasheet 等，工作需要撰寫、翻譯、審閱和維護技術文件，同時會需要與負責產品管理（PM）和研發（R&D）的團隊緊密合作，將產品透過應用程式、網站和其他數位行銷方式，把相關資訊傳達給目標市場，以幫助使用者了解產品。

Tech writer 撰寫文類有哪些？

撰寫技術文件及說明書的文體不像行銷類，會避免聳動誇大，使用平實的文字風格，強調樸實才能帶來信賴感，文類分為以下幾種：

撰寫 UI 字串

使用者介面上會看到的所有文字都稱為字串，在寫作上相較於其他文類，會有最多規範，比如說依據出現情境（例如：Wizard、Dialog、modal window、下拉式選單、左側選單、Toast、Tooltip、錯誤訊息等），或是擺放位置不同（例如：標題、描述、按紐），用途不同（例如：tab、sectioncheckbox、empty state、error message），就會影響字串寫法與大小寫。

撰寫 UI Help 文章

使用者詳細的步驟式導引。架構上可分為任務導向及 UI 導向，任務導向會有一個主題，操作可能會需要跨頁面，而 UI 導向則依照 UI 分頁，介紹所有使用者可以在此頁面進行的設定。

撰寫 Tutorial 或 FAQ

可以分為定義型文章、使用教學型文章及問題解決導向文章。但無論何種導向的文章，其中心思想都是希望使用者可以藉由閱讀此文章，自行解決遇到的操作難題，不用進 support ticket。

l 定義型文章：產品功能的介紹或是技術名詞的概念原理介紹。

l 教學型文章：完整教使用者做完一件事情，可能會需要跨頁設定，比如如何建立帳戶？如何增強帳戶安全性？以 Enhance security 這主題來說，可能會去教使用者啟用雙重驗證，並檢查密碼強度。

l 問題解決型文章：回答一個使用上的常見問題，比如怎麼登不進去帳戶？忘記密碼怎麼辦？

撰寫Software Specifications

依據產品版本的規格撰寫功能細節。

撰寫User Guide、API Guide、Whitepaper

User Guide 包含產品賣點特色、系統需求、使用情境、優缺點、解法與限制。API Guide則是針對第三方開發者撰寫的手冊，裡面會提及專業的API操作。Whitepaper 涉及到比較專業的技術解說，強調產品的「為什麼」面向：為什麼以此方向設計？為什麼我們要把這設定加進服務裡？為什麼服務的設計流程為此？為什麼使用者需要這個功能？