技术写作

分享:

这些问题仅向参与技术写作的受访者显示。

12% 的受访者表示参与了技术写作,但其中只有 9% 认为技术写作是其正式工作。

当被问及工作角色时,受访者能够选择多个选项。

您编写什么类型的文档?

与去年相比,编写面向客户的文档的开发者数量增加了 5 个百分点。

您使用什么工具编写文档?

更多人使用开发者工具编写文档,“文档即代码”方式越来越受欢迎。确切地说,比 2021 年增加了 6 个百分点。

您使用哪种(哪些)标记语言编写技术文档?

Markdown 仍然是最流行的标记语言,13% 的技术写作人员使用自定义 Markdown 风格来丰富其基本功能。

您是否在不同的文档/指南之间重用内容?

80% 的受访者需要重用内容,但有超过三分之一的受访者是手动复制粘贴类似内容。

6%

的文档编写者会自动执行文档检查,损坏的标记、外部链接和代码示例是最常用的测试。有趣的是,10% 还会自动执行语言检查。

58%

需要记录 API,61% 自动生成 API 文档,大部分时间选择使用 Swagger。

30%

通过配置模板自动执行日常工作,主要是自动执行不同类型的主题、文档和重复内容。

您为什么类型的内容配置模板?

47%

使用模板的受访者会创建参数化模板。

您编写文档使用的主要语言是什么?

英语是迄今为止最流行的技术文档主要语言,排在第二名的中文与其相隔较远。

68%

的技术文档撰写人考虑过使用专业工具进行技术写作。

您是否考虑过使用专业工具进行技术写作?

参与技术写作的所有受访者中有 13% 已经将文档本地化为其他语言,10% 已经有相关打算。

WritersideEAP

您属于这 68% 正在考虑使用专业文档编写工具的人吗?

加入抢先体验计划,试用编写技术文档的新工具:

  • 搭配基于 IntelliJ 的 IDE。
  • 支持 Markdown、语义标记以及两者的结合。
  • 具有超过 100 个内置文档质量自动化测试。
  • 支持通过条件和变量重用内容。
  • 具有适用于多种内容类型和复杂标记元素的内置模板。
技术写作:

2022

感谢您的参与!

我们真诚地希望您能发现我们的报告有用。与您的朋友和同事分享这份报告。

如果您有任何疑问或建议,请发送电子邮件至 surveys@jetbrains.com