初入行的技術寫作者還需要了解的幾件事

這是《技術寫作從入門到“轉行”》系列文章之一。本系列文章還包括:《技術寫作職業入門記》、《技術寫作必備軟硬技能》、《從技術寫作到創意寫作,那么遠,這么近!》。以上文章可在我的簡書文章中查看。說一下這個系列文章的寫作初衷吧。

技術寫作這一行,一晃就干了七年。回頭去看,這段經歷居然也有適應期、熱戀期、平淡期和七年之癢。當一個周期結束,一切歸于平靜之后,挺想把這段經歷記錄下來。一則留作紀念。二則,常常會遇到初入行或者單兵作戰的同行。他們其中許多如同我當年一樣,有點迷茫,不太清楚努力的方向。的確,在國內,這個職業還是太冷門,無論是從業者還是學習資料都相對少的很。所以,作為過來人,我想我或許可以輸出一點東西,雖不是什么高深理論,但至少都是實戰經驗。希望能給初入行的同行們一點參考一點啟發,其中不足之處,也歡迎指正。

這篇文章的關鍵詞依然是“入門”,主要想分享一下除了必備的軟硬技能之外,初入行的技術寫作者還需要了解的幾件事。

三類技術寫作者,從你最適合的那一類開始

幾年前的一個夏天,我們正在招聘一名中文技術文檔工程師。此時,有一名應屆生通過微博和QQ群聯系上我,表示對我們的職位很感興趣。經過簡單的面談,我發現這位同學的英文水平不錯,查閱英文技術資料肯定沒有問題;從簡歷的寫作和談話過程來看,中文表達也沒有問題;她有半年的技術寫作實習經歷,這屬于加分項;她很主動,有強烈的學習愿望;可以通過公司招聘信息中的公司名稱從QQ群和微博找到我,說明她具備我在上篇文章中說到的資料獲取能力和即將要在這篇文章談到的走到互聯網上去,找到自己的同行圈子的意識。

唯一一點讓我感到有些猶豫的是,專業相關的技術知識點基本沒回答上來,但考慮到她的專業也屬于對口專業,認為她在需要用到相關知識的時候補一下應該問題不大。于是發了offer。試用期的三個月,小姑娘確實表現出來對產品功能知識點理解的吃力,但是她非常認真,也很用功,團隊合作的也很愉快。鑒于此,在轉正答辯環節,我主動保她通過,領導也尊重了我的意見。可是,在后來的幾個月中,作為正式員工,工作量和工作難度的增加,她的困難越發明顯。半年后,她提出了離職。我們在最后的面談中談到了她的優勢——英語,之前的技術寫作實習也是以英譯漢為主的本地化工作,所以,我們當時以技術為核心的中文技術寫作對她來說,不是最合適的選擇。

這是我在培養新人的過程中遇到的一個典型的失敗案例。猶記得當時因為此事引發的一種挫敗感而耿耿于懷了好一陣子。反思后得出結論,提示初入行者——目前,國內技術寫作從業者主要有以下三類(其他語種的寫作和翻譯此處暫且忽略),請結合自身優勢和劣勢,選擇你最適合最擅長的那一類開始。不用拼命去補自己的短板,在當今這個機會多變化快的社會,完全可以避開自己的短板,充分用好自己的長板,發揮自己的長處,讓長更長,讓優秀更優秀,依然可以有自己的優勢。

1,中文技術寫作:在國內多數企業中,這類技術寫作者都屬于必備類別。這類技術寫作一般要求從業者具備相關技術專業背景,可以快速學習產品相關的技術知識,具備流暢的中文表達能力,英文水平可以查閱相關技術資料。

2,英文技術寫作:這類技術寫作者主要任職于國內的外企和第三方專業提供技術文檔服務的公司。這類技術寫作要求從業者具備流暢的中英文書面表達和口語溝通能力,可以理解產品知識。

3,英文技術翻譯:這類技術寫作者同樣分布在國內的一些企業,一般和中文技術寫作者配合工作。一般要求從業者具備流暢的中英文表達能力。

寫好技術文檔必備五字法則:學問用寫改

在初學者中常遇見的一個現象是,收到一個寫作任務,打開寫作工具,就開始苦思冥想怎么一個字一個字往下寫,包括我自己在剛開始實習的時候也進過同樣的誤區。那么,我們不禁要問,難道一個漂亮的技術文檔不是靠“寫”出來的嗎?我的答案是不是。那又應該靠什么被弄出來的呢?我的答案是我的五字法則——學問用寫改。

當我們接到一個文檔寫作任務時,應遵循“學問用寫改”的五字法則來完成技術文檔的開發。

學:開始寫作之前,我們需要了解文檔寫作規范、工具使用方法、文檔開發流程,還需要了解項目背景、產品功能架構及功能點細節。前者關于規范、工具和流程的信息,我們可以基本了解大概,在工作過程中逐漸熟知細節。后者關于產品知識,需要詳細研讀相關資料,進行功能點知識的攻克。

問:除了針對產品知識的提問之外,我們還應問清文檔任務的需求,比如時間節點,發布形式,語言類型等。

用:實際使用產品

