导读：这个消息应该是喜大普奔的，写文档这个活有工具帮助咱们干了。

技术文档的今生来世

开发者们花费大量时间编码和构建新产品、服务和技术，但所有这些代码在上线后都需要维护，在不同阶段，特别严谨的软件开发流程，需要有大量的设计文档，详细文档。即便是缺少设计文档，也要在后期有一些资料来记录它的功能以及它是如何做的。

对于一些开发者来说，写代码是很快乐的事，但写文档属实不容易，但是如果不写，后期会引更多不必要复杂度。

技术文档的重要性

文档对于开发人员的生产力和客户满意度非常重要，它可以决定产品的采用或失败。

根据GitHub 2022 年的一份报告数据，通过易于理解的文档，开发人员的生产力提高了近 50% 。

Writerside 诞生

大家知道，JetBrains是一家为各种编程语言设计项目管理和集成开发环境的软件公司，它以产品创新和敏捷著称。

今天，它宣布“抢先”推出一个名叫Writerside，这是一种技术文档的创作与发布解决方案。

下载地址：https://www.jetbrains.com/writerside/

当然，这意味着编写代码和添加行注释时的最佳实践，但它也意味着它能提供产品文档、应用程序编程接口参考、教程、开发人员指南和操作方法等，通过与技术作家合作，以帮助未来的开发者们更好的使用代码或工具。

如今，人们借助 Writerside，编写技术文档的功能将可以直接引入 JetBrains IDE，开发者可以在其中编写代码，并且可以作为独立工具。使用该工具可以让文档编写人员访问与开发人员相同的工具（例如 Git、构建管道和自动检查），从而简化整个生命周期中文档的准备工作。

“通过 Writerside，我们希望为作者提供开发人员长期使用的工具，” JetBrains 产品负责人 Anna Gasparyan 说。“不幸的是，当今技术文档仍然经常被忽视，技术作家也没有得到他们应有的认可或支持。”

“我们的使命是弥合开发人员和作家之间的差距，并使文档成为一项团队运动，”加斯帕里安说。

Writerside 的特性

为了使 Writerside 文档最大化的可扩展，这个工具支持使用 Markdown 和基于 XML 的语义标记，以及将两者结合起来的能力。这表示着这些元素可以查询，并能够提取函数和代码的链接，跳回 API 参考和文档部分。

一切都可以重复使用，包括较小的内容或整个部分。可以设置一个部分，使它只需要更新一次并在各处进行更改，或者根据设定的规则有条件地更新它。

它有 100 多种不同的内置测试，允许 Writerside 自动测试损坏的链接、丢失的资源、不正确的属性等。这样的能力，作者就能够在发布之前知道该文档是否与内部风格或其他品牌元素不匹配，这样它就可以在整个资产中保持一致。

作者将能够完全模拟读者想看到的样子查看文档，而无需等待渲染（包括自定义样式），预览功能会突出显示潜在的错误，从而使测试变得更加容易。我们将它们扩展到整个网站建设，这使得可以查看是否存在导航错误，并且可以在浏览器中访问。

想要在 Writerside 中打造自己个性化体验的用户也没有被排除在外，自定义选项包括浅色和深色模式、柔和或更生动的皮肤。公司还可以对输出的资源进行品牌化以适应其公司的审美，如此一来作者可以轻松地制作文档，而不必担心样式、布局或 CSS。

在产品的幕后，Writerside 还包含 JetBrains 自己的基于人工智能的拼写检查和语法纠正工具，旨在让作者保持写作流畅性。

Writerside 的其它功能也不少，包括如下：

• 内置 Git UI。

• 实时预览，文档完全按照读者所看到的方式显示，无需等待构建。

• 支持 Markdown、XML 或两者的组合使用。开发人员可以注入语义属性或语义元素来丰富 Markdown，并且 Markdown 元素可以转换为 XML。

• 即用型设计，提供定制选项，包括选择深色或浅色模式、对比度、柔和或生动的皮肤，以及定义适合品牌的强调色。作者可以专注于内容，而无需设计布局和处理 CSS。

• 对断开的链接、丢失的资源、不正确的属性值和非唯一 ID 进行自动测试。具有代码突出显示和验证功能，以及内置检查。

• 维护项目的单一事实来源可供内容重用。

Writerside 使用 JetBrains 的拼写检查和语法工具，该工具使用 AI 进行更正。目前Writerside已经支持超过25种语言，包括英语、德语、西班牙语以及中文。

Writerside 现已作为 JetBrains IDE 的插件和独立应用程序，并以抢先体验模式推出，可为文档编写者、技术作者提供专业的创作能力。

作者：场长