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

這是《技術(shù)寫作從入門到“轉(zhuǎn)行”》系列文章之一冤吨。本系列文章還包括:《技術(shù)寫作職業(yè)入門記》、《技術(shù)寫作必備軟硬技能》瑟押、《從技術(shù)寫作到創(chuàng)意寫作搀捷,那么遠(yuǎn),這么近多望!》嫩舟。以上文章可在我的簡書文章中查看。說一下這個系列文章的寫作初衷吧怀偷。

技術(shù)寫作這一行家厌,一晃就干了七年∽倒ぃ回頭去看饭于,這段經(jīng)歷居然也有適應(yīng)期、熱戀期维蒙、平淡期和七年之癢掰吕。當(dāng)一個周期結(jié)束,一切歸于平靜之后颅痊,挺想把這段經(jīng)歷記錄下來殖熟。一則留作紀(jì)念。二則斑响,常常會遇到初入行或者單兵作戰(zhàn)的同行菱属。他們其中許多如同我當(dāng)年一樣,有點(diǎn)迷茫舰罚,不太清楚努力的方向纽门。的確,在國內(nèi)营罢,這個職業(yè)還是太冷門赏陵,無論是從業(yè)者還是學(xué)習(xí)資料都相對少的很。所以饲漾,作為過來人瘟滨,我想我或許可以輸出一點(diǎn)東西,雖不是什么高深理論能颁,但至少都是實(shí)戰(zhàn)經(jīng)驗。希望能給初入行的同行們一點(diǎn)參考一點(diǎn)啟發(fā)倒淫,其中不足之處伙菊,也歡迎指正。

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

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

幾年前的一個夏天兴枯,我們正在招聘一名中文技術(shù)文檔工程師血淌。此時,有一名應(yīng)屆生通過微博和QQ群聯(lián)系上我财剖,表示對我們的職位很感興趣悠夯。經(jīng)過簡單的面談,我發(fā)現(xiàn)這位同學(xué)的英文水平不錯躺坟,查閱英文技術(shù)資料肯定沒有問題沦补;從簡歷的寫作和談話過程來看,中文表達(dá)也沒有問題咪橙;她有半年的技術(shù)寫作實(shí)習(xí)經(jīng)歷夕膀,這屬于加分項;她很主動美侦,有強(qiáng)烈的學(xué)習(xí)愿望产舞;可以通過公司招聘信息中的公司名稱從QQ群和微博找到我,說明她具備我在上篇文章中說到的資料獲取能力和即將要在這篇文章談到的走到互聯(lián)網(wǎng)上去菠剩,找到自己的同行圈子的意識易猫。

唯一一點(diǎn)讓我感到有些猶豫的是,專業(yè)相關(guān)的技術(shù)知識點(diǎn)基本沒回答上來赠叼,但考慮到她的專業(yè)也屬于對口專業(yè)擦囊,認(rèn)為她在需要用到相關(guān)知識的時候補(bǔ)一下應(yīng)該問題不大。于是發(fā)了offer嘴办。試用期的三個月瞬场,小姑娘確實(shí)表現(xiàn)出來對產(chǎn)品功能知識點(diǎn)理解的吃力,但是她非常認(rèn)真涧郊,也很用功贯被,團(tuán)隊合作的也很愉快。鑒于此妆艘,在轉(zhuǎn)正答辯環(huán)節(jié)彤灶,我主動保她通過,領(lǐng)導(dǎo)也尊重了我的意見批旺』仙拢可是,在后來的幾個月中汽煮,作為正式員工搏熄,工作量和工作難度的增加棚唆,她的困難越發(fā)明顯。半年后心例,她提出了離職宵凌。我們在最后的面談中談到了她的優(yōu)勢——英語,之前的技術(shù)寫作實(shí)習(xí)也是以英譯漢為主的本地化工作止后,所以瞎惫,我們當(dāng)時以技術(shù)為核心的中文技術(shù)寫作對她來說,不是最合適的選擇译株。

這是我在培養(yǎng)新人的過程中遇到的一個典型的失敗案例瓜喇。猶記得當(dāng)時因為此事引發(fā)的一種挫敗感而耿耿于懷了好一陣子。反思后得出結(jié)論古戴,提示初入行者——目前欠橘,國內(nèi)技術(shù)寫作從業(yè)者主要有以下三類(其他語種的寫作和翻譯此處暫且忽略),請結(jié)合自身優(yōu)勢和劣勢现恼,選擇你最適合最擅長的那一類開始肃续。不用拼命去補(bǔ)自己的短板,在當(dāng)今這個機(jī)會多變化快的社會叉袍,完全可以避開自己的短板始锚,充分用好自己的長板,發(fā)揮自己的長處喳逛,讓長更長瞧捌,讓優(yōu)秀更優(yōu)秀,依然可以有自己的優(yōu)勢润文。

