JetBrains 推出基于 IntelliJ 平台的技术文档写作工具 WriterSide

JetBrains 推出 WriterSide，旨在让开发人员和技术文档人员可以通过编写、测试、构建这个工作流来创建技术文档。这个工具基于 intellij 平台 IDE，在过去的几年里，它已经被用于创建大部分 JetBrains 产品的文档。

这个项目是在数百次客户访谈和 10 多年的 IntelliJ 平台文档工作的基础上开发出来的。它们让我们知道需要开发哪些功能和解决哪些问题。

WriterSide 的一个主要目标是在开发人员和作者之间实现有效的协作，弥合他们之间的差距。它基于开发工具 (如 Git)、拉取评审和自动检查，强制执行“文档即代码”管道流程，让整个团队能够像处理代码一样贡献、评审和跟踪变更。JetBrains 表示，这极大简化了文档管道流程。

WriterSide 支持 Markdown 和自定义的基于 XML 的标记，并允许文档作者在同一文档中组合这两种格式。例如，作者可以向 Markdown 文档中注入语义属性。WriterSide 还支持动态地将 Markdown 片段转换为 XML，并将它们导入到 XML 文档中。

WriterSide 内置了 100 多种检查，例如无效链接、缺失的资源、不正确的属性值等。可以根据企业内部的拼写和样式约定来定制检查。WriterSide 还提供了预定义的设计，可以很容易进行定制，这样文档作者就不需要处理与布局和 CSS 相关的问题。

由于文档作者需要编写 XML 或 Markdown，因此 WriterSide 提供了一个实时预览功能，可以立即反映每个更改并高亮显示错误。这在无法访问 CI/CD 管道或构建时间较长的情况下特别有用，可以在不等待输出完成的情况下检查输出。

WriterSide 还提供了一个基于人工智能的拼写检查器和一个由 JetBrains 构建的语法纠正器，支持超过 25 种语言。

WriterSide 既可以作为 JetBrains IDE 插件使用，也可以作为独立应用程序运行（Early Access Program (EAP)）。该产品在 EAP 期间是完全免费的，但 JetBrains 承诺他们将提供免费版本或可以继续免费使用该工具的 EAP。

原文链接：

https://www.infoq.com/news/2023/10/jetbrains-writerside/

声明：本文由 InfoQ 翻译，未经许可禁止转载。