开始技术写作

技术写作无处不在。从您新智能手机的用户手册到药品瓶上的安全说明，技术写作就在我们身边。在最好的情况下，它以清晰简洁的方式传达复杂的专业信息。

虽然技术写作可能看起来令人生畏，但这实际上是大多数人都可以尝试掌握的一项技能。毕竟，我们都有东西可以教给别人，无论是如何使用新的软件程序、排除故障还是组装一件家具。

为了今年的全国写作日，opensource.net 采访了五位技术写作专家，了解他们是如何入门以及他们使用哪些工具的。

您是如何开始技术写作的？

大多数参与讨论的专家都是从加入开源社区开始的。撰写我们第一篇关于使用开源软件的“操作指南”文章是爱上写作的常见入门方式。

Chris Hermansen: 总的来说，我一直从事计算机方面的工作，参与分析我的同事在现场收集的数据……从这个立场回馈您的专业知识是很困难的，因为可能很多人都在这样做，但没有任何有组织的、积极的团体。 这就变成了一个如何真正回馈的问题……我觉得我正在为那些使用与我相同的开源工具的社区提供价值。

您使用哪些工具进行写作？ 

作者们提到了许多开源选项，包括  Joplin, Asciidoctor 和 GNU groff。

Lauren Pritchett: “当我还更频繁地写作时，我喜欢在 Atom 或类似的东西中使用 Markdown 编写，然后将其放入 Markdown 到 HTML 的转换器中，并将其放入 Drupal……我真的很喜欢使用 LibreOffice，因为它能够创建模板、重复流程、电子书和速查表……”

Lauren Maffeo: 所有 Pragmatic Bookshelf 的作者都使用 Markdown 编写他们的书。它是精简出版，相当于 GitHub，您可以在其中合并计算机中草稿的本地版本，然后将这些更改提交到主文档。它是一个围绕开发人员和技术人员构建的工作流程——几乎与您在 GitHub 上进行提交和拉取请求（使用代码）时的体验相同。它不是很直观，我更喜欢 Google Docs，不仅仅是为了异步协作，还为了自动保存、添加实时反馈以及无缝整合编辑的反馈的机会……”

您对想要开始技术写作的人有什么建议？

本次讨论的一个主题是不要想太多。如果您觉得某个主题有趣，其他人也会觉得有趣。 

Lauren Pritchett: 通常新作者都很胆怯。他们会说，“好吧，你知道这个主题以前有人写过，或者大家都已经知道了，所以我不需要再添油加醋了。”  但事实是人们还不知道您对此的看法，而且人们会花费数小时、数周、数月来研究一个主题……您的看法可能正是解决某人问题的答案。

您通常如何开始撰写技术文章？

Don Watkins: “如果我正在写关于一个简单的屏幕录像机，我会去 YouTube 上查找所有操作指南，了解其他人是如何谈论它的，然后再从那里开始。这种研究真的非常重要。”

Lauren Maffeo:  我也从研究开始——既作为一名作者，也作为一名服务设计师。  简而言之，服务设计意味着您是项目中用户的拥护者。这与成为开发人员拥护者非常相似。基本上，您的工作是识别特定用户群体的产品或服务中存在的摩擦。  您还需要确定合适的用户群体，并与这些用户群体中的一系列人员交谈…… 

在哪里发布

专家组还谈到了 Technically We Write，这是一个使用开源工具撰写关于写作文章的好地方。Technically We Write 是一个关于技术写作、技术编辑、网络内容、可用性以及任何其他属于“技术交流”类别的网站。该网站于 2023 年 5 月推出，欢迎所有人分享文章，而开源软件写作工具是一个很好的起点。例如，您可以下载 LibreOffice 并撰写一篇关于“我第一次尝试 LibreOffice，这是我周末学会做的三件事”的文章。  访问 ‘如何投稿‘ 了解更多信息。

加入 OpenSource.net 社区并与我们分享您的第一篇文章！我们正在寻找关于开放知识的想法或文章。点击 ‘提交文章‘ 链接开始。

观看 YouTube 上完整的 45 分钟对话。

照片由 Jo Szczepanska 在 Unsplash 上拍摄