WriterSide：JetBrains 推出的技术文档创作工具

背景与目标

JetBrains 推出的 WriterSide 旨在帮助开发者和技术文档作者通过“编写、测试、构建”的工作流程创建技术文档。该工具基于 IntelliJ 平台的 IDE，并在过去几年中用于创建 JetBrains 大部分产品的文档。其开发灵感来源于数百次客户访谈和超过十年的 IntelliJ 平台文档编写经验。

主要功能

1. 协作与流程优化
   WriterSide 的核心目标之一是促进开发者与文档作者之间的高效协作，弥合两者之间的差距。它采用“文档即代码”的流程，基于 Git、拉取请求和自动化检查等开发工具，使整个团队能够像处理代码一样参与文档的编写、评审和变更跟踪，从而简化文档流程。
2. 多格式支持
   支持 Markdown 和自定义的 XML 标记语言，并允许在同一文档中混合使用这两种格式。用户可以在 Markdown 文档中注入语义属性以增强内容，同时也支持将 Markdown 片段动态转换为 XML 并导入 XML 文档。
3. 自动化测试
   内置超过 100 种测试，包括检查断链、缺失资源、错误属性值等。测试可根据内部拼写和样式规范进行定制，确保文档质量。
4. 设计与布局
   提供预定义的设计模板，支持轻松自定义，使作者无需处理布局和 CSS 等细节。
5. 实时预览
   包含实时预览功能，能够即时反映每次更改并突出显示错误。这在无法访问 CI/CD 管道或构建时间较长时尤为有用，使作者无需等待构建完成即可检查输出。
6. AI 辅助
   内置由 JetBrains 开发的 AI 拼写检查器和语法纠正工具，支持超过 25 种语言。

获取方式

WriterSide 目前以两种形式提供：

• JetBrains IDE 插件：可通过 插件市场 下载。
• 独立应用程序：作为 早期访问计划 (EAP) 的一部分提供。

定价

在 EAP 期间，WriterSide 完全免费。JetBrains 承诺未来将提供免费版本或持续开放的 EAP，以确保用户可以继续免费使用该工具。