JetBrains запускает инструмент для работы с документацией Writerside

Компания JetBrains выпустила в раннем доступе инструмент Writerside, помогающий разработчикам и техническим писателям создавать техническую документацию. Он основан на собственном внутреннем инструменте компании JetBrains для создания документации по своим программным продуктам.

По словам представителей JetBrains, Writerside позволяет разработчикам и техническим писателям совместно создавать документацию по продуктам, описывать API, создавать учебные пособия, руководства для разработчиков и инструкции непосредственно в своей любимой IDE JetBrains или с помощью отдельного инструмента, построенного на той же платформе.

Инструмент используется в JetBrains уже более 10 лет, и, по словам команды, продукты JetBrains, от языка программирования Kotlin до IntelliJ Platform SDK, используют Writerside для создания своей документации.

Анна Гаспарян, руководитель направления Writerside в JetBrains, сказала: «Если технические писатели используют те же инструменты, что и разработчики, такие как Git, автоматическая проверка и конвейеры сборки, это не только обеспечивает качество конечного продукта, но и облегчает всей команде работу над документами, их рецензирование и отслеживание изменений».

Writerside поддерживает как Markdown, так и собственную семантическую разметку на основе XML, а также их совместное использование. Пользователи могут вводить семантические атрибуты или целые семантические элементы, а также «на лету» преобразовывать фрагменты Markdown, присланные другими участниками, в XML.

Инструмент автоматически проверяет наличие неработающих ссылок, отсутствующих ресурсов, неверных значений атрибутов и неуникальных идентификаторов. Имеется подсветка и валидация кода «на лету» со встроенными инспекциями. Также можно автоматизировать проверку на соответствие собственным орфографическим и стилистическим соглашениям.

После создания документа есть возможность предварительного просмотра в реальном времени, Writerside показывает, как будет выглядеть документ с подсветкой ошибок. По мнению JetBrains, это напрямую решает проблемы ограниченного доступа к CI/CD или длительных сборок для небольших обновлений.

Writerside использует основанный на искусственном интеллекте инструмент проверки орфографии и исправления грамматических ошибок, созданный компанией JetBrains и поддерживающий более 25 языков, включая английский, немецкий, испанский и китайский.

Writerside доступен как плагин для IDE JetBrains и как отдельное приложение.