Skip to content

Предложения по структуре wiki

Wiki Uniplant Atomix (репозиторий HelpAsuAutoMix, ~6600 файлов в src/content/docs, sidebar с ~350+ пунктами в astro.config.mjs) объединяет:

  • описание структуры каталогов и установки;
  • методику заполнения JSC-моделей;
  • каталоги типовых блоков (OBJTYPE);
  • документацию модулей Uniplant Atomix;
  • операционные руководства по ПТК;
  • справочные и коммерческие материалы.

Ниже — что уже работает хорошо, какие барьеры для нового пользователя выявлены и пять вариантов улучшения с рекомендуемой последовательностью внедрения.


  1. Главная страница задаёт логику «от требований до сопровождения» и блок «Быстрый старт».
  2. Разделение «данные ↔ инструмент» явно прописано на страницах Модули Uniplant Atomix и JSC. Модели.
  3. Каталоги OBJTYPE (solutions/.../object-types/) с сводными таблицами и objtype-template-mapping — удобная точка входа для поиска блока.
  4. Скрытие детальных статей OBJTYPE из меню (menuMode: "hide") разгружает sidebar, оставляя навигацию через таблицы-каталоги.

Основные проблемы для нового пользователя

Section titled “Основные проблемы для нового пользователя”

1. Несколько «осей» смешаны в одном меню

Section titled “1. Несколько «осей» смешаны в одном меню”

В sidebar одновременно живут разные типы знаний:

ОсьПримерВопрос пользователя
Где лежат файлыproject-structure«Какой каталог создать?»
Как заполнять Excelguides/jsc-models«Как заполнить лист MKO?»
Что за блокиsolutions/alpha-trei/...«Что такое AiProc3 / 4_20mA?»
Как работает Uniplant Atomixuniplant-atomix«Как нажать Generate?»
Эксплуатация ПТКguides/aspsipt, admin, SVN«Как загрузить в контроллер?»
Коммерция / стратегияreference«Что продаём?»

Новичок не понимает, в какой раздел идти первым.

2. Дублирование темы по разным веткам

Section titled “2. Дублирование темы по разным веткам”

Одна предметная область размазана по нескольким разделам:

Пользователь вынужден сам собирать маршрут из 3–4 разделов.

3. Перегруженное боковое меню

Section titled “3. Перегруженное боковое меню”
  • Глубокая вложенность (4–5 уровней), почти всё collapsed: true.
  • Дублирование «Утилиты» — два раза в блоке «Модули Uniplant Atomix».
  • 40+ функций GAP — плоский список в «Руководствах».
  • В Справочнике — тестовые страницы AiProc3 рядом с материалами по лицензированию.
  • Смешение языков: Jsc Models, Terms And Abbreviations, Object Types рядом с русскими названиями.

4. Слабые «хабы» и неточные ссылки

Section titled “4. Слабые «хабы» и неточные ссылки”

5. Разрыв «каталог ↔ деталь»

Section titled “5. Разрыв «каталог ↔ деталь»”

Сводные таблицы APUCS/AFA удобны, но детальные статьи OBJTYPE скрыты из меню (menuMode: "hide"). Без поиска пользователь может не понять, что за каждой строкой таблицы — полноценная страница с шаблонами, переменными и mapping.


Рекомендуемая схема для onboarding и sidebar — слева направо:

flowchart TB
  subgraph data ["1. Исходные данные"]
    PS[Структура каталогов]
    JSC[JSC Excel-модели]
    OBJ[OBJTYPE-каталог]
  end

  subgraph tool ["2. Uniplant Atomix"]
    SM[Модули приложения]
    GEN[Генерация]
  end

  subgraph result ["3. Результат"]
    PLC[Unimod / FBD]
    HMI[Alpha.HMI / панели]
    DS[DevStudio / Modbus]
  end

  subgraph ops ["4. Эксплуатация"]
    GUIDES[Руководства по ПТК]
    ADM[Администрирование]
  end

  PS --> JSC --> OBJ --> SM --> GEN --> PLC
  GEN --> HMI
  GEN --> DS
  PLC --> GUIDES
  HMI --> GUIDES

