technical writing resources

大綱

• 大綱
• 資源
• 什麼是技術寫作？
• 文章
• 圖書
• 課程
• Youtube
• 社區
• 寫作工具
• 文檔工具
• 誰支付技術作家
• 開源項目
  • 開源項目/計劃技術作家可以為
• 遵循出色寫作內容的博客
• 準備技術寫作面試
• 發表文章的網站
• 技術寫作角色的工作委員會

資源

該存儲庫包含不同的技術寫作資源，這些資源已經從互聯網上收集

什麼是技術寫作？

技術寫作是一種溝通形式，可幫助用戶解決技術問題。這是創建清晰，簡潔和信息豐富的內容，旨在以一種易於被預期的受眾理解的方式傳達複雜的信息。

它通常涉及編寫手冊，指南，報告和文檔，以解釋技術概念，過程或產品。

文章

• 超越博客文章的技術寫作
• 如何開始技術寫作
• 如何成為技術作家
• 初學者的技術寫作 - AZ技術博客基礎知識指南
• 技術寫作：什麼以及如何？
• 如何免費學習技術寫作
• 開始技術寫作
• 技術寫作建議
• 如何編寫讀者會根據用戶心理學的學習來閱讀的內容
• 如何創建技術寫作作品集
• 為軟件開發人員編寫技巧 - 如何成為更好的技術作家
• 編寫API文檔的11種最佳實踐
• 技術寫作與技術博客

圖書

• 寫得很好〜朱利安·夏皮羅

• 技術寫作，簡化〜Nell Johnson

• 為Sotware開發人員寫〜Philip Kiely

• 假人的技術寫作〜Sheryl Lindsell-Roberts

• 開發人員的文檔：工程師的技術寫作現場指南〜Jared Bhatti

• 現代技術寫作：軟件文檔簡介〜Andrew Etter

• 每個人都寫：您創建可笑的良好內容的首選指南〜Ann Handley

• 寫得很好〜William Zinsser

• 技術交流〜Mike Markel

課程

• 工程師的技術寫作課程
• 技術寫作：如何編寫軟件文檔
• 學習API技術寫作：作家的JSON和XML
• API文檔的藝術
• 記錄API：技術作家和工程師指南
• 技術作家認證課程〜技術作家認證課程是為有抱負的技術作家或想要提高其技術寫作技巧的人們創建的。
• Devs 〜SEO的SEO是開發的免費2週課程，可幫助人們以系統的方式發現您的技術博客或附帶項目
• 開發人員的API文檔〜創建和維護API文檔的動手指南。

Youtube

• Doctohelptv
• 技術作家總部
• Amruta Ranade
• 威廉·史密斯
• 如何成為技術作家|技能和職業發展

社區

社區可以提供寶貴的學習機會，成長，指導和職業發展。與有興趣相似的人建立聯繫是人們加入社區的原因之一。以下是技術作家可以加入的一些社區：

• 寫文檔
• DocNext
• hackmamba
• LinkedIn技術寫作社區
• 全球作家社區
• API文檔組
• 技術作家論壇
• hashnode
• 好的文檔項目社區
• techwriters.dev
• R/技術寫作

寫作工具

• Canva〜Canva是一個圖形設計平台，用於創建社交媒體圖形，演示文稿，海報，文檔和其他視覺內容。
• removebg〜一種用於刪除圖像背景的工具。
• Markdown〜Markdown是Web作者的文本到HTML轉換工具。
• Asciidoc〜Asciidoc是一種輕巧和語義標記語言，主要是為編寫技術文檔而設計的。
• Denigma〜Denigma是一種用可理解的英語解釋代碼的工具。
• 語法〜語法是一位打字助手，可以審查拼寫，語法，標點符號，清晰度，參與度和交付錯誤。
• Hemingway應用程序〜海明威應用程序是一個網絡和桌面應用程序，可以改善您的寫作風格並修飾內容。
• Quillbot Ai〜quillbot AI是一種多功能寫作工具，可以幫助改善您的寫作風格。它的一些產品是釋義者，語法檢查器，竊式檢查器，共同作家，摘要，引用發生器和Word Counter。
• 概念〜概念是您的筆記，任務，Wiki和數據庫的多合一工作空間。您可以使用它來組織您的思想，項目和信息。
• Dropbox Paper〜Dropbox Paper是一個在線文檔工作區，您可以在一個地方組織和顯示文本，媒體和文件。
• GoFullPage-完整頁面屏幕捕獲〜鍍鉻擴展名taht允許您使用當前瀏覽器窗口的全頁屏幕截圖。
• 碳〜Carbon是創建和共享源代碼美麗圖像的最簡單方法。
• ISITWP〜ISITWP標題分析儀工具可幫助您編寫搜索結果中流量，共享和排名更好的標題。
• 資本化我的頭銜〜使您的寫作簡化標題資本化
• WordTune 〜WordTune將文本變成簡潔，引人入勝，寫得很好的消息。
• 標題分析儀〜寫標題，以推動流量，共享和搜索結果。
• 標題生成器〜為文章和博客文章生成了出色的標題。
• SEO寫作助理〜聰明的寫作編輯器，可幫助您優化副本以進行參與和SEO。
• hackmd〜合作的降價編輯器，用於分享您的文章並從其他人那裡獲得反饋。
• copyscape〜竊檢查器
• MarkDoc〜Markdown的超集用於創建自定義文檔網站。它是由Stripe創建的，並於2022年5月製作了開源。
• WordTune〜WordTune是一個具有智力的寫作伴侶，可以通過清晰，引人注目和真實的寫作來確切地說出您的句子。

