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制成的❤️