# 技术写作入门 [译]

- Link: https://paooo.com/aigc-news/7027/
- Published: 2023-12-31T18:18:59+08:00
- Author: 宝玉的分享

技术写作无处不在——从你新买的智能手机的使用手册，到药瓶上的安全指导，都是技术写作
的体现。技术写作的最大魅力在于，它能将复杂的技术信息以清晰、简洁的方式呈现出来。

阅读目录

 * [你是如何开始技术写作的？](https://paooo.com/aigc-news/7027/#%e4%bd%a0%e6%98%af%e5%a6%82%e4%bd%95%e5%bc%80%e5%a7%8b%e6%8a%80%e6%9c%af%e5%86%99%e4%bd%9c%e7%9a%84)
 * [你平时用什么写作工具？ ](https://paooo.com/aigc-news/7027/#%e4%bd%a0%e5%b9%b3%e6%97%b6%e7%94%a8%e4%bb%80%e4%b9%88%e5%86%99%e4%bd%9c%e5%b7%a5%e5%85%b7%c2%a0)
 * [想要开始技术写作应该注意什么？](https://paooo.com/aigc-news/7027/#%e6%83%b3%e8%a6%81%e5%bc%80%e5%a7%8b%e6%8a%80%e6%9c%af%e5%86%99%e4%bd%9c%e5%ba%94%e8%af%a5%e6%b3%a8%e6%84%8f%e4%bb%80%e4%b9%88)
 * [您通常如何开启一篇技术性文章的写作？](https://paooo.com/aigc-news/7027/#%e6%82%a8%e9%80%9a%e5%b8%b8%e5%a6%82%e4%bd%95%e5%bc%80%e5%90%af%e4%b8%80%e7%af%87%e6%8a%80%e6%9c%af%e6%80%a7%e6%96%87%e7%ab%a0%e7%9a%84%e5%86%99%e4%bd%9c)
 * [发表文章的地方](https://paooo.com/aigc-news/7027/#%e5%8f%91%e8%a1%a8%e6%96%87%e7%ab%a0%e7%9a%84%e5%9c%b0%e6%96%b9)

虽然技术写作听起来可能有些棘手，但实际上，我们大多数人都可以尝试一下。毕竟，每个人
都有自己的专长，可能是教别人使用新的软件程序、解决技术问题，或是组装家具。

在今年的全国写作日上，opensource.net 采访了五位技术写作领域的专家，了解他们是如何
入行的，以及他们使用的工具。

> “一旦你掌握了 Markdown，你就不会再去关注它的技术细节……但初学阶段，了解所有这些
> 知识确实感觉像是个巨大的挑战。”
> 作者 Lauren Maffeo

##  **你是如何开始技术写作的？**

多数专家是通过加入开源社区，撰写第一篇关于如何使用开源软件的“操作指南”文章，开始
了他们的技术写作之路。

**Chris Hermansen:** 通常，我主要从事计算机相关工作，比如分析同事在现场收集的数据……
但从这样的位置出发，想要分享自己的专业知识并不容易，尽管可能有很多人都在做类似的
事情，但缺乏有组织的、积极的群体。我开始思考如何真正地做出贡献……我觉得我为那些使用
与我相同的开源工具的社区贡献了自己的价值。

##  **你平时用什么写作工具？** 

写作者们分享了一些开源工具，如 Joplin、Asciidoctor 和 GNU groff。

**Lauren Pritchett:** “以前我写作比较频繁时，喜欢在 Atom 或类似的编辑器里用 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 分钟对话。

**🚀 Prompt 语宙 AI 创作者生态：**探索 2,000+ 全球实用 AI 工具与高精度生图提示词
咒语库

[🧭 语宙 AI 导航 (ai.paooo.com)](https://ai.paooo.com/)[🎨 AI 生图 Prompt 库](https://paooo.com/ai-image-prompts/)
[⚡ AIGC 早报生成器](https://paooo.com/mtool/)