寫:現在才到了“寫”的階段。先根據已掌握的信息按一定的邏輯確定文檔大綱,然后撰寫每一個Topic的內容。

改:實際情況中,可能“改”才是你工作的主旋律(不要問我怎么知道的,說多了都是淚)。首先,初稿寫完之后的自我Review——改;小組內換一位同行Review——改;項目關鍵成員評審——改;質量或者測試再Review——改;項目變更——改、改、改!

這五個動作沒有嚴格意義上的先后順序,可能會相互交叉,反復進行。經過這五個字的摧殘(哦No,是鍛煉),你終于交付了一套漂亮的文檔,像看著自己的孩子一樣看著TA們被掛到網站,被印刷成冊,被聯機到軟件……然后開心的去開啟你的下一個輪回。

充分利用網絡工具,找到同行圈子

開頭提到的那個女孩,她在這方面就做的很好。通過招聘網站上的招聘信息,用公司名稱在技術寫作QQ群中找到我。進而通過我的昵稱和頭像(我所有平臺使用同一昵稱和頭像)找到我的微博,與我直接聯系,然后順利獲得工作職位。不說最終結局,只說她的做法。首先,有沒有一點福爾摩斯的感覺?我們在搜集資料的時候,就需要這種福爾摩斯的精神,順藤摸瓜,不放過任何蛛絲馬跡。然后,我主要想說的是,充分利用網絡工具,找到同行圈子。

上一篇文章中說到不要孤立自己,更廣一層的建議是,走出你的企業,到互聯網上去。在我們的企業中,我們通常是只有幾個人的小團隊,甚至孤零零的一枚單兵,可能存在感稍低一些。然而,在QQ、微博、微信、知乎等網絡平臺上,有許多我們的同行和前輩。他們有些人在自己的公眾號和知乎中分享工作經驗,有些人在群里交流、共享資源資料、舉辦線下活動等。找到他們,擴大我們的圈子,這無疑會正作用于我們的職業成長。網上看到一個段子,或許可以充分說明入同行圈子的直接好處,此處僅用于娛樂——A和B在各自的公司工作3年,均沒有漲薪,一天,A把B推薦給A的公司,B把A推薦給B的公司,兩人分別成功漲薪30%。

塑造你的個人品牌

最近“個人品牌”這個概念好火熱。如果展開來說,這將是個很大的主題,此處我只做簡單提示。作為一名技術寫作者,我們也應該有塑造我們個人品牌的意識,通過合理的優勢定位、持續的優勢展示、持續的學習以強化優勢,在圈子里形成我們自己的核心競爭力。

無論是商品品牌還是個人品牌,塑造的過程大體上可以從以下幾個方面來進行。

1,找到適合你的優勢定位:這一點和本文開篇說到的觀點相同。找到自身優勢,進入合適領域。

2,找到我們的目標受眾:包括你企業內部的同事、領導以及與你有工作往來的合作方,另外就是網絡上的技術寫作圈子。

3,持續展示你的優勢:我們需要持續展示的優勢包括我們的個人特征標簽和我們的內容輸出。

特征標簽:工作過程中給人留下的印象。比如:你很注重細節、你很有時間觀念等等。

內容輸出1:工作成果,即我們開發的技術文檔。

內容輸出2:以“寫作”為生的我們,借助各類網絡寫作平臺可以表達我們的觀點,分享工作經驗,輸出工作所感所悟,各類工具某些具體功能的操作方法。

4,收集反饋,持續學習,升級個人品牌

如果愛,請深愛,若不愛,盡快離開

還要說到開頭提到的那個女孩。她在那個崗位上很認真很用功的磨煉了半年,依然發現并不是很合適,經過深思熟慮之后,選定自己喜歡并擅長的方向,辭職考研。如今已經畢業,在廣東的一所高校任教。

還遇到過一個女孩,計算機專業畢業,上學時也是一枚學霸,潛意識里認為這是一份技術含量低且沒有發展的職業。于是,她一邊上班一邊學習前端開發。不管加班到多晚,回去也要把計劃中的書看完,計劃中的課聽完,然后順利跳槽成功轉行。

這都是很好的例子。從業這些年,我也遇到過一些人,一邊抱怨工作不好,一邊糊弄工作交差,卻從不見行動。作為過來人,我最后只想對初入行的朋友們說一句:如果愛,請深愛,若不愛,盡快離開。請相信一個擅于快刀斬亂麻的女漢子的忠告——永遠不要和一個你不愛的或者你都瞧不上的人結婚,更不要委屈自己做一份你不喜歡或者你都瞧不上的工作。世間萬物,道法相通!

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 173,381評論 25 708
  • —————————————————— 戀愛讓人目眩神迷,你對愛情有的是飛蛾撲火的勇氣?還是永遠只愿做感情贏家的盤算...
    九號館閱讀 356評論 0 0
  • 阿信點兵,多多益善。 話說是金子總會發光這話一直在阿信身上沒有得到驗證,導致其左右跳槽不斷,直到那天夜里,好基友阿...
    王小草兒閱讀 265評論 0 1
  • 1.結婚 2.專利 3.3個app 4.1000個單詞 2018剛好過了一個月了,現在才來回顧下2017的小目標...
    Jason_stu閱讀 143評論 0 0