[[354651]]

如果你喜歡寫作和技術，技術寫作可能是一個適合你的職業。如果你喜歡技術，但又不是真的整天喜歡編碼，也可以做一些別的事情。

如果你喜歡通過教導他人來學習，為開源項目做出貢獻，并教導他人如何做到這一點，或者基本上喜歡通過你的寫作以簡單的方式解釋復雜的概念，技術寫作也可能適合你。

讓我們深入了解基礎知識，了解你在開始技術寫作時應該知道和考慮的問題。

目錄

• 什么是技術寫作?
• 技術寫作的好處
• 作為技術作家必須具備的技能
  • 了解正確的英語用法
  • 知道如何清楚、簡單地解釋事物
  • 具備一定的寫作技巧 ??
• 技術寫作過程
  • 分析并了解你的讀者是誰
  • 考慮用戶體驗
  • 計劃你的文檔
  • 對該主題進行深入研究
  • 做一個大綱
  • 獲取相關的圖形/圖像
  • 以正確的風格寫作
• 在哪里發表文章
  • 國內
  • 國外
• 技術寫作課程
• 技術寫作論壇和社區
• 下面是一些令人驚嘆的技術作家
• 最后的話
• 參考資料

什么是技術寫作?

技術寫作是一門藝術，提供細節導向的指導，以幫助用戶理解特定的技能或產品。

技術作者是寫這些說明的人，也稱為技術文檔或教程。這可能包括用戶手冊、在線支持文章或者程序員/API 開發者的內部文檔。

技術寫作者的交流方式是將技術信息呈現給讀者，使讀者能夠將這些信息用于預期的目的。

技術寫作的好處

技術寫作者也是是終身學習者。由于這份工作需要用簡單而直接的術語來表達復雜的概念，所以你必須精通你所寫的領域，或者愿意學習它。

這很好，因為每研究和編寫一份新的技術文檔，你就會成為該領域的專家。

技術寫作還能讓你更好地理解用戶的感受，它幫助你更多地關注讀者或用戶對產品的感受，而不是你的想法。

你也可以通過為組織撰稿來賺錢。下面是一些付錢給你為他們寫文章的機構，比如Smashing 雜志、AuthO、Twilio和Stack Overflow。

除此以外，你還可以為開源社區做貢獻，參與 Google Season of Docs 和 Outreachy 等付費開源項目。

你也可以把技術寫作作為一個全職職業——很多公司都需要有這些技能的人。

作為技術作家必須具備的技能

了解正確的英語用法

在你考慮寫作之前，有必要掌握好英語、時態、拼寫和基本語法。你的讀者不希望讀到一篇充滿錯誤語法和糟糕詞匯選擇的文章。

知道如何清楚、簡單地解釋事物

知道如何實現功能并不一定意味著你可以與其他人清楚地交流該過程。

為了成為一名優秀的老師，你必須具有同理心，能夠以適合你的目標受眾的方式教授或描述術語。

如果你不能向六歲的孩子解釋它，那么你自己也不了解。——艾爾伯特·愛因斯坦

具備一定的寫作技巧 ??

我相信，作家是天生的，而不是后天的，而你只有通過實際寫作才能學會如何寫作。

你可能永遠都不知道你有寫作的能力，直到你把筆放到紙上。而要想知道自己是否有一定的寫作能力，只有一個辦法，那就是通過寫作。

所以我鼓勵你從今天開始寫作。你可以選擇從我在本節中列出的任何一個平臺開始，以擴展你的寫作能力。

當然，擁有一些技術領域的經驗也是巨大的好處。

技術寫作過程

分析并了解你的讀者是誰

當你在寫一篇技術文章時，要考慮的最大因素是你的預期/期望受眾。它應該始終在你的腦海中占據最重要的位置。

一個好的技術寫作者會根據讀者的語境來寫作。舉個例子，比如說你要寫一篇針對初學者的文章。重要的是，不要假設他們已經知道某些概念。

你可以在文章開頭概述任何必要的先決條件。這將確保你的讀者在直接進入你的文章之前已經(或能夠獲得)他們所需要的知識。

你還可以加入有用資源的鏈接，這樣你的讀者只需點擊一下就能獲得他們需要的信息。

為了知道你是為誰而寫，你必須盡可能多地收集關于誰將使用該文件的信息。

重要的是要知道你的讀者是否在該領域有專業知識，是否這個話題對他們來說是全新的，或者他們是否介于兩者之間。

你的讀者也會有他們自己的期望和需求。當讀者開始閱讀文檔時，你必須確定他們在尋找什么，以及他們將從中獲得什么。

要了解你的讀者，請在開始寫作之前先問自己以下幾個問題：

• 我的讀者是誰?
• 他們需要什么?
• 他們將在哪里閱讀?
• 他們什么時候閱讀?
• 他們為什么要閱讀?
• 他們將如何閱讀?

這些問題還能幫助你思考讀者在閱讀你的寫作時的體驗，這一點我們現在要多說幾句。