Sidebar и обучающие материалы лучше строить по этой цепочке, а не только по историческим путям переноса из старой wiki.


Вариант A. «Карта знаний» по ролям

Section titled “Вариант A. «Карта знаний» по ролям”

Объём: минимальные изменения, максимальный эффект для новых пользователей.

Добавить 1–2 обзорные страницы без перестройки дерева файлов.

Страница «С чего начать»

Section titled “Страница «С чего начать»”

Расширить главную или создать /getting-started/ с маршрутами:

Новый инженер Uniplant Atomix

УстановкаНастройкаСтруктура каталоговJSC. МоделиПЛК Конфигуратор

Инженер АСПСиПТ

Библиотека AFAМодель ПЛК AFA → заполнение OBJ.*Генерация UnimodЭкраны ЧМИ

Инженер АСУТП / ESD

Каталог APUCSМодели ПЛК AUCS/DCS/ESDTagAssignementЭкраны ЧМИ DCS/ESD

Администратор / DevOps

Администрирование ПОSVNSettingManager

Каждый шаг — с явной подписью типа: данные / инструмент / результат.

Расширить Альфа-платформа + ПЛК ТРЕЙ таблицей «единая дверь»:

БлокСсылки
Каталог типовых блоковobject-types, objtype-template-mapping
Как заполнять моделиguides/jsc-models
Как генерироватьuniplant-atomix, ПЛК Конфигуратор, внешние модули
Операционные инструкцииguides/aspsipt, guides/dcs-esd
HMIhmi-screens + HMI Менеджер

Плюсы: не требует переноса файлов; только связующие страницы и правка sidebar (вынести хабы наверх).


Вариант B. Реорганизация sidebar по типу задачи

Section titled “Вариант B. Реорганизация sidebar по типу задачи”

Объём: средний. Файлы можно оставить на месте через slug.

Предлагаемый верхний уровень меню

Section titled “Предлагаемый верхний уровень меню”
  1. Начало работы — install, setting, project-structure, glossary
  2. Методика моделированияguides/jsc-models (единый блок)
  3. Библиотеки решенийsolutions по ПТК
  4. Uniplant Atomix: инструментuniplant-atomix
  5. Ввод в эксплуатацию — guides: aspsipt, dcs-esd, panels, SVN, admin
  6. Справочник — GAP, terms, API, commercial

Что убрать или сжать в меню

Section titled “Что убрать или сжать в меню”
ДействиеЭффект
GAP → только индекс /reference/gap/ + поиск−40 пунктов в sidebar
OBJTYPE-детали → только каталоги + mappingМеньше шума (частично уже так)
Удалить дубль «Утилиты»Убирает путаницу
Тестовые AiProc3 → menuMode: hide или отдельная веткаЧище «Справочник»
Terms And Abbreviations → в «Начало работы»Глоссарий до первого чтения

Плюсы: меню отражает вопрос пользователя, а не структуру SVN/репозитория.


Вариант C. Сценарные «треки» end-to-end

Section titled “Вариант C. Сценарные «треки» end-to-end”

Объём: средний–высокий. Создать раздел /workflows/ или /scenarios/.

Пример сценария: «Добавить насос Mot2c4s в проект AUCS»

Section titled “Пример сценария: «Добавить насос Mot2c4s в проект AUCS»”
  1. Выбрать OBJTYPE в каталоге APUCS
  2. Заполнить строку на листе OBJ.*модель ПЛК
  3. Проверить TagAssignement: Mot2c4s
  4. Запустить ПЛК Конфигуратор → workflow
  5. Проверить лог и результаты генерации

Рекомендуемые сценарии для первой очереди

