Работа с документацией Engee
|
Страница в процессе разработки. |
Документация Engee — это не просто справочник, а полноценный навигатор по функциональности всей платформы. Она охватывает как базовые темы (например, запуск приложений или основы моделирования), так и продвинутые сценарии — интеграцию стороннего кода, генерацию на внешние языки, визуализацию, а также подключение внешних устройств.
Так, при работе с Engee могут возникать разные вопросы: как правильно собрать модель, как реализовать систему управления, как встроить нейросеть или как запустить полунатурное моделирование на РИТМе. Все это уже подробно описано в документации, но чтобы не тратить время на хаотичное блуждание по ее разделам, важно с самого начала понять:
-
Как устроена структура документации;
-
Где искать нужные материалы под конкретную задачу;
-
Как пользоваться встроенными примерами и курсами;
-
Как быстро находить ответы с помощью встроенного поиска;
-
Как оставить обратную связь, если в документации что-то не так.
Эта статья поможет быстро освоиться в документации, понять ее структуру, научиться эффективно искать нужные материалы и получать максимум пользы от платформы.
Как открыть документацию
Документацию Engee можно открыть разными способами — как из браузера, так и напрямую из рабочего пространства:
-
Через браузер — самый универсальный способ: перейдите по ссылке https://engee.com/helpcenter/stable/ru/index.html. Это сразу же откроет главную страницу документации, работает на любом устройстве и не требует запуска сессии Engee.
-
Из личного кабинета — на главной странице вашего личного кабинета
доступна кнопка Документация Engee. Один клик — и вы сразу в документации. Это удобно для быстрого доступа к информации и также не требует запуска сессии Engee.
-
Из запущенной сессии Engee — доступно несколько способов перейти в нужный раздел прямо из рабочего пространства Engee:
-
При запуске платформы — если включена галочка «Всегда показывать при старте», то в стартовом окне при запуске сессии будут ссылки на популярные разделы документации:
-
Кнопка Документация
— находится в правом верхнем углу интерфейса, доступна из любого окна.
-
Контекстное меню блока — дважды кликните левой кнопкой мыши по блоку из Библиотеки
и в открывшемся окне настроек окна настроек 
во вкладке Информация выберите «Документация» 
— откроется соответствующая статья по блоку:
Для открытия окна настроек необязательно выносить блок на холст, двойное нажатие сработает и в самой библиотеке .
-
Структура документации
Документация Engee организована по разделам. Все доступные разделы и их страницы представлены в левом боковом меню документации:
Любой раздел раскрывает свое содержимое по нажатию левой кнопки мыши. Далее коротко рассмотрим эти разделы:
-
Об Engee — это первая точка входа для изучения документации по платформе. Здесь описано, что такое Engee, как устроено рабочее пространство, как работать с приложениями
и как пользоваться личным кабинетом. Для знакомства с платформой рекомендуется начать со статьи Быстрый старт. -
Прикладные применения — раздел с документацией по пакетам языка Julia для различных задач. В разделе описываются пакеты для работы со статистикой, машинным обучением, оптимизацией, нейронными сетями, обработкой сигналов и изображений, радиолокацией, связью, картами и многим другим полезным направлениям.
-
Среда вычислений — раздел ориентирован на инженеров и программистов, работающих с кодом. Здесь описывается работа с математикой, импортом данных, построением графиков, синтаксисом языка Julia, интеграцией стороннего кода и многом другим.
-
Среда моделирования и симуляции — в разделе описывается все о создании и управлении моделями: визуальное моделирование, библиотека блоков, программное управление симуляцией, конечные автоматы и полунатурное моделирование.
-
Учебные курсы — наборы интерактивных скриптов по основным темам: программирование, моделирование, математика, обработка сигналов, оптимизация, моделирование электрических и энергетических систем, ЦОС, САУ и др. Подробную информацию по работе с курсами см. в статье Как получить материалы курсов.
Курсы также можно запускать напрямую со страниц документации — достаточно нажать кнопку «Открыть пример в Engee» на странице нужного курса:
-
Генерация кода — ключевой раздел для тех, кто хочет экспортировать модели в программный код. Включает материалы по трансляции в Cи, HDL, Julia, настройке пользовательских шаблонов генерации и практические примеры.
-
Примеры — интерактивные демонстрации, запускаемые по кнопке «Открыть в Engee». На основной странице с примерами каждый интерактивный блок при наведении отображает три первых примера, относящихся к выбранной области — это удобный способ быстро познакомиться с базовыми возможностями и типовыми сценариями работы:
При этом полный перечень всех доступных примеров по конкретным тематикам (радиосвязь, обработка сигналов, механика и др.) расположен в подразделах в левом боковом меню:
-
Дополнительные материалы — описывается взаимодействие с Git, API Engee, а также использование терминологических словарей.
-
Что нового — история изменений и обновлений платформы. Полезно отслеживать после установки новой версии, чтобы понять, какие функции добавлены, что улучшено, какие недоработки устранены.
Как устроены статьи в документации
Цветовые плашки
Во многих статьях используются цветовые выделения текста — плашки, помогающие быстро сориентироваться в типе информации. Каждая из них подсказывает как воспринимать выделенную информацию:
|
Содержит дополнительную информацию или контекст. Необязательна для выполнения, но помогает лучше понять тему. Можно читать для общего понимания и расширения кругозора. |
|
Полезные рекомендации, приемы и подсказки. Помогают упростить работу, ускорить выполнение операций или использовать функциональность более эффективно. |
|
Ключевые моменты, без которых выполнение описанных действий может быть некорректным. Обязательно прочитайте перед тем, как продолжить — это может быть требование к параметрам, данным или последовательности действий. |
|
Предупреждения о рисках: возможность ошибки, некорректной работы или потери данных. Требуют особого внимания и аккуратности при выполнении описанного. |
|
Предупреждение о потенциально опасных действиях. Такие плашки используются в случаях, когда выполнение может привести к критическим сбоям, повреждению проекта или небезопасному поведению системы. Следует проявлять максимальную осторожность. |
Меню подзаголовков
Все подзаголовки внутри статьи отображаются в правом боковом меню документации. Просто нажмите левой кнопкой мыши по имени нужного заголовка и статья автоматически перенесется к нужной теме:
Это помогает быстро перейти к нужному разделу — особенно удобно на длинных страницах.
|
Можно делиться ссылками на конкретный раздел статьи: просто наведите курсор на подзаголовок, и слева от него появится значок ссылки. Кликнув по нему, вы добавите якорь к URL странице — такой URL можно отправить коллегам или сохранить для быстрого перехода к конкретному пункту статьи.
|
Секции «Для опытных пользователей»
Иногда встречаются плашки с пометкой «Для опытных пользователей»:
Это означает, что в таких секциях содержатся сложные или редкие сценарии работы: интеграция нестандартных библиотек, использование продвинутых параметров симуляции, настройка пользовательских шаблонов и т.д. Подобные секции необязательны к исполнению/изучению, но могут быть полезны для опытных разработчиков и энтузиастов.
Поиск по документации
В правой верхней части документации есть строка поиска. Она поддерживает:
-
Быстрый предварительный просмотр результатов;
-
Ссылки на соответствующие статьи;
-
Возможность перейти к «Все результаты», чтобы использовать фильтры из бокового меню и уточнить запрос:
→→
Если сразу не нашли нужное — просто используйте расширенный поиск!
Язык интерфейса и локализация
В правом верхнем углу, рядом со строкой поиска, доступна кнопка переключения языка документации. По умолчанию включен русский язык, но при необходимости можно выбрать английский или китайский:
Кроме того, ниже доступна опция «Английская локализация блоков» — при ее активации названия блоков и разделов в библиотеке отображаются на английском. Это может быть удобно тем, кто работает с англоязычными проектами или предпочитает терминологию на английском языке.
Как сообщить об ошибке
Если заметили неточность или опечатку в статье:
-
Выделите проблемный фрагмент текста левой кнопкой мыши;
-
Подождите пару секунд — появится ссылка с текстом «Если вы нашли ошибку…»:
-
Нажмите на нее — откроется форма для отправки сообщения:
Это напрямую отправит информацию разработчикам документации!