1姐呐,中文技術(shù)寫作:在國內(nèi)多數(shù)企業(yè)中,這類技術(shù)寫作者都屬于必備類別典蝌。這類技術(shù)寫作一般要求從業(yè)者具備相關(guān)技術(shù)專業(yè)背景曙砂,可以快速學(xué)習(xí)產(chǎn)品相關(guān)的技術(shù)知識,具備流暢的中文表達(dá)能力骏掀,英文水平可以查閱相關(guān)技術(shù)資料鸠澈。

2,英文技術(shù)寫作:這類技術(shù)寫作者主要任職于國內(nèi)的外企和第三方專業(yè)提供技術(shù)文檔服務(wù)的公司截驮。這類技術(shù)寫作要求從業(yè)者具備流暢的中英文書面表達(dá)和口語溝通能力笑陈,可以理解產(chǎn)品知識。

3葵袭,英文技術(shù)翻譯:這類技術(shù)寫作者同樣分布在國內(nèi)的一些企業(yè)涵妥,一般和中文技術(shù)寫作者配合工作。一般要求從業(yè)者具備流暢的中英文表達(dá)能力坡锡。

寫好技術(shù)文檔必備五字法則:學(xué)問用寫改

在初學(xué)者中常遇見的一個現(xiàn)象是妹笆,收到一個寫作任務(wù)块请,打開寫作工具,就開始苦思冥想怎么一個字一個字往下寫拳缠,包括我自己在剛開始實(shí)習(xí)的時候也進(jìn)過同樣的誤區(qū)。那么贸弥,我們不禁要問窟坐,難道一個漂亮的技術(shù)文檔不是靠“寫”出來的嗎?我的答案是不是绵疲。那又應(yīng)該靠什么被弄出來的呢哲鸳?我的答案是我的五字法則——學(xué)問用寫改。

當(dāng)我們接到一個文檔寫作任務(wù)時盔憨,應(yīng)遵循“學(xué)問用寫改”的五字法則來完成技術(shù)文檔的開發(fā)徙菠。

學(xué):開始寫作之前,我們需要了解文檔寫作規(guī)范郁岩、工具使用方法婿奔、文檔開發(fā)流程,還需要了解項目背景问慎、產(chǎn)品功能架構(gòu)及功能點(diǎn)細(xì)節(jié)萍摊。前者關(guān)于規(guī)范、工具和流程的信息如叼,我們可以基本了解大概冰木,在工作過程中逐漸熟知細(xì)節(jié)。后者關(guān)于產(chǎn)品知識笼恰,需要詳細(xì)研讀相關(guān)資料踊沸,進(jìn)行功能點(diǎn)知識的攻克。

問:除了針對產(chǎn)品知識的提問之外社证,我們還應(yīng)問清文檔任務(wù)的需求逼龟,比如時間節(jié)點(diǎn),發(fā)布形式猴仑,語言類型等审轮。

用:實(shí)際使用產(chǎn)品

寫:現(xiàn)在才到了“寫”的階段。先根據(jù)已掌握的信息按一定的邏輯確定文檔大綱辽俗,然后撰寫每一個Topic的內(nèi)容疾渣。

改:實(shí)際情況中,可能“改”才是你工作的主旋律(不要問我怎么知道的崖飘,說多了都是淚)榴捡。首先,初稿寫完之后的自我Review——改朱浴;小組內(nèi)換一位同行Review——改吊圾;項目關(guān)鍵成員評審——改达椰;質(zhì)量或者測試再Review——改;項目變更——改项乒、改啰劲、改!

這五個動作沒有嚴(yán)格意義上的先后順序檀何,可能會相互交叉蝇裤,反復(fù)進(jìn)行。經(jīng)過這五個字的摧殘(哦No频鉴,是鍛煉)栓辜,你終于交付了一套漂亮的文檔,像看著自己的孩子一樣看著TA們被掛到網(wǎng)站垛孔,被印刷成冊藕甩,被聯(lián)機(jī)到軟件……然后開心的去開啟你的下一個輪回。

充分利用網(wǎng)絡(luò)工具周荐,找到同行圈子

