写点什么

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:465987

评论

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

手语识别技术的应用和前景

数据堂

Java 创建一个大文件

HoneyMoose

GGV 对话 Zilliz 星爵:向量数据库,开创 AI 原生数据基础软件时代

Zilliz

Milvus Zilliz AIGC 向量数据库 zillizcloud

得物社区亿级ES数据搜索性能调优实践

得物技术

推荐系统系列之推荐系统概览(下)

亚马逊云科技 (Amazon Web Services)

机器学习

文心一言 VS 讯飞星火 VS chatgpt (18)-- 算法导论4.1 5题

福大大架构师每日一题

福大大 文心一言 讯飞星火

魔兽争霸3冰封王座中文下载_冰封王座 mac下载_解除8M地图限制

Rose

魔兽争霸3 冰封王座 Warcraft III Mac游戏下载

Create Vite App 支持 OpenTiny 啦🎉

Kagol

PoseiSwap以2500万美元估值,再获新一轮融资

股市老人

IDO 前瞻,Vimverse 生态如何推动 DeFi 的深度革新?

股市老人

基于ebpf的parca-agent profiling方案探究

jupiter

ebpf profiling parca

PoseiSwap以2500万美元估值,再获新一轮融资

鳄鱼视界

ehviewer苹果下载版本2023最新版本

ehviewer

EhViewer

OKX和UniSat联手革新比特币区块链上的BRC-20

币离海

WorkPlus Knowledge:基于ChatGPT创建专属你的智能化知识库

BeeWorks

瓴羊Quick BI、帆软finebi等助力中国企业加速BI国产化替代进程

对不起该用户已成仙‖

与众不同的夜间开关交互效果

南城FE

CSS 前端 动画 交互设计 开关

私有化部署的即时通讯软件:消息、文件安全加密,全面可控

BeeWorks

数字化转型应该如何去做?(历史篇)

数字随行

数字化转型

单例模式:确保一个类只有一个实例,提高程序的可维护性和可扩展性

Jack

活动回顾|Kyligence x 亚马逊云科技,携手加速零售电商数智化转型

Kyligence

数据分析 零售行业 指标平台

Django笔记三十二之session登录验证操作

Hunter熊

Python django session session管理 登录操作

我为什么觉得数字中台是团队的新型基础设施

大东(AIP智能体运营专员)

2023-05-19:汽车从起点出发驶向目的地,该目的地位于出发位置东面 target 英里处。 沿途有加油站,每个 station[i] 代表一个加油站, 它位于出发位置东面 station[i][

福大大架构师每日一题

Go 算法 rust 福大大

机器学习平台 PAI 支持抢占型实例,模型服务最高降本 90%

云布道师

520用项目管理思维来过,相当炸裂!

禅道项目管理

获权威机构Gartner认可,瓴羊Quick BI连续四年入选魔力象限ABI报告

夜雨微澜

网络安全里的主要岗位有哪些?小白如何快速入门?

网络安全学海

黑客 网络安全 信息安全 渗透测试 WEB安全

华东手机银行用户经营洞察2023

易观分析

金融 手机银行

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