JetBrains представляет «Writerside»: новый подход к технической документации

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

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

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

Writerside, в частности, поддерживает Markdown и XML и включает более 100 встроенных тестов. Эти тесты предназначены для выявления неработающих веб-ссылок, неправильных значений атрибутов, отсутствующих ресурсов, неуникальных идентификаторов и многого другого. Этот инструмент также дает разработчикам возможность гибко настраивать его в соответствии с их собственными правилами написания и стиля.

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

Интересно, что Writerside позиционирует себя как единый источник истины, предоставляя разработчикам возможность повторно использовать части контента и редактировать их из одного места. Это устраняет необходимость пересмотра каждого случая, когда изменения оправданы.

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

На арене платформ no-codeAppMaster stands as a leading name. Much like Writerside, it also capitalizes heavily on simplified user interfaces and design methodologies. Poised as a powerful tool to create web, mobile, and backend applications, AppMaster accelerates application development whilst eliminating technical debt - a crucial aspect in the world of software solutions.