開頭提到的那個女孩狭莱,她在這方面就做的很好。通過招聘網(wǎng)站上的招聘信息羡藐,用公司名稱在技術(shù)寫作QQ群中找到我贩毕。進(jìn)而通過我的昵稱和頭像(我所有平臺使用同一昵稱和頭像)找到我的微博,與我直接聯(lián)系仆嗦,然后順利獲得工作職位辉阶。不說最終結(jié)局,只說她的做法瘩扼。首先谆甜,有沒有一點(diǎn)福爾摩斯的感覺?我們在搜集資料的時候集绰,就需要這種福爾摩斯的精神规辱,順藤摸瓜,不放過任何蛛絲馬跡栽燕。然后罕袋,我主要想說的是,充分利用網(wǎng)絡(luò)工具碍岔,找到同行圈子浴讯。

上一篇文章中說到不要孤立自己,更廣一層的建議是蔼啦,走出你的企業(yè)榆纽,到互聯(lián)網(wǎng)上去。在我們的企業(yè)中,我們通常是只有幾個人的小團(tuán)隊奈籽,甚至孤零零的一枚單兵饥侵,可能存在感稍低一些。然而衣屏,在QQ躏升、微博、微信勾拉、知乎等網(wǎng)絡(luò)平臺上煮甥,有許多我們的同行和前輩。他們有些人在自己的公眾號和知乎中分享工作經(jīng)驗藕赞,有些人在群里交流、共享資源資料卖局、舉辦線下活動等斧蜕。找到他們,擴(kuò)大我們的圈子砚偶,這無疑會正作用于我們的職業(yè)成長批销。網(wǎng)上看到一個段子,或許可以充分說明入同行圈子的直接好處染坯,此處僅用于娛樂——A和B在各自的公司工作3年均芽,均沒有漲薪,一天单鹿,A把B推薦給A的公司掀宋,B把A推薦給B的公司,兩人分別成功漲薪30%仲锄。

塑造你的個人品牌

最近“個人品牌”這個概念好火熱劲妙。如果展開來說,這將是個很大的主題儒喊,此處我只做簡單提示镣奋。作為一名技術(shù)寫作者,我們也應(yīng)該有塑造我們個人品牌的意識怀愧,通過合理的優(yōu)勢定位侨颈、持續(xù)的優(yōu)勢展示、持續(xù)的學(xué)習(xí)以強(qiáng)化優(yōu)勢芯义,在圈子里形成我們自己的核心競爭力哈垢。

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

1温赔,找到適合你的優(yōu)勢定位:這一點(diǎn)和本文開篇說到的觀點(diǎn)相同。找到自身優(yōu)勢鬼癣,進(jìn)入合適領(lǐng)域陶贼。

2啤贩,找到我們的目標(biāo)受眾:包括你企業(yè)內(nèi)部的同事、領(lǐng)導(dǎo)以及與你有工作往來的合作方拜秧,另外就是網(wǎng)絡(luò)上的技術(shù)寫作圈子痹屹。

3,持續(xù)展示你的優(yōu)勢:我們需要持續(xù)展示的優(yōu)勢包括我們的個人特征標(biāo)簽和我們的內(nèi)容輸出枉氮。

特征標(biāo)簽:工作過程中給人留下的印象志衍。比如:你很注重細(xì)節(jié)、你很有時間觀念等等聊替。

內(nèi)容輸出1:工作成果楼肪,即我們開發(fā)的技術(shù)文檔。

內(nèi)容輸出2:以“寫作”為生的我們惹悄,借助各類網(wǎng)絡(luò)寫作平臺可以表達(dá)我們的觀點(diǎn)春叫,分享工作經(jīng)驗,輸出工作所感所悟泣港,各類工具某些具體功能的操作方法暂殖。

4,收集反饋当纱,持續(xù)學(xué)習(xí)呛每,升級個人品牌

如果愛,請深愛坡氯,若不愛晨横,盡快離開

還要說到開頭提到的那個女孩。她在那個崗位上很認(rèn)真很用功的磨煉了半年廉沮,依然發(fā)現(xiàn)并不是很合適颓遏,經(jīng)過深思熟慮之后,選定自己喜歡并擅長的方向滞时,辭職考研叁幢。如今已經(jīng)畢業(yè),在廣東的一所高校任教坪稽。

還遇到過一個女孩曼玩,計算機(jī)專業(yè)畢業(yè),上學(xué)時也是一枚學(xué)霸窒百,潛意識里認(rèn)為這是一份技術(shù)含量低且沒有發(fā)展的職業(yè)黍判。于是,她一邊上班一邊學(xué)習(xí)前端開發(fā)篙梢。不管加班到多晚顷帖,回去也要把計劃中的書看完,計劃中的課聽完,然后順利跳槽成功轉(zhuǎn)行贬墩。

