[職場紀錄]Technical Writer在幹嘛─卡肉的寫手冊日常
嗨！我是菜卡肉！既然名為職場走跳誌，首文當然要來分享一下卡肉我在做甚麼囉~
我目前在一家內湖的安控 (Surveillance System) 廠商擔任Technical Writer，也就是技術文件工程師。
"A technical writer is a professional writer who produces technical documentation that helps people understand and use a product or service. " from Wikipedia.
Technical Writer (以下簡稱writer) 在我們公司稱為技術文件工程師，我也有在別家公司看過"技術行銷"這種職稱，但總而言之，科技公司的writer負責的大概就是撰寫datasheet (規格書)、使用說明書等文件，偶爾還會需要拍攝或編輯教學影片。
以下先以三個階段簡單說明完成一份產品的手冊的過程，再分別詳細解說每個階段要做的事以及需要的技能。
第一個階段是新產品或新功能的demo
第二個階段是產品 / 功能試用
第三個階段則是著手進行技術文件的撰寫
1. 產品demo
首先，會由工程師跟我們展示及說明新產品或新功能的主要特點、跟之前產品的不同、以及要注意的使用事項。
在這個階段，個人認為communication skills和fast-learning都是重要的技能。
因為工程師們很常take everything for granted，會忽略一些小細節，這個時候writer就要盡可能從跟工程師溝通中，快速掌握產品資訊。我自己的做法是會用自己的話把聽到的訊息說一次給工程師聽，確認自己有聽懂他們的"火星語"，paraphrase完之後，再一次將"沒聽到的資訊"提出來詢問。
另外，由於writer做到上手後，很常身上同時有好幾個產品的手冊要寫，不可能每一次都把每個產品搞懂到透徹，因此要訓練自己能在短時間之內掌握關鍵資訊即可，除了根據工程師的demo，我有時還會自己去google一些關鍵字。
2. 產品試用
工程師demo完後，可別急著動手寫手冊。既然writer的工作是要運用文字"教會"user產品的使用方式，自己當然要先學會怎麼用啦。像我的話，如果是新的IP Camera大概就會run過一次安裝步驟；如果是影像管理軟體的新功能，也會檢視一次UI (user interface) 並且嘗試跑一次新功能的執行流程。
在這個階段，要stand in the customers' shoes，也就是站在使用者的角度去觀察哪些功能的使用步驟邏輯不那麼直觀，或者是哪些UI上的文字會令人困惑，再統一彙整問題跟工程師反應。有時候工程師會根據我們的feedback向上呈報看是否要修改UI，雖然大多時候RD已經不會再改版了(菸)，這時，就要靠writer在說明書上解釋清楚！
3. 手冊撰寫
接下來當然就要開始撰寫手冊了，在我們公司，我們是直接用英文去撰寫，而不是翻譯，換句話說主要內容都要靠自己寫出來。
也因此，英文寫作能力很重要，邏輯思考也要清楚！要用簡潔但清楚的文字，配合圖片，寫出"合理"的步驟說明，段落的編排也要循序漸進 (通常都是從hard ware寫到firmware)。
這個階段也要跟工程師密切合作，才能要到必要協助，確保文件內容正確。當然工程師個性百百種，要怎麼跟他們"交手"，就要靠經驗的累積，發展出自己一套辦法了。
此外，細心更是不可或缺，除了文法一定要正確以外，字形、間隔、整體排版也要追求一致而美觀，眉眉角角都要面面俱到。卡肉我還在試用期時，就常常因為一些小細節，反反覆覆修改很多次，所以為了避免浪費不必要的時間做修改，一定要細心細心再細心 (雖然現在的我好像也沒多細心啦)。
以上就是完成一本手冊的過程。
不過，通常這個流程要同時進行好幾次，因為忙的時候，身上會卡好幾個案子啊 (汗)
所以要培養良好的time management才能彈性因應deadline。心臟也要強一點，案子突然變成急件時也才能冷靜應對。
看到這裡，一樣英文好的你，是否也想加入writer的行業呢？擔心自己是"3C殺手"、"電腦白癡"嗎？
不用怕~像我本來也是個對科技產品沒有什麼概念的人 (雖然現在也不是懂很多) ，但我認為最重要的是要保持open-minded，以及肯學的態度！一開始就勇敢地從公司最基本的產品動手去玩玩看，有問題就提出來，在新手階段，多問一定不吃虧。
以上，就是卡肉的寫手冊日常！
跟卡肉一樣是英語系畢業的朋友或者是English native speaker，若想要進入科技業工作，不妨試試看從Technical Writer開始。
希望之後能再多多紀錄職場生活以及分享找工作的經驗 (對自己信心喊話)
我目前在一家內湖的安控 (Surveillance System) 廠商擔任Technical Writer，也就是技術文件工程師。
"A technical writer is a professional writer who produces technical documentation that helps people understand and use a product or service. " from Wikipedia.
Technical Writer (以下簡稱writer) 在我們公司稱為技術文件工程師，我也有在別家公司看過"技術行銷"這種職稱，但總而言之，科技公司的writer負責的大概就是撰寫datasheet (規格書)、使用說明書等文件，偶爾還會需要拍攝或編輯教學影片。
以下先以三個階段簡單說明完成一份產品的手冊的過程，再分別詳細解說每個階段要做的事以及需要的技能。
第一個階段是新產品或新功能的demo
第二個階段是產品 / 功能試用
第三個階段則是著手進行技術文件的撰寫
1. 產品demo
首先，會由工程師跟我們展示及說明新產品或新功能的主要特點、跟之前產品的不同、以及要注意的使用事項。
在這個階段，個人認為communication skills和fast-learning都是重要的技能。
因為工程師們很常take everything for granted，會忽略一些小細節，這個時候writer就要盡可能從跟工程師溝通中，快速掌握產品資訊。我自己的做法是會用自己的話把聽到的訊息說一次給工程師聽，確認自己有聽懂他們的"火星語"，paraphrase完之後，再一次將"沒聽到的資訊"提出來詢問。
另外，由於writer做到上手後，很常身上同時有好幾個產品的手冊要寫，不可能每一次都把每個產品搞懂到透徹，因此要訓練自己能在短時間之內掌握關鍵資訊即可，除了根據工程師的demo，我有時還會自己去google一些關鍵字。
2. 產品試用
工程師demo完後，可別急著動手寫手冊。既然writer的工作是要運用文字"教會"user產品的使用方式，自己當然要先學會怎麼用啦。像我的話，如果是新的IP Camera大概就會run過一次安裝步驟；如果是影像管理軟體的新功能，也會檢視一次UI (user interface) 並且嘗試跑一次新功能的執行流程。
在這個階段，要stand in the customers' shoes，也就是站在使用者的角度去觀察哪些功能的使用步驟邏輯不那麼直觀，或者是哪些UI上的文字會令人困惑，再統一彙整問題跟工程師反應。有時候工程師會根據我們的feedback向上呈報看是否要修改UI，雖然大多時候RD已經不會再改版了(菸)，這時，就要靠writer在說明書上解釋清楚！
3. 手冊撰寫
接下來當然就要開始撰寫手冊了，在我們公司，我們是直接用英文去撰寫，而不是翻譯，換句話說主要內容都要靠自己寫出來。
也因此，英文寫作能力很重要，邏輯思考也要清楚！要用簡潔但清楚的文字，配合圖片，寫出"合理"的步驟說明，段落的編排也要循序漸進 (通常都是從hard ware寫到firmware)。
這個階段也要跟工程師密切合作，才能要到必要協助，確保文件內容正確。當然工程師個性百百種，要怎麼跟他們"交手"，就要靠經驗的累積，發展出自己一套辦法了。
此外，細心更是不可或缺，除了文法一定要正確以外，字形、間隔、整體排版也要追求一致而美觀，眉眉角角都要面面俱到。卡肉我還在試用期時，就常常因為一些小細節，反反覆覆修改很多次，所以為了避免浪費不必要的時間做修改，一定要細心細心再細心 (雖然現在的我好像也沒多細心啦)。
以上就是完成一本手冊的過程。
不過，通常這個流程要同時進行好幾次，因為忙的時候，身上會卡好幾個案子啊 (汗)
所以要培養良好的time management才能彈性因應deadline。心臟也要強一點，案子突然變成急件時也才能冷靜應對。
看到這裡，一樣英文好的你，是否也想加入writer的行業呢？擔心自己是"3C殺手"、"電腦白癡"嗎？
不用怕~像我本來也是個對科技產品沒有什麼概念的人 (雖然現在也不是懂很多) ，但我認為最重要的是要保持open-minded，以及肯學的態度！一開始就勇敢地從公司最基本的產品動手去玩玩看，有問題就提出來，在新手階段，多問一定不吃虧。
以上，就是卡肉的寫手冊日常！
跟卡肉一樣是英語系畢業的朋友或者是English native speaker，若想要進入科技業工作，不妨試試看從Technical Writer開始。
希望之後能再多多紀錄職場生活以及分享找工作的經驗 (對自己信心喊話)
板主你好，我是t大外文系的學生，目前大四。暫時沒有打算升學，因為想趕快工作還學貸。最近一個月開始積極找工作，發現technical writer 這個感覺滿有挑戰的行業。可是感覺公司不喜歡用新鮮人？投了蠻多也只有一間面試邀約…嗚嗚
回覆刪除啊啊啊啊啊我是想問除了寫作之外多學些甚麼是不是對進入這行業有幫助？
刪除你好，對technical writer有興趣的話，除了加強寫作能力外，個人覺得是邏輯耶(debate課蠻好用XD)，寫說明書邏輯一定要夠清楚，寫出來的instruction才能簡單明瞭；另外，真的有興趣的話，可以多去了解你有興趣的科技產品的相關知識。真要說學甚麼技能的話，大概是剪影片軟體跟例如photoshop等製圖修圖軟體吧，因為很常會要配合圖片說明，或者拍攝教學影片。不過，就當我雞婆好了，認真覺得不用擔心投了很多只有一間面試邀約喔，千萬別病急亂投醫，趁畢業前多方找找吧，現在這年頭公司都愛即戰力，不過新鮮人只要耐著性子多投多找還是會有機會的，我個人投過履歷的大概都不下50家吧，慢慢就會有面試邀約接著來了；建議只要看到要求經驗三年以下的都可以試試看。technical writer這職業我覺得很看個性，如果同學你的個性比較活潑喜歡跟人互動的話，這職業可能只能當跳板吧，~當然如果真的有興趣，很多公司都有類似職缺，就都投投看囉~祝你求職順利！
刪除Hello卡肉您好，
刪除想請問關於技術文件的內容，
身為一位非理工科出身的writer，怎麼知道要寫那些呢?
譬如我知道基本的Spec.、Dimension一定要寫，
但還有沒有其他的東西是業界都知道是必寫的呢?
像是安裝/拆解步驟之類的，就是由RD講解後再轉為人人看得懂的簡潔英文，
但我現在連一份文件該有哪些章節或要寫什麼都不知道....，
雖然有跟PM討論過並也確認了，
但還是被主管質疑: 「你確定內容只有這樣嗎?/只有這些嗎?還可以再寫更多一點嗎?」
(OS: 啊不就把電腦cable插對孔而已嗎...)
不曉得您是怎麼決定內容的?或是有哪些硬體的課程可以提供我去學習的?
謝謝您~
Hi Sirloin,
刪除抱歉晚回覆～現在才看到留言><
我比較好奇所以你是貴單位有史以來唯一一個writer嗎？
是否有前人的範例可以參考？
因為不可諱言的，我進去公司後一開始都要先參考之前的說明書，甚至要先模仿，不然整個風格跟文筆怕會太有自己風格ＬＯＬ
至於主管質疑，會不會是需要寫細一點？因為就我印象，有些我們覺得理所當然的可能user都會蠢到不知道，cable插錯孔，甚至哪條cable之類的？
因為不太確定您的產品故無法給具體建議，但或許可以更細節處理，例如插孔之前，會不會需要先關機（或先開機）之類的細節
雖然已經離開technical writer許久，不過就我的印象中，
說明書部分，
1. 一開始一定是先有一個大綱，該產品特色大綱
2. 再來是產品開箱ＸＤ 就是說一個產品會附給客戶的東西，產品主體跟是否有配件等等
3. 接著外觀的overview，以及如果該產品可以拆開，包含內部大致的overview
4. 硬體安裝
5.是否需要軟體安裝
6. 產品功能使用方式，例如進入ＵＩ之後的使用之類
7.主要是這樣，看有沒有啥備註
我一開始也是很常被問說只有這些嗎ＸＤ但後來遇到客服工程師回報需要我們新增進去說明書才發現user可能比我們想像還要呆ＸＤＤ
所以可以每個步驟詳細的想一遍，或許有幫助
Hi 卡肉您好，
刪除1. 貴單位有史以來唯一一個writer→是的，因此職位是公司新開缺，故之前無前人範本。
2. 主管質疑，會不會是需要寫細一點？因為就我印象，有些我們覺得理所當然的可能user都會蠢到不知道，cable插錯孔，甚至哪條cable之類的？
→好像也不是這點，因為這個在precaution或每個步驟的note都會寫出來。譬如今天我寫了10個章節，但主管會覺得是否要再多寫到11or12個章節，但問主管要新增什麼章節他也說不上來，反而是對於表格長、寬、高幾公分、表格顏色、圖與照片的清晰度很挑剔。(OS: 這不是重點吧??)
3. 您說的六步驟，我也是這樣寫的，因為參考過別家的manual也大概是這些步驟(章節)
其實在寫文件前都有參考過競爭對手、相關廠商的範本，但還是深怕...自己是否遺漏了什麼? 而且....我們公司沒有客服工程師，所以好像也很難得到客戶的反饋。
以上大概就是讓人懊惱的部分，最懊惱的是第二點XD(要挑剔也要講出那些點啊!)
Sirloin你好，收到你的回覆深深覺得你不容易
刪除關於第二點我倒是很有感觸，我一開始也是覺得在意那些細節有點煩躁，不過後來慢慢調整讓表格間距都一致，圖片也特別拍特別修圖，看到手冊一字排開都整整齊齊，高質感的樣子會讓自己很有成就感，因為高質感的內容也要搭配高質感的風格呀～
不過當然如果你們的說明書不是那麼偏對外用的可能就不用那麼在意
不過我很好奇沒有客服工程師且writer是新職缺，會不會貴司對於客戶端的維持比較特別，例如不是2C?
我想表達是或許可以觀察一下從業務端跟工程師端之類的，觀察貴司客戶的類型跟客戶經營的方針，或許可以對於writer業務有一些靈感
以上共勉之
希望我們都能在現在的position持續精進！
卡肉