文檔工具

• GitBook〜一個現代文檔平台，團隊可以記錄從產品到內部知識庫和API的所有內容。
• 閱讀文檔〜一個用於託管，構建和版本控製文檔的開源平台。
• Docusaurus〜一個靜態網站生成器，可輕鬆構建開源項目網站。
• Sphinx〜將重組文件轉換為HTML網站和其他格式的文檔生成器。
• mkdocs〜一個快速，簡單且靜態的站點生成器，旨在構建項目文檔。
• Swagger〜一套用於API文檔的工具，包括Swagger Editor，Swagger UI和Swagger Codegen。
• Postman〜一個用於API開發的協作平台，可輕鬆創建，共享，測試和文檔API。
• Slate〜專門為API文檔設計的靜態站點生成器。
• REDOC〜一個開源工具，用於從OpenAPI（以前稱為Swagger）定義生成API文檔。
• DOCZ〜一種用於使用MDX和Live-Reload支持的React組件編寫文檔的工具。
• Jekyll〜一個靜態網站生成器，將純文本轉換為靜態網站和博客。
• 雨果〜用GO編寫的快速靈活的靜態站點生成器。
• Antora〜文檔網站生成器，用於創建文檔門戶和技術文檔網站。
• Vuepress〜一個由VUE.JS驅動的靜態站點發生器
• Asciidoctor〜一種快速的文本處理器和發布工具鏈，用於將ASCIIDOC內容轉換為HTML5，DOCBOOK，PDF和其他格式。
• Confluence〜一種協作工具用於幫助團隊有效地協作和共享知識。
• MadCap Flare〜一種全面的技術創作和發布工具，用於為各種輸出創建內容。

誰支付技術作家

為組織和出版物撰寫技術內容是賺取額外收入的絕佳方式。這樣，您會學到很多東西，然後分享您的知識並獲得報酬。查看這些支付技術作家的組織的這些編譯列表。

• 社區作家計劃
• 得到這45多個網站的薪水
• 付給您撰寫技術文章的出版物

開源項目

為開源做出貢獻可能是學習，教學和建立經驗的一種有益的方式，幾乎可以想像。出於不同的原因，許多PEOLE為開源貢獻了，而至關重要的是提高了自己的技能。

這裡有一些文章，可以幫助您了解如何為開源項目做出貢獻。

• 技術作家的開源
• 《技術作家指南》為開源項目做出貢獻
• 如何為技術作家做出貢獻
• 成為擁有開源貢獻的技術作家的4個技巧
• 作為技術作家的開源開始

開源項目/計劃技術作家可以為

• CodeCademy Docs〜文檔是針對流行的編程語言和框架的社區驅動的代碼文檔集合。
• 好的文檔項目〜好的文檔項目是一個社區，共同創建模板，工具和資源，以提高OSS及更高版本中文檔的整體質量。
• Docs的Google季節〜文檔季節為開源項目提供了支持，以改善其文檔，並為專業技術作家提供了獲得開源經驗的機會。
• Hacktoberfest〜hacktoberfest是一場年度活動，旨在鼓勵人們在10月為開源做出貢獻。
• Gnome文檔項目

遵循出色寫作內容的博客

• Techwriters Hub
• 凱西·帕克（Kesi Parker）
• iDratherbredriting
• 一切技術寫作
• Writetech Hub
• hackmamba

準備技術寫作面試

有幾個技巧可以幫助您吸引面試，但其中一些重要的提示是量身定制的簡歷和求職信。查看這些求職信模板和提示，以幫助您吸引下一次面試：

• 下一份工作的求職信模板
• 如何寫一封誘人的求職信
• 如何撰寫技術作家簡歷[+示例]
• 最佳技術作家求職信示例和格式

以下是一些用於技術寫作面試問題的資源，以幫助您為下一次面試做準備。

• 12個技術作家面試問題和答案
• Google技術作家面試問題
• 技術寫作面試

發表文章的網站

• Hashnode〜hashnode是一個免費的開發人員博客平台，可幫助您與技術，開發人員和工程師的人分享您的想法。
• Medium〜Medium是一個具有許多用戶的社交出版平台，您可以發佈各種內容和想法。
• dev.to〜dev.to是程序員共享想法並互相幫助的地方。它是一個在線社區，用於共享和發現很棒的想法。
• Mirror.xyz〜irror.xyz是一個利用加密貨幣和區塊鏈技術的作家的出版平台。
• FreecodeCamp〜FreecodeCamp是一個非營利組織，由一個互動學習網絡平台，在線社區論壇，聊天室，在線出版物和本地組織組成，他們打算使任何人都可以訪問學習網絡開發。

技術寫作角色的工作委員會

• 技術作家的最高職位

• startup.jobs

• 井井有條

• 最好的寫作工作

由Damilola Ezekiel製成的❤️