硬核干货——《中小企业 AI 实战指南》免费下载! 了解详情
写点什么

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

  • 2023-11-27
    北京
  • 本文字数:771 字

    阅读完需:约 3 分钟

大小:372.35K时长:02:07
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/

2023-11-27 13:465938

评论

发布
暂无评论
发现更多内容

一只黔灵山猴子,溜进「智能世界」

脑极体

AI

用实时计算释放当下企业大数据潜能

Apache Flink

大数据 flink 实时计算 大数据计算与存储

前波士顿咨询Platinion董事总经理陈果加入望繁信科技

望繁信科技

流程挖掘 流程资产 流程智能

人社大赛算法赛场解题思路分享+冠军+破灭刀锋

阿里云天池

【攻略】第三届数据库大赛创新上云性能挑战赛-高性能分析型查询引擎赛道-冠军

阿里云天池

用友YonData如何刷新企业数据管理与应用新高度?

用友BIP

JNPF再进化,低代码革命让数字化无处不在

不在线第一只蜗牛

低代码

大模型营销战,“砸钱”能缓解商业化焦虑?

趣解商业

百度 腾讯 互联网 大模型

智谱清言 App 面向 C 端开放 AI 视频通话服务;谷歌 GameNGen:神经网络驱动的实时游戏引擎丨RTE 开发者日报

声网

源于清华的开源时序数据库IoTDB刷新世界纪录

Apache IoTDB

阿里巴巴商品详情API返回值中的关联商品推荐

技术冰糖葫芦

api 网关 API Explorer API 策略

如何判断全面预算和EPM软件架构是否符合技术规范?

智达方通

数字化转型 多维数据库 企业绩效管理系统 管理会计信息化 新ERP

实战演练:利用京东API一键抓取商品详情

技术冰糖葫芦

api 网关 API Explorer API 策略

免费高效!3步实现Llama3模型远程访问与协作

贝锐

AIGC Llama3 贝锐

体验了下豆包MarsCode编程助手,惊艳到我了!

左诗右码

AI

AI自动化副业创收班手把手带你提升副业收益

霍格沃兹测试开发学社

openGauss- 索引推荐

Gauss松鼠会

opengauss

9月7-8日,Rust China Conf 2024 来啦!

Mike Tang

开源 rust 上海 rust conf rust开发者大会

场景题:如何提升Kafka效率?

王磊

揭秘| 用友坚持做大模型的原因

用友BIP

AI+营销:AI赋能企业大客户经营更高效、更智能

用友BIP

天翼云HBlock:打造高效、安全、可扩展的云存储体验

百里丶落云

磁盘 数据库· HBlock #天翼云 #HBlock

视频云流化是什么?有哪些好处

3DCAT实时渲染

云流化 云流化PaaS平台 实时渲染云流化

(约230个工具)野兔在线工具箱系统最新版本V4.0.1更新

网站,小程序,APP开发定制

阿里云数智服务创新挑战赛总决赛铜奖比赛攻略_NJUSME队

阿里云天池

JetBrains推出基于IntelliJ平台的技术文档写作工具WriterSide_团队搭建_Sergio De Simone_InfoQ精选文章