Инструмент используется в JetBrains уже более 10 лет, и, по словам команды, продукты JetBrains, от языка программирования Kotlin до IntelliJ Platform SDK, используют Writerside для создания своей документации.
Компания JetBrains выпустила инструмент под названием Writerside в режиме раннего доступа. Этот инструмент разработан для помощи разработчикам и техническим писателям в создании технической документации. Writerside основан на внутреннем инструменте компании JetBrains, который они использовали для создания документации к своим программным продуктам.
По словам представителей JetBrains, Writerside позволяет разработчикам и техническим писателям совместно работать над документацией для продуктов. Это включает в себя описание API, создание учебных материалов, руководств для разработчиков и инструкций, прямо в их любимой среде разработки JetBrains (IDE) или с использованием отдельного инструмента, созданного на той же платформе.
Этот инструмент уже более 10 лет используется в компании JetBrains, и, согласно команде, продукты компании, включая язык программирования Kotlin и платформу IntelliJ SDK, используют Writerside для создания своей документации.
Анна Гаспарян, руководитель направления Writerside в компании JetBrains, отмечает: "Если технические писатели используют те же инструменты, что и разработчики, такие как Git, автоматическая проверка и сборочные процессы, это способствует не только качеству конечного продукта, но и упрощает всей команде процесс работы над документацией, рецензированием и отслеживанием изменений".
Writerside поддерживает как Markdown, так и собственную семантическую разметку на основе XML, и позволяет пользователям вводить семантические атрибуты и элементы, а также "на лету" преобразовывать фрагменты Markdown, предоставленные другими участниками, в XML.
Инструмент автоматически проверяет наличие неработающих ссылок, отсутствие ресурсов, неверные значения атрибутов и дублирующиеся идентификаторы. Кроме того, он обеспечивает мгновенную проверку кода с встроенными инспекциями. Writerside также позволяет автоматизировать проверку соблюдения собственных орфографических и стилистических правил.
После создания документа пользователи могут просматривать его в режиме реального времени с подсветкой ошибок. Это, по мнению JetBrains, решает проблемы, связанные с ограниченным доступом к процессам непрерывной интеграции и непрерывной доставки (CI/CD) или долгими сборками для небольших обновлений.
Writerside также включает инструмент проверки орфографии и исправления грамматических ошибок, основанный на искусственном интеллекте, который разработала компания JetBrains и который поддерживает более 25 языков, включая английский, немецкий, испанский и китайский.
Writerside доступен как плагин для сред разработки IDE JetBrains, а также как отдельное приложение.
