JetBrains 推出了一款名为 Writerside 的 IDE,该 IDE 基于 IntelliJ 平台,目前正处于早期测试状态,可以作为 JetBrains IDE 中的插件使用,也可以作为独立工具使用

16975344867171000.webp

▲ 图源 JetBrains

JetBrains 声称,Writerside 允许开发者在产品文档、API 参考、指南、教程和操作方法方面进行协作,该工具同时搭载了基于 AI 的拼写检查和语法纠正工具,支持超过 25 种语言,包括英语、德语、西班牙语和中文。

发现,官方介绍该工具的亮点如下:

16975344875091000.webp

▲ 图源 JetBrains
  • 文档即代码环境(Docs-as-code pipeline)

  • 该工具内置 Git UI,号称“用户可以专注于最重要的内容,无需设计布局和处理 CSS”。

  • 支持 Markdown、XML 组合使用(Markdown and XML combined)

  • 开发者可以注入语义属性或语义元素来丰富 Markdown,并且 Markdown 元素可以转换为 XML。

  • 文档内容检测(Doc quality automation)

  • 附带 100 多个内置测试,允许 Writerside 自动测试损坏的链接、丢失的资源、不正确的属性值、非唯一 ID 等。具有代码高亮显示和验证功能,以及内置检查。

  • 实时预览(Live preview)

  • 文档按照用户“所看到的方式”显示,无需等待构建。

  • 单一来源(Single-source)

  • 用户能够重用部分内容并仅从一个位置对其进行编辑,而不必在进行更改时更新每个实例。

  • 合并文档内容(REST API docs generation)

  • 用户创建用户文档和 API 参考时,不再需要“在不同工具之间跳转“,可以将 API 文档合并到帮助网站中,使用手动编写的内容补充自动生成的参考。

参考

广告声明:文内含有的对外跳转链接(包括不限于超链接、二维码、口令等形式),用于传递更多信息,节省甄选时间,结果仅供参考,所有文章均包含本声明。