内容提要
技术写作旨在将复杂技术信息以清晰简洁的方式呈现。多数专家通过参与开源社区、撰写软件操作指南入门,常用工具包括Markdown、Joplin和LibreOffice。专家建议新手不要过度犹豫,你感兴趣的话题别人也会感兴趣,你的观点可能正是他人所需。写作前应做研究并参考现有教程。Technically We Write等平台欢迎投稿分享技术写作经验。
延伸解读
从开源社区起步的实践路径
文章指出,多数技术写作专家是通过加入开源社区、撰写第一篇“操作指南”文章入行的。这意味着新手不必等待正式职位或约稿,可以从自己熟悉的开源工具入手,边用边写。这种路径降低了起步门槛,也让写作内容天然贴近真实使用场景,容易获得社区反馈。
工具选择反映写作流程差异
受访者使用的工具包括Markdown、Joplin、Asciidoctor、GNU groff、LibreOffice和Google Docs。其中Markdown常与GitHub式提交流程结合,适合开发者;Google Docs则因异步协作和自动保存受偏爱。工具没有统一答案,关键是与个人写作习惯和发布平台匹配,新手可先从Markdown或LibreOffice尝试。
克服“话题已被写过”的心理障碍
文章反复强调新手常因觉得话题已被讨论过而犹豫。但专家指出,人们尚未听过你的观点,且会花数小时甚至数月研究同一话题,你的看法可能正是别人寻找的答案。因此,写作前做研究、参考现有教程是必要的,但不必因已有内容而放弃表达自己的独特经验。
Q&A
技术写作是什么?它有什么特点?
技术写作是将复杂的技术信息以清晰、简洁的方式呈现出来的写作形式,常见例子包括智能手机使用手册、药瓶上的安全指导等。
如何开始技术写作?专家有哪些建议?
多数专家通过加入开源社区、撰写关于如何使用开源软件的“操作指南”文章入门。专家建议新手不要过度犹豫,你感兴趣的话题别人也会感兴趣,你的观点可能正是他人所需。
技术写作常用哪些工具?
写作者们分享了一些开源工具,如 Joplin、Asciidoctor 和 GNU groff。此外,Markdown 常用于写作并转换成 HTML,LibreOffice 可用于创建模板、简化重复操作、制作电子书和速查表,Google Docs 也因协作功能而受青睐。
新手在技术写作中常犯什么心理误区?
新手作者通常比较羞涩,会认为某个话题已经被讨论过了或大家都知道了,因此没必要再发表意见。但事实是,人们还没有听过你的观点,你的看法可能正是别人正在寻找的答案。
开始写一篇技术文章前应该做哪些准备?
写作前应做研究并参考现有教程。例如,Don Watkins 会先浏览 YouTube 寻找相关教程视频,了解他人如何介绍话题,然后在此基础上进行创作。Lauren Maffeo 也以研究为起点,发现特定用户群体遇到的障碍。
有哪些平台可以发表技术写作文章?
Technically We Write 是一个涵盖技术写作、技术编辑、网络内容、可用性等“技术传播”范畴的网站,于 2023 年 5 月上线,欢迎所有人分享文章。此外,OpenSource.net 也欢迎投稿。