考慮用戶體驗

用戶體驗在技術文檔中和在網絡上的任何地方一樣重要。

既然你知道了你的受眾和他們的需求，就要記住文檔本身是如何為他們的需求服務的。很容易忽略讀者實際會如何使用文檔。

寫作時，不斷后退一步，把自己當成讀者來看待文檔。問問自己：它是可訪問的嗎?你的讀者將如何使用它?他們何時會使用它?是否易于閱讀?

目的是編寫一個對讀者有用和可用的文檔。

計劃你的文檔

記住你的用戶是誰，然后你就可以對你的文檔進行構思和規劃。

這個過程包括許多步驟，我們現在將繼續進行。

對該主題進行深入研究

在規劃你的文檔時，你必須研究你要寫的主題。有大量的資源只需在谷歌上搜索一下就可以供你消費，并從中獲得更深的見解。

不要試圖從別人的作品或文章中摘錄下來，然后當作自己的作品，因為這就是抄襲。相反，將這些資源作為你工作的參考和想法。

盡可能多地使用谷歌，從研究期刊、書籍或新聞中獲取事實和數據，盡可能多地收集有關你的主題的信息。然后你就可以開始做一個大綱了。

做一個大綱

在擴展文檔內容之前先列出提綱，這有助于你更專注地寫作。它還可以讓你組織你的思路，實現你的寫作目標。

提綱還可以幫助你確定你希望讀者從文檔中得到什么。最后，它為你的寫作建立了一個時間表。

獲取相關的圖形/圖像

在確定需要嵌入到文檔不同部分的各種虛擬輔助工具(信息圖、gif、視頻、tweet)時，有一個大綱非常有用。

如果你把這些相關的圖形放在手邊，會讓你的寫作過程變得更加輕松。

以正確的風格寫作

終于，你可以開始寫作了!如果你已經完成了所有這些步驟，寫作應該會變得容易很多。但你仍然需要確保你的寫作風格適合技術文檔。

寫作需要通俗易懂、直接和專業，在技術文檔中不歡迎花哨或情緒化的文本。為了幫助你保持這種風格，這里有一些你應該培養的關鍵品質。

使用主動語態

在文章中使用主動語態是個好主意，因為它比被動語態更容易閱讀和理解。

主動語態是指句子的主語是主動執行動詞動作的人，被動語態是指主語是動詞動作的接受者。

這是一個被動語態的示例：每個 Web 開發人員每年應閱讀六次文檔。

下面是一個主動語態的例子：每個 web 開發人員一年應該閱讀該文檔 6 次。

慎重選擇你的詞匯

詞語選擇很重要，確保你使用最適合上下文的詞匯。避免過度使用代詞，如“它”和“這”，因為讀者可能難以識別它們指的是哪個名詞。

還要避免使用俚語和粗俗的語言——請記住，你是在為更多的讀者寫作，他們的性格和文化傾向可能與你不同。

避免過多的行話

如果你是你所在領域的專家，很容易使用你熟悉的行話，而沒有意識到它可能會讓其他讀者感到困惑。

你還應該避免使用以前沒有解釋過的首字母縮寫詞，這是一個例子：

不太清楚的是：PWAs真正被認為是多平臺開發的未來。它們在 Android 和 iOS 上的可用性使其成為未來的應用。

改進：漸進式網絡應用(PWA)是真正的多平臺開發的未來。它們在 Android 和 iOS 上的可用性使 PWA 成為未來的應用。

使用簡單的語言

避免使用冗長的大詞，總是盡量以最清晰的方式解釋概念和術語。

可視化格式化

一堆文字很難讀懂，即使是最清晰的指令也可能在視覺表現不佳的文檔中丟失。

他們說，一張圖片勝過千言萬語，即使在技術寫作中也是如此。

但是，并非任何圖像都可以配上，僅用文本表達技術信息是困難的，放置恰當的圖像或圖表可以澄清你的解釋。

人們也喜歡視覺效果，所以把它們插入到正確的位置是有幫助的。看看下面的圖片：

首先，這是一個沒有視覺效果的博客片段：

這是同一博客的片段，但帶有視覺效果：

在你的文章中添加圖片，可以使內容更加貼切，更容易理解。除了圖片，你還可以在必要時使用 gif、表情、嵌入(社交媒體、代碼)和代碼片段。

貼心的格式、模板和圖片或圖表也會讓你的文字對讀者更有幫助。

仔細檢查

任何類型的好文章都必須沒有拼寫和語法錯誤。這些錯誤可能看起來很明顯，但并不總是很容易發現它們(特別是在長篇文章中)。在點擊“發布”之前，一定要仔細檢查你的拼寫。

有許多免費的工具，如Grammarly和Hemingway app，你可以用來檢查語法和拼寫錯誤。你也可以在發表前與別人分享你的文章草稿，讓他校對。

在哪里發表文章