這都是很好的例子榴嗅。從業(yè)這些年,我也遇到過一些人陶舞,一邊抱怨工作不好嗽测,一邊糊弄工作交差,卻從不見行動肿孵。作為過來人唠粥,我最后只想對初入行的朋友們說一句:如果愛,請深愛停做,若不愛晤愧,盡快離開。請相信一個擅于快刀斬亂麻的女漢子的忠告——永遠(yuǎn)不要和一個你不愛的或者你都瞧不上的人結(jié)婚蛉腌,更不要委屈自己做一份你不喜歡或者你都瞧不上的工作养涮。世間萬物,道法相通眉抬!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市懈凹,隨后出現(xiàn)的幾起案子蜀变,更是在濱河造成了極大的恐慌,老刑警劉巖介评,帶你破解...
    沈念sama閱讀 206,126評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件库北,死亡現(xiàn)場離奇詭異,居然都是意外死亡们陆,警方通過查閱死者的電腦和手機(jī)寒瓦,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,254評論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來坪仇,“玉大人杂腰,你說我怎么就攤上這事∫挝模” “怎么了喂很?”我有些...
    開封第一講書人閱讀 152,445評論 0 341
  • 文/不壞的土叔 我叫張陵,是天一觀的道長皆刺。 經(jīng)常有香客問我少辣,道長,這世上最難降的妖魔是什么羡蛾? 我笑而不...
    開封第一講書人閱讀 55,185評論 1 278
  • 正文 為了忘掉前任漓帅,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘忙干。我一直安慰自己器予,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,178評論 5 371
  • 文/花漫 我一把揭開白布豪直。 她就那樣靜靜地躺著劣摇,像睡著了一般。 火紅的嫁衣襯著肌膚如雪弓乙。 梳的紋絲不亂的頭發(fā)上末融,一...
    開封第一講書人閱讀 48,970評論 1 284
  • 那天,我揣著相機(jī)與錄音暇韧,去河邊找鬼勾习。 笑死,一個胖子當(dāng)著我的面吹牛懈玻,可吹牛的內(nèi)容都是我干的巧婶。 我是一名探鬼主播,決...
    沈念sama閱讀 38,276評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼涂乌,長吁一口氣:“原來是場噩夢啊……” “哼艺栈!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起湾盒,我...
    開封第一講書人閱讀 36,927評論 0 259
  • 序言:老撾萬榮一對情侶失蹤湿右,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后罚勾,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體毅人,經(jīng)...
    沈念sama閱讀 43,400評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,883評論 2 323
  • 正文 我和宋清朗相戀三年尖殃,在試婚紗的時候發(fā)現(xiàn)自己被綠了丈莺。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 37,997評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡送丰,死狀恐怖缔俄,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情蚪战,我是刑警寧澤牵现,帶...
    沈念sama閱讀 33,646評論 4 322
  • 正文 年R本政府宣布,位于F島的核電站邀桑,受9級特大地震影響瞎疼,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜壁畸,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,213評論 3 307
  • 文/蒙蒙 一贼急、第九天 我趴在偏房一處隱蔽的房頂上張望茅茂。 院中可真熱鬧,春花似錦太抓、人聲如沸空闲。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,204評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽碴倾。三九已至,卻和暖如春掉丽,著一層夾襖步出監(jiān)牢的瞬間跌榔,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,423評論 1 260
  • 我被黑心中介騙來泰國打工捶障, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留僧须,地道東北人。 一個月前我還...
    沈念sama閱讀 45,423評論 2 352
  • 正文 我出身青樓项炼,卻偏偏與公主長得像担平,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子锭部,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,722評論 2 345

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 171,498評論 25 707
  • —————————————————— 戀愛讓人目眩神迷拌禾,你對愛情有的是飛蛾撲火的勇氣空另?還是永遠(yuǎn)只愿做感情贏家的盤算...
    九號館閱讀 335評論 0 0
  • 阿信點(diǎn)兵,多多益善蹋砚。 話說是金子總會發(fā)光這話一直在阿信身上沒有得到驗證,導(dǎo)致其左右跳槽不斷摄杂,直到那天夜里坝咐,好基友阿...
    王小草兒閱讀 249評論 0 1
  • 1.結(jié)婚 2.專利 3.3個app 4.1000個單詞 2018剛好過了一個月了,現(xiàn)在才來回顧下2017的小目標(biāo)...
    Jason_stu閱讀 136評論 0 0