Writerside是一款由JetBrains推出的文档编写工具,它以其独特的功能和简洁的界面设计,为开发者提供了一个全新的文档编写体验。
Writerside既可作为JetBrains IDE的插件使用,也可作为独立工具运行。它主要面向开发者、文档编写人员以及团队成员,旨在帮助他们更高效地进行文档编写、协作和发布。
文档即代码环境
- 内置Git UI:Writerside内置了Git UI,使用户无需过多关注布局和CSS设计等细节,可以专注于编写核心内容。
- 集成构建工具:支持集成式构建工具,方便用户进行文档的构建和发布。
支持多种格式
- Markdown与XML组合使用:Writerside支持Markdown和XML两种格式,并允许开发者在同一文档中组合使用这两种格式。开发者可以在Markdown中注入语义属性或元素,以丰富内容,并将Markdown元素转换为XML。
- 动态转换:Writerside支持动态地将Markdown片段转换为XML,方便用户根据需求选择最适合的格式。
文档质量检查
- 内置检查:Writerside内置了超过100项检查,包括无效链接、缺失的资源、不正确的属性值等,帮助用户及时发现并修复问题,提高文档的质量。
- 自动化测试:通过编辑器中的自动化测试,确保文档的完整性和准确性。
实时预览
- 即时反馈:Writerside提供了实时预览功能,可以立即反映每个更改并高亮显示错误,使文档内容能够按照用户实际看到的方式实时显示,无需等待构建完成。
- 多平台预览:用户可以在IDE中预览单个页面,或者在浏览器中打开整个帮助网站而不必运行构建,方便在不同平台上查看文档效果。
内容重用
- 单一来源:Writerside支持从较小的内容块到整个主题或目录部分的重用,提高了文档编写的效率。
- 灵活使用:通过灵活使用筛选器和变量,用户可以根据需要快速调整文档内容,确保文档的准确性和一致性。
协作与整合
- 团队协作:Writerside支持多人协作,可以方便地共享文档和编辑内容,提高团队协作的效率。
- 整合工具:Writerside基于开发工具(如Git)、拉取评审和自动检查,强制执行“文档即代码”管道流程,让整个团队能够像处理代码一样贡献、评审和跟踪变更。
语言支持
- 多语言支持:Writerside支持超过25种语言,包括英语、德语、西班牙语和中文等,方便用户根据需要进行多语言文档的编写和发布。
- 拼写与语法检查:提供了基于人工智能的拼写检查器和一个由JetBrains构建的语法纠正器,提高文档的准确性和可读性。
REST API文档生成
- 合并与发布:Writerside允许用户将API文档合并到帮助网站中,以相同的布局发布,并通过手动编写的内容补充自动生成的参考。
- 无缝切换:在创建用户文档和API参考时,用户无需在不同工具之间跳转,提高了文档编写的效率。