技術寫作幫助你與他人分享你的技術知識和經驗。技術寫作在展示你的技術能力和才能的同時，也可以強化你對所寫主題的了解。
在這篇文章中，我將闡述想成為一名技術文檔工程師，你需要知道什麼。我們將了解什麼是技術寫作、技術文檔工程師需要的技能、如何成為一名技術文檔工程師，以及了解一些能幫助你真正精通技術寫作的技巧。
什麼是技術寫作？我們可以用很多不同的方式來定義技術寫作。但是 Grammar 上的定義是最有用的，它準確地解釋了技術寫作的含義：
「技術寫作是作者就一個特定的主題寫作，這個主題要求具有指導性、指示性或說明性作用。」
簡而言之，技術寫作涉及對某一特定主題直截了當、易於理解的說明和指示。
技術文檔工程師需要具備什麼技能在那些曾經想要成為作家的人中，存在着一種常見的假設，即他們無法寫出好文章是因為他們天生就沒有寫作天賦或寫作技能。這就衍生了一個問題：作家是天生的還是靠後天培養的？
我很好奇其他人對這個普遍的假想是什麼看法，於是我在推特上發了一條信息。
閱讀每個人的觀點都很有意思。大部分人說他們相信作家是天生的，另一部分人持反對意見，認為作家是後天培養的。有趣的是，還有一部分人認為作家既是天生的又離不開後天培養。很瘋狂對吧？
我相信你很好奇我對此的看法，那麼我將在下文告訴你。😉
我相信任何人，無論是否與生俱來擁有某種能力，都可以通過學習成為一名優秀的作家。我知道我不是生來就有寫作天賦，所以我決定更加用心地學習如何寫作。
說實話，你今天看到的大多數技術文檔工程師很有可能都必須通過培養或學習特定的技能而變得擅長寫作。
現在進入正題😃，要成為一名成功的技術文檔工程師，你應該培養以下五項必備技能：
知道如何寫作我知道你可能會覺得困惑，為什麼說寫作是成為一名技術文檔工程師所需的技能之一。你可能認為技術寫作和寫作是一樣的，但是其實它們並不一樣。
一般情況，寫作就是使用符號（字母表的字母、標點符號和空格）以可讀的形式傳達思想和想法的過程。而另一方面，技術寫作就是更具體地從邏輯和技術上來分享或表達你的想法、觀點、指示和建議的過程。
每個技術文檔工程師的首要技能是能夠用他們首選的語言進行寫作交流。例如，如果你打算用英語來寫技術文章，你需要知道英語是如何構詞和交流的。
想要更好地寫作嗎？試試以下步驟：
識別和了解特定讀者，並為他們定製輸出你的內容將使你的文章或文檔脫穎而出。這就是為什麼你需要了解你的讀者。
你了解你的讀者後，就能寫出為他們量身定做的文章，滿足他們的需求，從而自動有效地傳遞信息。
那麼，你如何才能了解你的目標讀者呢？
問問自己關於讀者的問題你需要問自己這樣的問題：「誰是我的讀者，他們為什麼要讀這篇文章？他們希望從文章中得到什麼？」
例如，在我開始寫這篇文章之前，我問了自己這些問題，並得出了以下答案：
當我想清楚這些問題的答案，我就能夠定位我的目標讀者，就是那些初學者。這有助於我打磨這篇文章並幫到你。
如果你的目標讀者是初學者，你應該使用容易理解的術語。你也可以添加具體的例子來幫助讀者理解。
給你的文章或文檔取一個有用的標題或名稱文章名稱應具有描述性並對讀者有幫助。
例如，當內容是關於 React 中的元素渲染時，就不要將文章命名為《深入了解 React》。這樣會讓那些期望在閱讀完你的文章後能了解 React 所有知識的讀者失望。
相反，想一個具體的標題，準確描述你文章中所寫的內容，如《如何在 React 中渲染元素》。
培養你的技術能力作為技術文檔工程師，你的目標是幫助讀者以最直接的方式理解高度複雜的過程或概念。
要做到這一點，你需要熟悉你所寫的主題。這意味着如果你想寫一篇關於 React.js 的技術文章或文檔，你應該做到自己也會使用 React。
我將以阿爾伯特·愛因斯坦（Albert Einstein）的這句流行名言來結束本節：
如果你不能向一個六歲的孩子解釋它，你自己也不會理解它。
這句話也呼應了在向別人解釋你的主題之前，徹底理解主題技術細節的必要性。
能夠做好研究工作是的！技術文檔工程師並非無所不知。所以，即使你可能熟悉一項技術，有時你也必須研究一種語言或框架，以便在你開始寫作之前更好地理解所寫主題。
這將確保你的文本是準確的並能最有效地傳達必要的數據。你肯定不希望分享虛假或令人困惑的信息。
你應該如何進行研究？研究的方式包括在你喜歡的搜索引擎上提問、請教對該主題了解的人（如果你認識的話）或者閱讀書籍。
如果你決定使用搜索引擎的方式，就針對你想要發現的內容提問。例如，如果你想了解如何在 React 中使用 GSAP ScrollTrigger 插件，你的問題應該遵循這樣的格式「我如何在 React 中使用 GSAP ScrollTrigger 插件」。
如果你決定詢問對該主題了解的人，記得要有禮貌，直奔主題。你可以遵循以下詢問方式，而不是說完 「_你好_」 就等着對方回復後才提問。
「嗨，Rita，我叫 Edidiong。我知道你對使用 GSAP ScrollTrigger 插件非常了解。這些年來，我看過一些你的 CodePen 演示，它們看起來都非常棒。我很想知道如何操作 GSAP tween 滾動觸發動畫？如果你因為工作繁忙而不能回復，我完全理解。但如果你能回復，我將很感激。」
你可能覺得這是一條相當長的信息，但它包含了最重要的事情：你的名字、你對對方工作的欽佩、你的需求，以及你明白你無權占用對方的時間。
在研究階段，你還可以選擇閱讀書籍。為此，你可以去圖書館或在線查找書籍閱讀。
你有沒有想過為什麼人們會給一篇文章留這樣的評論 「哇，看了你的文章，我終於理解了這個概念」 或是 「我讀了其他人寫的文章都沒理解這個概念，但讀了你寫的就豁然開朗了，謝謝你！」
如果你問我，我會說這是因為作者用了他自己獨特的寫作風格來寫作。
這是什麼意思？ 意思是每個人都是獨一無二的。
所以，如果兩個開發人員寫同一個主題的文章，一些讀者會更容易理解第一個開發人員寫的文章，而另一些讀者會更容易理解第二個開發人員寫的文章。為什麼會這樣呢？ 因為兩位開發人員都有自己獨特的寫作風格，不同的寫作風格會適用於不同的讀者。
那麼，你如何才能形成自己獨特的寫作風格呢？忠於自己，像一個作家那樣，讓你的思想自由流動，而不是複製其他作家的內容。是的，從他人那裡獲得靈感，但不要忘記你是誰！
事實上，人們的學習方式各不相同。有可能你寫的內容剛好就是某個開發人員在真正理解一個概念前希望能閱讀到的內容。
現在我們已經討論了成為一名優秀技術文檔工程師所需要的基本技能。我要說的是，這些技能可以慢慢習得，不用等到你全部都會了才開始寫作—試着開始寫作吧。
如何成為一名技術文檔工程師現在，我們來談談如何成為一名技術文檔工程師。💃🏽
取得進展的秘訣就是開始。——馬克·吐溫（Mark Twain）
是的，我不得不從馬克·吐溫的這句名言開始說起，因為這是我們在接受新挑戰時都需要記住的事情。下決心成為一名技術文檔工程師是件好事，但是開始採取行動更重要。
我們來談談想成為一名技術文檔工程師你需要做的四件重要事情。
參加技術寫作課程技術寫作是一項緊缺的技能，僱主希望為團隊招募到最優秀的技術文檔工程師。參加技術寫作課程的重要性被嚴重低估，但它其實是有必要的，因為你會了解到很多技巧，這些技巧可以幫助你成為一個更優秀的技術文檔工程師。
參加完谷歌的技術寫作課程後，我的技術寫作技能明顯提高了，所以我強烈建議你也參加這個課程或者其它類似寫作課程。
閱讀書籍和技術文章讀完一千本書，你將文思泉湧。——鄺麗莎（Lisa See）
閱讀是必不可少的，因為它將幫助你豐富你的詞彙量、緊跟當前的趨勢、了解寫作界正在發生的事情、同時保持寫作動力不竭。
為此，我強烈建議你去 freeCodeCamp、Hashnode、The Writing Cooperative 等網站閱讀技術相關的文章。
開始寫作在寫作中學習寫作，在閱讀和思考作家是如何塑造人物和編撰故事中學習寫作。如果你不能成為一個讀者，那就別想成為一個作家。——瓊·M·奧爾（Jean M. Auel）
即使你參加了所有的技術寫作課程，閱讀了所有你能找到的技術文章，這也不會使你成為一個技術文檔工程師。你需要實際寫作才能成為一名技術文檔工程師。
你可能想知道如何才能真正開始寫作。好吧，我來告訴你。
首先，你需要想好一個你想寫的主題。然後你應該做必要的研究，寫出文章初稿，並校對文章（至少兩遍）。準備就緒後，你就可以在你的博客上發布文章了。
你不需要從頭開始建立你的博客，因為這會占用大量時間且分散你的注意力，使你無法專注於寫作這件正事。就我而言，我用 Hashnode 創建了我的博客，因為 Hashnode 速度超快，它有一個強大的社區，並且允許你將博客映射到你自己的域名。
在你對寫作得心應手後，可以申請成為 freeCodeCamp 的專欄作者。如果你通過審核，就可以在 freeCodeCamp 的平台上發布文章，以此接觸到更多的讀者。
編輯註：這是 freeCodeCamp 中文專欄作者申請表單
http://freecodecamp-chinese.mikecrm.com/IADsaCW
堅持寫作堅持寫作在幫助你成為一個更好的作者方面起着巨大的作用。它可以釋放你的生產力，轉變你的觀點，建立你的信心。
你一開始寫不出好文章。一開始你寫的都是廢話但你還認為自己寫得很好，然後你會逐漸寫得越來越好的。這就是為什麼我說最有價值的特質之一是堅持不懈。——奧克塔維婭·E·巴特勒（Octavia E. Butler）
就像其它技能一樣，當你堅持寫作時，你的寫作能力就會變得越來越好。爭取每個月至少寫一篇文章，如果你堅持不懈，終會驚喜發現自己的寫作技巧有了提高。
作為一名技術文檔工程師，如果你想要鍛煉你堅持不懈的精神，可以試試這個#1周2篇文章挑戰。
什麼是1周2篇文章挑戰？這項挑戰的目標是鼓勵技術文檔工程師確定自己的寫作目標，了解寫作標準，最重要的是堅持寫作。
參與者需要在自己的博客上 每周至少發表 2 篇文章，共持續 4 周。如果能做到這一點，你將能在短短一個月內在你的博客上創建並發表 8 篇文章。很有趣，對吧？😉
我看到很多人都在談論參加這個挑戰的好處。我相信它將幫助你開始堅持寫作。
為開源項目做貢獻開源項目的文檔可以說和軟件本身一樣重要。因此，如果你是一個技術文檔工程師，你就可以在文檔方面為項目做出重要貢獻，因為人們無法使用他們不了解的東西。
是的，你可能正在為一個項目或開源組織免費工作。但是，開源貢獻可以幫助你提高你的寫作技巧、擴大你的人際圈子，並幫助你獲得開源組織維護者的推薦和介紹。
開源貢獻還可以幫助你增加入選谷歌文檔之季（Google Season of Docs）項目的機會。
什麼是谷歌文檔之季？為什麼它很重要？文檔之季是由谷歌組織一個年度項目。其目標是連接技術文檔工程師和開源組織，促進開源領域中的文檔協作和提升。
這項活動非常重要，因為通過開源項目的文檔，用戶不僅可以理解該項目，還可以為項目做貢獻。
在項目期間，入選的技術文檔工程師將花費 3-5 個月的時間來構建一套新的文檔、改進現有文檔的結構、開發一個急需的教程或改進一個開源組織的貢獻流程和指南。
這個項目的有趣之處在於，作為技術文檔工程師參與開源項目貢獻，你可以獲得 3000 至 15000 美元的報酬 。你也會有更大的機會加入谷歌的技術寫作團隊，還有可能在項目結束後被開源組織留用，繼續從事技術寫作工作。
幫助你開始寫作的 6 個技術寫作技巧完成初稿後，注意以下事項：
技術寫作仍然是專業工作場所中一項令人羨慕的技能。預計從 2014 年到 2024 年，技術寫作需求將至少增長 10%。
寫作像許多其它手藝一樣，需要多年的實踐來打磨。寫作最好的地方在於你可以看到自己的進步。如果你努力練習，隨着時間的推移，你就能看到你的寫作能力比之前有很大的進步。
另外，技術文檔工程師有一個很大的好處，那就是成為終身學習者。因為他們需要精通自己所寫的任何領域或話題，以便向讀者清楚地傳達信息。我強烈鼓勵你不僅要開始這段旅程，而且要堅持寫作。
就寫到這兒吧，朋友們！我希望這篇文章對你們有幫助。
Happy coding!
原文鏈接：https://www.freecodecamp.org/news/how-to-become-a-technical-writer/
作者：Edidiong Asikpo
譯者：Narcissus91
留言列表