Visual Paradigm с радостью объявляет о важном улучшении для Visual Paradigm OpenDocs: пользователи теперь могут создавать и вставлять редактируемые диаграммы непосредственно в страницы документов благодаря интеграции с Visual Paradigm VPasCode.
Эта новая возможность объединяет создание документации и диаграмм в едином оптимизированном рабочем процессе. Вместо того чтобы создавать диаграмму в отдельном приложении, экспортировать её в виде изображения и вручную вставлять это изображение в документ, пользователи теперь могут создать диаграмму с помощью подхода «диаграмма как код», вставить её в OpenDocs и при необходимости снова открыть для редактирования.
В результате получается более гибкий инструмент управления знаниями для команд разработчиков, технических писателей, архитекторов, бизнес-аналитиков, менеджеров продуктов и всех, кому необходимо визуально объяснять сложные идеи.
Откройте Visual Paradigm OpenDocs и начните создавать документацию с редактируемыми диаграммами уже сегодня.
Что нового в Visual Paradigm OpenDocs?
OpenDocs теперь позволяет пользователям вставлять диаграммы на страницу с помощью интеграции с VPasCode. Диаграмма добавляется в позицию курсора текста и может быть снова отредактирована после вставки.
Это означает, что диаграммы больше не ограничиваются статичными изображениями, добавляемыми после завершения процесса написания. Они могут стать активными, редактируемыми частями документа, которые поддерживают объяснение, совместную работу, планирование, анализ и обмен знаниями.
Независимо от того, готовите ли вы спецификацию требований к программному обеспечению, создаёте внутреннюю вики-страницу проекта, документируете архитектуру системы, публикуете руководство по процессу или создаёте базу знаний продукта, теперь вы можете объединить текстовое содержание и визуальные модели в одном документе.
Почему это улучшение важно
Документы часто становятся более полезными, когда они сочетают чёткие объяснения с диаграммами. Текстовые описания предоставляют контекст и детали, тогда как диаграммы помогают читателям мгновенно понять взаимосвязи, последовательности, зависимости, структуры и рабочие процессы.
Однако создание и поддержка диаграмм в документации могут быть неудобными. Типичный рабочий процесс включает использование одного инструмента для создания диаграммы, экспортирование результата в файл PNG или SVG, загрузку изображения в документ и повторение процесса каждый раз, когда диаграмма изменяется. Это может привести к лишней работе, устаревшим визуальным элементам, дублированию файлов или путанице относительно того, какая версия является последней.
Интеграция OpenDocs и VPasCode снижает это неудобство, приближая создание диаграмм к рабочему процессу документации. Пользователи могут создать диаграмму там, где она необходима, вставить её на страницу и позже вернуться к редактору диаграмм для внесения изменений.
Держите визуальные объяснения рядом с соответствующим контентом
Диаграмма наиболее эффективна, когда она расположена рядом с объяснением, которое она поддерживает. Благодаря новой возможности OpenDocs пользователи могут поместить блок-схему под описанием процесса, добавить диаграмму последовательности рядом с объяснением API или включить диаграмму архитектуры системы в техническую спецификацию.
Это делает документы более удобными для чтения и помогает пользователям понимать взаимосвязь между текстовой и визуальной информацией без переключения между несколькими приложениями.
Сократите ручной экспорт и загрузку
VPasCode создаёт диаграммы на основе текстовых языков диаграмм и отображает их визуально в браузере. Благодаря интеграции с OpenDocs пользователи могут вставлять результат непосредственно на страницу, вместо того чтобы вручную скачивать изображение и загружать его в документ.
Сокращение этих повторяющихся шагов поможет командам сэкономить время и поддерживать более чистый процесс документации, особенно когда диаграммы часто обновляются в ходе разработки или планирования проекта.
Сделайте диаграммы редактируемыми после вставки
Требования меняются. Системы развиваются. Бизнес-процессы пересматриваются. Диаграмма, которая точно описывает проект сегодня, может потребовать обновления завтра.
Поскольку диаграммы, вставленные через VPasCode, остаются редактируемыми, пользователи могут снова открыть редактор диаграмм из OpenDocs, изменить код диаграммы, сохранить изменения и обновить диаграмму в документе. Это упрощает уточнение визуального контента по мере развития идей и проектов.
Поддержка более одного стиля диаграмм
Разные проекты требуют различных типов визуальной коммуникации. Архитектору программного обеспечения может потребоваться модель C4 или диаграмма развёртывания. Бизнес-аналитику может понадобиться блок-схема процесса или карта пути пользователя. Менеджеру проекта может потребоваться диаграмма Ганта или дорожная карта. Техническому писателю может понадобиться интеллект-карта, диаграмма последовательности или диаграмма сущность-связь.
VPasCode поддерживает широкий спектр форматов диаграмм и технологий визуализации, включая PlantUML, Mermaid, Graphviz, D2, Markmap и ECharts. Он также поддерживает структурированные данные и другие форматы на основе кода, которые могут использоваться для создания визуальных представлений.
Что такое Visual Paradigm VPasCode?
Visual Paradigm VPasCode — это онлайн-платформа для создания диаграмм на основе кода, которая позволяет пользователям создавать диаграммы, записывая текстовые описания. Она объединяет редактор кода с предпросмотром в реальном времени, позволяя пользователям видеть диаграмму по мере написания или изменения кода.
Вместо того чтобы вручную рисовать каждую фигуру и соединитель, пользователи описывают структуру диаграммы с помощью поддерживаемого синтаксиса. VPasCode затем отображает результат в виде визуальной диаграммы.
Этот подход особенно полезен для разработчиков, архитекторов программного обеспечения, технических команд и других пользователей, которые хотят быстрый и повторяемый способ создания диаграмм. Он также полезен для команд, которые предпочитают диаграммы, которые можно просматривать и дорабатывать в текстовом виде.
VPasCode включает примеры для различных типов и форматов диаграмм, что упрощает начало работы для новых пользователей. Пользователи также могутиспользовать ИИ для генерации кода диаграммна основе описания на естественном языке.
Поддерживаемые форматы диаграмм и визуализаций
С помощью VPasCode пользователи OpenDocs могут создавать и вставлять множество различных видов диаграмм и визуализаций. Поддерживаемые форматы включают:
- PlantUML: Диаграммы классов, последовательностей, использования, деятельности, компонентов, развертывания, состояний, ER-диаграммы, диаграммы ArchiMate, модели C4, ментальные карты, диаграммы Ганта и многое другое.
- Mermaid: Блок-схемы, диаграммы классов, последовательностей, диаграммы сущностных связей, диаграммы состояний, ментальные карты, диаграммы C4, диаграммы Ганта, временные шкалы, карты пути пользователя, графы Git, диаграммы Канбан и многое другое.
- Graphviz: Графы, сетевые диаграммы, иерархические диаграммы, организационные схемы и визуализации связей.
- D2: Современные декларативные диаграммы для архитектуры, систем, рабочих процессов и связей.
- Markmap: Интерактивные ментальные карты, созданные на основе контента в стиле Markdown.
- ECharts: Диаграммы и визуализации, основанные на данных.
- Форматы данных и схем: JSON, YAML, XML, CSV, TOML, DBML и SQL.
Этот набор поддерживаемых технологий делает OpenDocs более мощной платформой для документации командам, которым необходимо создавать как традиционные бизнес-визуализации, так и технические диаграммы.
Создание диаграмм с помощью ИИ
Пользователям не нужно запоминать все синтаксисы диаграмм перед началом работы. VPasCode включает генерацию диаграмм с помощью ИИ, которая помогает преобразовать запрос на обычном языке в код диаграммы.
Например, пользователь может запросить:
Создать диаграмму последовательности, показывающую вход клиента через веб-приложение, службу аутентификации и базу данных.
VPasCode может использовать запрос для генерации кода диаграммы, который пользователи могут просмотреть, скорректировать и вставить в OpenDocs. Затем пользователи могут вручную доработать код или попросить ИИ изменить диаграмму в соответствии с новым требованием.
Помощь ИИ может быть полезна, когда:
- Вы знаете, что хотите сообщить, но не знаете требуемый синтаксис.
- Вы хотите быстро создать начальную диаграмму.
- Вам нужно добавить или удалить шаги, компоненты, связи или ветви.
- Вы хотите упростить сложную диаграмму.
- Вам нужна помощь в исправлении ошибок в коде диаграммы.
- Вы хотите перевести подписи диаграмм для международной команды.
Диаграммы, созданные с помощью ИИ, остаются редактируемыми, что означает, что пользователи могут рассматривать сгенерированный результат как отправную точку и корректировать его в соответствии с требованиями своего проекта.
Как вставить редактируемую диаграмму на страницу OpenDocs
Выполните следующие шаги, чтобы создать и вставить диаграмму на страницу документа:
- Откройте Visual Paradigm OpenDocs.
- Создайте новую страницу или откройте существующую.
- Нажмите Редактироватьв правом верхнем углу страницы.
- Установите текстовый курсор в том месте, где должна появиться диаграмма.
- Нажмите + кнопку на панели инструментов, чтобы открыть Создать артефакт окно.
- Выберите VPasCode из меню слева.
- Нажмите VPasCode справа, чтобы открыть редактор диаграмм.
- Введите или вставьте код диаграммы в редактор слева.
- Просмотрите предварительный просмотр в реальном времени и внесите необходимые изменения.
- Нажмите Сохранить в правом верхнем углу редактора VPasCode.
- Нажмите Закрыть чтобы вернуться на страницу OpenDocs.
- Диаграмма будет вставлена в положение текстового курсора.
После вставки диаграммы пользователи могут продолжать писать вокруг неё так же, как и с другим содержимым документа.
Как повторно отредактировать диаграмму
Диаграммы, вставленные в OpenDocs, можно редактировать в любое время, когда требуются обновления.
- Откройте страницу OpenDocs, содержащую диаграмму.
- Нажмите значок карандаша в правом верхнем углу диаграммы.
- Внесите изменения в редакторе VPasCode.
- Используйте предварительный просмотр в реальном времени для проверки результата.
- Нажмите Сохранить.
- Нажмите Закрыть чтобы вернуться в OpenDocs.
Обновлённая диаграмма автоматически отобразится в документе, что позволит пользователям сохранять свой визуальный контент без удаления оригинальной диаграммы или начала работы с нуля.
Практические случаи использования
Документация по архитектуре программного обеспечения
Архитекторы программного обеспечения могут использовать синтаксис PlantUML, Mermaid, D2 или C4 для описания компонентов системы, сервисов, хранилищ данных и внешних зависимостей. Получившаяся схема архитектуры может быть размещена непосредственно в документе проектирования системы или в записи об архитектурном решении.
По мере изменения архитектуры схему можно редактировать в VPasCode и обновлять в OpenDocs. Это помогает технической документации оставаться в соответствии с обсуждаемым проектом.
Документация по API и интеграции
Диаграммы последовательностей полезны для демонстрации взаимодействия клиентов, сервисов, баз данных и сторонних систем. Команды могут включать диаграмму последовательности рядом с описаниями API, деталями аутентификации, потоками запросов и правилами обработки ошибок.
Например, технический писатель может описать процесс онлайн-оплаты с помощью текстового объяснения, примеров API и диаграммы последовательности Mermaid или PlantUML на одной странице OpenDocs.
Документация по базам данных и моделям данных
Команды баз данных могут использовать диаграммы сущностно-связных моделей для объяснения таблиц, полей, ключей и связей. Визуальная модель данных может сделать документацию по базам данных более понятной для разработчиков, аналитиков, тестировщиков и других заинтересованных сторон.
При добавлении новой таблицы или связи схему можно отредактировать и повторно вставить через тот же рабочий процесс VPasCode.
Руководства по бизнес-процессам и рабочим потокам
Бизнес-аналитики и операционные команды могут использовать блок-схемы, диаграммы деятельности, карты пути пользователя и диаграммы процессов для объяснения того, как работа перемещается по организации.
Встраивание этих визуальных элементов в операционное руководство или стандартную процедуру может помочь читателям понять обязанности, точки принятия решений, альтернативные пути и этапы согласования.
Требования к продукту и планирование функций
Менеджеры продуктов могут включать карты пути пользователя, потоки процессов, диаграммы состояний, ментальные карты и связи функций в документы с требованиями к продукту. Эти визуальные материалы могут помочь командам продукта, дизайна, разработки и обеспечения качества сформировать общее понимание функции.
Проектные вики и базы знаний
Инструмент управления знаниями наиболее ценен, когда он объединяет информацию, необходимую людям для понимания и выполнения своей работы. Добавление редактируемых диаграмм в базу знаний OpenDocs может сделать проектные вики, материалы для адаптации, внутренние руководства и системные мануалы более полными.
Вместо того чтобы хранить диаграммы в отдельных папках или в несогласованных инструментах проектирования, команды могут размещать их рядом с соответствующими объяснениями, решениями, процедурами и справочными материалами.
Ментальные карты и организация концепций
Markmap и другие форматы ментальных карт могут помочь командам организовать требования, темы исследований, структуры проектов, результаты встреч и иерархии знаний. Эти карты можно вставить на страницу OpenDocs для предоставления визуального обзора до представления более подробной информации.
Преимущества для различных типов пользователей
- Разработчики:Создавайте диаграммы с помощью знакомых текстовых форматов и размещайте технические объяснения рядом с визуальными представлениями системы.
- Архитекторы программного обеспечения:Создавайте схемы архитектуры, UML, C4, развертывания и компонентов, которые можно пересматривать по мере эволюции систем.
- Технические писатели:Объединяйте процедуры, спецификации, примеры и редактируемые диаграммы в одном рабочем пространстве документации.
- Бизнес-аналитики:Объясняйте бизнес-процессы, требования, решения и пути пользователей с помощью четких визуальных моделей.
- Менеджеры продуктов:Добавляйте рабочие потоки, дорожные карты, связи функций и пользовательские потоки в документацию продукта.
- Проектные команды: Создавайте общую документацию, которая передаёт как детали, так и общую картину.
- Педагоги и тренеры: Используйте диаграммы, чтобы упростить восприятие технического или процедурного контента.
От статических документов к живой документации
Эффективная документация должна отражать текущее состояние проекта, продукта, процесса или системы. Когда визуальный контент хранится только в виде статического изображения, его обновление легко отложить. Со временем изображение может перестать соответствовать действительности.
Интеграция OpenDocs и VPasCode поддерживает более поддерживаемый подход. Диаграммы можно создавать на основе читаемого кода, просматривать через визуальный предпросмотр, вставлять в соответствующий документ и редактировать снова при изменении исходной информации.
Это создаёт практическую основу для живой документации. Диаграмма остаётся полезным рабочим активом, а не разовым скриншотом.
Более связанная экосистема Visual Paradigm
Visual Paradigm объединяет различные продукты и возможности, помогая пользователям более эффективно переходить от идей к моделям, диаграммам, документации и общим знаниям.
VPasCode обеспечивает опыт создания диаграмм как кода. OpenDocs обеспечивает опыт управления документами и знаниями. Вместе они помогают командам создавать визуальный контент и размещать его непосредственно в том контексте, где он необходим.
Это соединение может сократить переключение между инструментами, упростить рабочий процесс документации и помочь командам более эффективно использовать диаграммы на протяжении всего жизненного цикла проекта.
Начните работу с OpenDocs и VPasCode
Благодаря этому улучшению Visual Paradigm OpenDocs становится более универсальной средой для создания структурированной, визуальной и совместной документации. Пользователи могут создавать диаграммы с помощью PlantUML, Mermaid, Graphviz, D2, Markmap, ECharts и других поддерживаемых форматов, вставлять их на страницы и редактировать их снова при изменении требований.
Если вы ищете онлайн-генератор диаграмм, платформу «диаграммы как код», инструмент технической документации или инструмент управления знаниями с интегрированными возможностями визуального моделирования, этот новый рабочий процесс предлагает удобный способ объединить диаграммы и документы.
Запустите Visual Paradigm OpenDocs и начните создавать более богатую и полезную документацию с редактируемыми диаграммами, работающими на базе VPasCode.
Часто задаваемые вопросы
Что представляет собой новое улучшение OpenDocs?
OpenDocs теперь позволяет пользователям создавать и вставлять редактируемые диаграммы на страницы документов благодаря интеграции с Visual Paradigm VPasCode.
Могу ли я редактировать диаграмму после её вставки в OpenDocs?
Да. Нажмите на иконку карандаша на вставленной диаграмме, чтобы открыть её снова в редакторе VPasCode. После изменения кода диаграммы нажмите «Сохранить и закрыть», чтобы обновить диаграмму на странице OpenDocs.
Какие форматы диаграмм поддерживаются?
VPasCode поддерживает форматы и технологии, включая PlantUML, Mermaid, Graphviz, D2, Markmap, ECharts, JSON, YAML, XML, CSV, TOML, DBML и SQL. Поддерживаемые типы диаграмм включают блок-схемы, диаграммы последовательностей, классовые диаграммы, диаграммы состояний, ER-диаграммы, диаграммы C4, ментальные карты, архитектурные диаграммы, диаграммы Ганта и многое другое.
Нужно ли мне знать код диаграмм для использования этой функции?
Нет. Вы можете загрузить пример из редактора VPasCode или Галереи примеров. Вы также можете использовать функцию «Создать с помощью ИИ», чтобы описать нужную диаграмму на естественном языке, и позволить ИИ сгенерировать начальный скрипт диаграммы.
Где я могу получить доступ к OpenDocs?
Вы можете получить доступ к Visual Paradigm OpenDocs по адресу https://ai-toolbox.visual-paradigm.com/app/opendocs/.
Где я могу узнать больше о VPasCode?
Посетите Страница функций VPasCodeчтобы узнать больше о платформе диаграмм как кода, поддерживаемых форматах, рендеринге в реальном времени, помощи ИИ и связанных возможностях.