既然你已經決定開始從事技術寫作，這里有一些不錯的平臺，你可以在那里免費發布技術內容。他們還可以幫助你建立一個吸引未來雇主的投資組合。

國內

Segmentfault 思否是中國領先的新一代開發者社區和專業的技術媒體，筆者主力發文平臺之一。

掘金 是一個幫助開發者成長的社區，特別是前端技術，現在已經是整個行業里最活躍的，筆者主力發文平臺之一。

CSDN 是全球知名中文 IT 技術交流平臺,創建于 1999 年，包含原創博客、精品問答、職業培訓、技術論壇、資源下載等產品服務，提供原創、優質、完整內容的專業 IT 技術開發社區。

知乎 有問題，上知乎。是中文互聯網知名的可信賴問答社區，致力于構建一個人人都可以便捷接入的知識分享網絡，讓人們便捷地與世界分享知識、經驗和見解，發現更大的世界。

國外

Dev.to是一個由數千名技術愛好者組成的社區，在這里，作者和讀者都可以有意義地參與并分享想法和資源。

Hashnode是我常用的博客平臺，它有很多好處，比如自定義域名映射和互動社區。在這個平臺上設置博客也很簡單快速。

freeCodeCamp 有一個非常大的社區和受眾，是一個發布你的文章的好地方。但是，你需要使用一些以前的寫作示例來申請為他們的出版物寫作。

你的申請可能被接受，也可能被拒絕，但不要灰心。你總是可以在以后重新申請，因為你變得更好，誰知道呢?你可能會被錄取。

如果你真的為他們寫文章，他們會在發布前審核和編輯你的文章，以確保你發布的文章是最精致的。他們還會將你的文章分享到他們的社交媒體平臺上，幫助更多的人閱讀。

Hackernoon 擁有超過 7,000 名作家，可以成為一個很好的平臺，讓你開始向社區中每天超過 20 萬的讀者發布你的文章。

Hacker Noon 支持作者在平臺上發布文章前對其進行校對，幫助他們避免常見錯誤。

技術寫作課程

就像其他領域一樣，技術寫作也有各種流程、規則、最佳實踐等。

參加技術寫作的課程會幫助你完成你需要學習的每一件事，也可以給你很大的信心，開啟你的寫作之旅。

你可以查看以下一些技術寫作課程：

• Google 技術寫作課程(免費)
• Udemy 技術寫作課程(付費)
• Hashnode 技術寫作訓練營(免費)

技術寫作論壇和社區

獨自一人，我們可以做得很少，但一起，我們可以做得很多——海倫·凱勒。

成為一個社區或論壇的一部分，與那些和你有同樣熱情的人一起是有益的。你可以得到反饋、糾正、技巧，甚至從社區中的其他作家那里學習一些風格技巧。

以下是一些社區和論壇供你加入：

• Hashnode
• Dev.to
• Technical Writing World
• Technical Writer Forum
• Write the Docs Forum

下面是一些令人驚嘆的技術作家

在我的技術寫作之旅中，我跟隨了一些偉大的技術作家，他們的寫作之旅、一致性和風格都激勵著我。

這些都是我仰望的作家，他們被我視為技術寫作的虛擬導師。有時，他們會給我一些技術寫作技巧，我覺得很有幫助，也從他們那里學到了很多東西。

以下是其中一些作家(與他們的 Twitter 超鏈接)：

• Quincy Larson
• Edidiong Asikpo
• Catalin Pit
• Victoria Lo
• Bolaji Ayodeji
• Amruta Ranade
• Chris Bongers
• Colby Fayock

最后的話

你不需要技術寫作的學位就可以開始發布技術內容。你可以開始在你的個人博客和公共 GitHub 知識庫上寫作，同時構建你的作品集并獲得實踐經驗。

真的——開始寫吧。

通過為現有程序或項目創建新的文檔來練習。GitHub 上有很多開源項目，你可以查看并添加到他們的文檔中。

有沒有一個你喜歡使用的應用程序，但是它的文檔寫得很糟糕?寫下你自己的，并在網上分享以獲得反饋。你還可以在 hashnode 上快速設置博客并開始寫作。

技術作家一直在學習。通過深入到新的主題領域，并接受外部反饋，一個優秀的作家永遠不會停止磨練自己的技藝。

當然，優秀的作家也是貪婪的讀者。通過檢查大量閱讀和使用的文檔，你的寫作能力肯定會得到提高。

等不及要看你的技術文章了!

參考資料

Introduction to Technical Writing??

How to structure a technical article??

Understanding your audience, the why and how

??Technical Writing template

我希望這可以幫到你。

查看本文鏈接請點擊文末左下角閱讀原文鏈接

原文：https://www.freecodecamp.org/news/technical-writing-for-beginners/

作者：Amarachi Emmanuela Azubuike

本文轉載自微信公眾號「前端全棧開發者  」，可以通過以下二維碼關注。轉載本文請聯系前端全棧開發者公眾號。