Section titled “Рекомендуемые сценарии для первой очереди”
СценарийЦелевая роль
Первый запуск Uniplant Atomix и корневой каталогНовый инженер
Добавление типового блока в модель ПЛК (AUCS)Инженер АСУТП
Генерация проекта Unimod для АСПСиПТИнженер АСПСиПТ
Настройка диагностики сети (NetSwitches + NetDevices)Инженер по диагностике

Плюсы: связывает solutions + guides + uniplant-atomix в одну историю; лучший формат для усвоения при большом объёме автогенерируемого контента.


Вариант D. Унификация разделов АСПСиПТ / АСУТП

Section titled “Вариант D. Унификация разделов АСПСиПТ / АСУТП”

Объём: высокий. Долгосрочная унификация всех ПТК.

Для каждого направления — единый шаблон раздела:

solutions/alpha-trei/{aspsipt|asutp-asue}/
index.mdx — обзор + ссылки на все подразделы
object-types/ — каталог (есть)
objtype-template-mapping.mdx
plc-models/ — модели верхнего уровня (есть)
plc/ — FBD-шаблоны (есть)
operations/ — ключевое из guides/aspsipt (перенос или дублирование)
hmi/ — ключевое из guides/.../hmi-screens

Руководства АСПСиПТ остаются для чисто операционных задач (загрузка в контроллер, FireSec), но обзорная страница solutions/aspsipt становится «единой дверью».

Плюсы: один паттерн для всех ПТК.

Минусы: больше работы по переносу и редиректам (в astro.config.mjs уже сотни редиректов).


Вариант E. Быстрые победы без смены IA

Section titled “Вариант E. Быстрые победы без смены IA”

Точечные улучшения UX без перестройки информационной архитектуры:

ДействиеЭффект
Исправить шаг 4 на главной → /uniplant-atomix/Убирает путаницу Libraries vs Modules
Блок «Вы здесь: данные / инструмент / каталог» в шаблоне OBJTYPE и module pagesЗакрепляет mental model
Таблица «Связанные разделы» на каждой index-страницеКак на Состав моделей верхнего уровня, но везде
Terms And Abbreviations в «Начало работы»AFA, APUCS, OBJTYPE, GAP, AUCS — до первого чтения
Пометки «в подготовке» в sidebar для CodeSys / WeintekНе обещать контент, которого нет
Усилить поиск (Pagefind) по именам OBJTYPEКритично при скрытых из меню страницах
«Следующий шаг» в конце статей (LinkCard / pagination)Снижает «тупик» после сводной таблицы
Исправить canonical-ссылки на Структура каталоговЕдинообразие URL

Рекомендуемая последовательность внедрения

Section titled “Рекомендуемая последовательность внедрения”
ПриоритетВариантОценка трудозатрат
1E — быстрые победы (ссылки, шаблоны)1–2 дня
2A — хабы и learning paths1–2 дня контента
3B — упрощение sidebar2–3 дня
4C — 2–3 сквозных сценария (AUCS, АСПСиПТ)3–5 дней
5D — унификация всех ПТКдолгосрочно

Чек-лист для приёмки улучшений

Section titled “Чек-лист для приёмки улучшений”

После внедрения каждого этапа проверить:

  • Новый пользователь за 3 клика от главной попадает в свой сценарий (роль × ПТК).
  • На главной нет ссылок, путающих «Libraries (SVN)» и «Модули Uniplant Atomix».
  • Из каталога OBJTYPE видна связь с детальной статьей и с mapping.
  • Из статьи OBJTYPE есть путь к модели ПЛК, модулю генерации и логу.
  • Sidebar не содержит дублей и тестового контента в production-ветке меню.
  • Глоссарий доступен из «Начало работы» до чтения специализированных разделов.

МатериалНазначение
Модули Uniplant Atomix: обзорГраница «инструмент vs данные»
JSC. МоделиМетодика исходных данных
Разработанные библиотеки решенийКаталоги по ПТК
Uniplant Atomix для заказчикаПродуктовый контекст
Услуги и лицензирование Uniplant AtomixКоммерческий контекст