JetBrains объявила о доступности раннего доступа Writerside , среды разработки JetBrains на базе платформы IntelliJ , которая позволяет разработчикам писать, создавать, тестировать и публиковать техническую документацию. Его можно использовать как плагин в JetBrains IDE или как отдельный инструмент.
Writerside позволяет разработчикам и писателям совместно работать над документацией по продукту, справочниками по API, руководствами для разработчиков, учебными пособиями и практическими рекомендациями; инструменты проверки орфографии и исправления грамматики на базе искусственного интеллекта поддерживают более 25 языков, включая английский, немецкий, испанский и китайский.
Некоторые из функций Writerside включают в себя:
- Встроенный пользовательский интерфейс Git.
- Благодаря предварительному просмотру в реальном времени документы выглядят именно так, как их видят читатели, не дожидаясь сборки.
- Поддерживает Markdown, XML или их комбинацию. Разработчики могут добавлять семантические атрибуты или семантические элементы для обогащения Markdown, а элементы Markdown можно конвертировать в XML.
- Предлагает варианты настройки внешнего вида, включая выбор темного или светлого режима, контрастности, мягкой или яркой тона кожи, а также определение акцентных цветов, соответствующих вашему бренду. Авторы могут сосредоточиться на контенте, а не на разработке макетов и работе с CSS.
- Поставляется с более чем 100 встроенными тестами, позволяющими Writerside автоматически проверять наличие неработающих ссылок, отсутствующих ресурсов, неправильных значений свойств, неуникальных идентификаторов и т. д. Имеет подсветку и проверку кода, а также встроенные проверки.
- Поддержание единого источника достоверной информации для проекта позволяет разработчикам повторно использовать части контента и редактировать его только из одного места, вместо того, чтобы обновлять каждый экземпляр при внесении изменений.
Более подробную информацию можно найти в официальной документации .