❶ Technical Writer 不只是寫產品說明書的
2018 年 3 月 28 日的時候,我和 Queeny 一起回北京大學軟體與微電子學院給在讀的學弟學妹們做了一個 分享 。
之後一個學妹找我咨詢論文相關的事情,因為她寫的論文是關於技術寫作的。我根據自己從事技術寫作的一些經驗和積累的知識,回答了她幾個問題。然後她跟我說,「一般的人都以為咱技術寫作就是寫說明書的,學姐有時間了可以專門寫一篇推送」。
當別人讓你解釋 Technical Writer 是幹嘛的時,回答說寫說明書的或許可以讓對方快速理解。但那隻是一個方面而已,並不能涵蓋 Technical Writer 的所有工作。
你有沒有遇到過不知該如何給別人解釋清楚 Technical Writer 到底是做什麼的尷尬境地?尤其是當父母或其他長輩們問起的時候……
說的多了吧,他們可能理解不了,也不想理解;說的少了吧,他們可能覺得你的工作就是干這么點兒事兒啊。最後想想,算了,佛系回答吧~
之前跟大家分享過 兩分鍾趣味解讀 Technical Writer 的一個小視頻,還附上了一個 Technical Writer 怎麼跟別人解釋自己的工作的漫畫版。
最近還在網上看到一個用 DITA 寫技術文檔的 Technical Communicator 跟別人解釋自己工作的對話,好奇的小夥伴可以去看一下。地址: https://techwhirl.com/integrated-technical-communications-a-map-to-better-understanding/
很多尚未進入或者剛剛進入 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 小夥伴們有沒有這樣的經歷呀,覺得自己很機智地跟別人解釋了自己的工作?
歡迎留言交流哦~
你可能想讀 :
技術文檔誕生記 | 完整的技術寫作流程是怎樣的?
Technical Writer 日常工作中好用的小工具
技術翻譯需要有 Technical Writer 的 sense
深度解析關於技術翻譯的六個認知誤區
如何讓你的內容輸出更加專業更有設計感?
書單 | 有哪些技術傳播從業者必知必看的書籍?
有哪些適合技術傳播從業者關注的優質博客?(一)
有哪些適合技術傳播從業者關注的優質博客?(二)
經驗分享 | 來自 11 位 Technical Writer 前輩的職業發展建議(上篇)
經驗分享 | 來自 11 位 Technical Writer 前輩的職業發展建議(下篇)
英語技術文檔的標題到底該大寫還是小寫?
如何使用正則表達式批量添加和刪除字元?
Markdown:寫技術文檔、個人博客和讀書筆記都很好用的輕量級標記語言
如何為 Markdown 文件自動生成目錄?
技術寫作實例解析 | 簡潔即是美
兩分鍾趣味解讀 Technical Writer
若脫離理解,直譯得再正確又有何意?
優質譯文不應止於正確,還要 Well-Organized
寫在入職技術型創業公司 PingCAP 一個月之後
揭秘 Technical Writer 的工作環境 | 加入 PingCAP 五個月的員工體驗記
-END-
❷ 成為一名技術文檔工程師需要哪些因素
成為一名技術文檔工程師需要哪些因素?
文檔工程師,是指協同開發人員,收集資料,安排開發計劃,編寫企業項目開發所需的各類文檔,同時保證文檔的質量、安全等的技術人員,他們肩負著軟體開發過程中信息處理與整合的重要職責。面對"文檔",他們需要完成包括安排開發計劃、制定各類模板、跟蹤編寫進度以及編輯管理等在內的一系列工作,實現文檔處理的"一條龍"服務。下面是我為大家整理的成為一名技術文檔工程師需要哪些因素的內容,歡迎閱讀與參考!
如果你還是在校學生,那麼,對你而言,好消息是你有足夠多的時間來做准備。通過詳細研究各大招聘網站上的技術文檔工程師崗位要求描述,你可以得知自己需要自學哪些知識,有針對性地補上技能短板。你可以利用假期找相關的實習機會,為畢業時的簡歷添加有說服力的一筆。大公司,特別是北京和上海的外企(如微軟、IBM等),時不時會提供一些技術文檔寫作的實習崗位給本科生或者研究生。一般來說,小公司更青睞社招人士,他們需要的是有工作經驗的技術文檔工程師,因此這類企業往往很少提供對應的實習崗位。壞消息是,整個中國每年能夠提供的此類實習機會確實是少了點(而且往往集中在幾個大城市),畢竟這個領域的從業群體也不大。不過話雖如此,作為學生的你,哪怕是找一份與技術文檔寫作稍微有關聯的實習(如IT網站編輯、科技翻譯等),也不失為一個好選擇。
如果你已經參加工作了,想要轉型,則情況又有所不同。實際上,很多技術文檔工程師並不是一從學校出來就干這行的。有些人原本是做軟體本地化工作的,有可能是覺得單純的翻譯工作沒意思,於是就轉為技術文檔寫作了。也有些人是理科出身,但是做了一陣研發工作後,覺得自己不適合干技術活,但又發自內心地喜歡技術領域,於是便選擇了成為一名技術文檔工程師,將技術與寫作結合起來。諸如前面這類情形,之前做的是相關度比較高的工作,後來轉型就相對容易些。如果你之前從事的工作和技術文檔寫作完全搭不到邊,則麻煩些。你得向僱主證明,自己有成為一名技術文檔工程師的潛力。如何證明?文筆好、對相關技術領域感興趣、關注細節、溝通能力強等等,你可以從各個角度來推銷自己。舉個簡單的例子,你說你自己書面表達清晰,富有邏輯,該如何體現?僅僅在簡歷上寫這么一段貌似自我誇獎的話是不夠的,你最好得有拿得出手的東西,例如你有自己的博客,你在上面寫了很多技術教程,這就是最好的體現。已經參加工作的人,雖然業余時間沒有在校學生那麼多,不過只要肯下功夫,每天下班後擠出一兩個鍾來自學,一年半載的時間足夠你做好最基本的知識和技能儲備了。
其實,本文雖然談的是如何成為一名技術文檔工程師,但在方法論上仍具有普遍適用性。我認為,如今是信息爆炸的時代,有心人完全可以通過互聯網獲取足夠多的信息(如關注專業領域人士的博客或微博),知道自己缺少哪些技能,需要往哪個方向努力。君不見,IT行業的`大牛中,有很多都是非科班出身的。勇於擁抱變化,敢於跨界發展,才能在職場中,乃至人生中立於不敗之地。
延伸閱讀:
1、工作內容
1、按照公司文檔開發規范進行產品的用戶文檔編寫工作並完成日常維護;
2、制定用戶文檔的開發計劃,並控制計劃的執行;
3、集中存儲所有文檔資料,保證文檔版本與代碼版本的一致性,維護文檔資料的索引表,定期備份文檔資料;
4、參與文檔的標准化、制度化規范化等工作;
5、參與聯機文檔編譯和測試,相關的技術支持工作;
6、編寫產品指標說明書、使用手冊,製作演示幻燈片,完成公司宣傳冊設計、公司網站維護等[1]。
2、職業要求
教育培訓:一般要求本科及以上學歷,通信、計算機、電子、無線電、自動控制等專業。
工作經驗:需具有產品開發和文檔編寫及繪圖軟體使用的經驗,熟悉軟體測試流程、步驟及規范,能夠獨立設計測試方案,編寫測試計劃和測試報告;能熟練運用各種辦公軟體,且盡可能學會使用Rose、ReqPro、SoDA等軟體工程方面的軟體;具備良好的邏輯思維能力,思路清晰,能夠清楚、簡明地陳述問題;具備較強的文字表達能力,擅長綜合和歸納,尤其是要具有較高的專業英語閱讀和寫作水準;工作細致耐心,擁有較好的溝通技巧、抗壓能力及團隊合作精神,較強的責任感及進取精神。
優秀的文檔工程師實際是一種復合型人才,他們不光擅長文檔的編寫,同時對於所編寫文檔的項目或產品涉及的其他領域包括電子、通信、無線電等有廣泛的了解;對於軟體文檔,優秀的文檔工程師不僅熟悉編寫過程,也了解最後的測試、運行,這樣才能總體把握各個環節,真正扮演好"信息處理中心"的角色。
除此之外,文檔工程師在國內是近幾年才逐步被人們重視起來的,較之國外,人才的數量素質和相關的管理規范都存在較大差距,因此具有海外學習工作或外資企業等工作經驗的人才更具有吸引力。
3、薪資行情
隨著企業之間競爭的加劇,能夠給用戶提供一個清晰易懂、功能全面的文檔也已成為公司產品的一個優勢,同時隨著企業規模的不斷壯大,要求對於一些重要的文檔進行有效的管理和保存,而有的程序開發人員不願書寫文檔,這些原因都造成了對文檔工程師的大量需求。文檔工程師需要具備全面的公司對應的產品知識以及工作技能和一定的計算機基礎,的工作偏於繁瑣。
一般情況下,文檔工程師新手入行時起薪在每月2000~3000之間,普通文檔工程師月薪大約4000元左右,具備兩年以上工作經驗者可增至8000元左右,工作五年以上,這一數字將提升到10000-15000元。具體的薪資還根據文檔工程師的技能水平及具體側重的領域有很大浮動。
4、職業發展路徑
在專業方向上,他們往往擁有與C/C++軟體工程師、Java軟體工程師、.net軟體工程師、PHP軟體工程師、軟體測試工程師等相似的專業背景,或直接由其分化演變而來,因而具備這些職業的技術能力和工作經驗,可向高級工程師、總設計師、總工等方向發展。
在管理方向上,該領域中具備較強統籌能力、溝通能力、管理能力的技術人員可考慮向IT項目經理、技術經理、研發經理等方向晉升。
❸ 什麼叫程序員
程序員(英文Programmer)是從事程序開發、維護的專業人員。一般我們將程序員分為程序設計人員和程序編碼員,但兩者的界限並不非常清楚,特別是在中國。
作一個真正合格的程序員,應該具有的素質。
1:團隊精神和協作能力
團隊精神和協作能力是作為一個程序員應具備的最基本的素質。軟體工程已經提了將近三十年了,當今的軟體開發已經不是編程了,而是工程。獨行俠可以寫一些程序也能賺錢發財,但是進入研發團隊,從事商業化和產品化的開發任務,就必須具備這種素質。可以毫不誇張的說這種素質是一個程序員乃至一個團隊的安身立命之本。
2:文檔習慣
文檔是一個軟體系統的生命力。一個公司的產品再好、技術含量再高,如果沒有缺乏文檔,知識就沒有繼承,公司還是一個來料加工的軟體作坊。作為代碼程序員,必須將30%的工作時間寫用於技術文檔。沒有文檔的程序員勢必會被淘汰。
3:規范化的代碼編寫習慣
知名軟體公司的代碼的變數命名、注釋格式,甚至嵌套中行縮進的長度和函數間的空行數字都有明確規定,良好的編寫習慣,不但有助於代碼的移植和糾錯,也有助於不同技術人員之間的協作。 一些所謂的高手甚至叫囂高手寫的代碼一般人看不懂,我只能說他不是一名合格的程序員。
4:需求理解能力
程序員要能正確理解任務單中描述的需求。在這里要明確一點,程序員不僅僅要注意到軟體的功能需求,還應注意軟體的性能需求,要能正確評估自己的模塊對整個項目中的影響及潛在的威脅,如果有著兩到三年項目經驗的熟練程序員對這一點沒有體會的話,只能說明他或許是認真工作過,但是沒有用心工作。
5:模塊化思維能力
作為一個優秀的程序員,他的思想不能在局限當前的工作任務裡面,要想想看自己寫的模塊是否可以脫離當前系統存在,通過簡單的封裝在其他系統中或其他模塊中直接使用。這樣做可以使代碼能重復利用,減少重復的勞動,也能是系統結構越趨合理。模塊化思維能力的提高是一個程序員的技術水平提高的一項重要指標。
6:測試習慣
測試是軟體工程質量保證的重要環節,但是測試不僅僅是測試工程師的工作,而是每個程序員的一種基本職責。程序員要認識測試不僅是正常的程序調試,而要是要進行有目的有針對性的異常調用測試,這一點要結合需求理解能力。
7:學習和總結的能力
程序員是很容易被淘汰的職業,所以要善於學習總結。許多程序員喜歡盲目追求一些編碼的小技巧,這樣的技術人員無論學了多少語言,代碼寫起來多熟練,我們只能說他是一名熟練的代碼民工,他永遠都不會有質的提高。一個善於學習的程序員會經常總結自己的技術水平,對自己的技術層面要有良好的定位,這樣才能有目的地提高自己。這樣才能逐步提高,從程序員升級為軟體設計師、系統分析員。
❹ 技術文檔工程師是干什麼的
主要是編寫、維護、修訂開發文檔,技術說明書、產品說明書,技術項目/方案說明書,等等技術文書工作的。