Документация

Руководство пользователя DoXML

Содержание

  1. Введение
  2. Начало работы
  3. Организация и рабочее пространство
  4. Управление проектами
  5. Работа с документами
  6. Заполнение форм документов
  7. Валидация и проверка ошибок
  8. Экспорт документов
  9. Общие папки и файлы
  10. Приглашения и совместная работа
  11. Отчёты об изменениях
  12. Автозаполнение и справочники
  13. Профиль и настройки
  14. Панель управления организацией
  15. Часто задаваемые вопросы

1. Введение

DoXML — программный комплекс для создания, редактирования, валидации и управления проектной документацией в соответствии с требованиями Минстроя Российской Федерации. Пользовательский интерфейс построен на React/Vite; серверная часть — Java Spring Boot 4 с PostgreSQL и Redis.

Основные возможности

  • Работа в рамках организации с ролевой моделью.
  • Создание проектов и документов различных типов (ЗНП, ВОР, ПЗ и др.).
  • Пошаговый редактор форм на основе JSON Schema/XSD с автосохранением.
  • Валидация документов по XSD-схемам Минстроя РФ.
  • Экспорт в XML, PDF, DOCX и HTML.
  • Общие папки, приглашения пользователей, отчёты об изменениях.
  • Интеграция со справочниками, автозаполнение полей, OCR для документов.

Требования к браузеру

  • Chrome, Firefox, Safari, Edge последних версий.
  • Включённый JavaScript и cookies.
  • Доступ к домену установки осуществляется по протоколу HTTPS.

2. Начало работы

Регистрация

  1. На странице входа нажмите "Зарегистрироваться".
  2. Укажите email, ФИО, телефон и пароль.
  3. Подтвердите email по ссылке из письма.
  4. После подтверждения email вы сможете войти в систему.

Вход в систему

  1. Откройте https://{ONPREM_DOMAIN}.
  2. Введите email и пароль.
  3. При включённой двухфакторной аутентификации введите OTP-код.
  4. После входа открывается дашборд или список проектов.

Восстановление пароля

  1. На странице входа нажмите "Забыли пароль?".
  2. Введите email или телефон.
  3. Следуйте инструкциям в письме/SMS.

3. Организация и рабочее пространство

В DoXML данные принадлежат организации. Каждая организация имеет публичный идентификатор, используемый в адресе панели управления: /идентификатор_организации/control-panel.

Роли в организации

  • ACCOUNT_OWNER — владелец аккаунта/организации, полный доступ.
  • ADMIN — администратор организации, может управлять пользователями, проектами, документами.
  • USER — обычный пользователь, работает с проектами и документами.
  • GUEST — гость, доступ ограничен приглашениями.

Переключение организации

Если пользователь состоит в нескольких организациях, переключение доступно через меню профиля.

4. Управление проектами

Создание проекта

  1. Перейдите в раздел "Проекты".
  2. Нажмите "Новый проект".
  3. Заполните название, шифр, адрес, заказчика и другие реквизиты.
  4. Сохраните проект.

Список проектов

На странице отображаются:

  • Название и шифр проекта.
  • Дата создания и изменения.
  • Статус.
  • Количество документов.

Поиск, фильтрация, сортировка

Используйте поле поиска, фильтры по статусу и сортировку по колонкам.

Редактирование и удаление

В меню проекта выберите "Редактировать" или "Удалить". Удаление проекта удаляет связанные документы и файлы без возможности восстановления.

5. Работа с документами

Создание документа

  1. Откройте проект.
  2. Нажмите "Новый документ".
  3. Выберите тип документа (ЗНП, ВОР, ПЗ и др.).
  4. Укажите наименование и шифр.
  5. Нажмите "Создать".

Список документов проекта

Отображаются наименование, тип, дата создания, статус, последнее изменение.

Открытие документа

Нажмите на документ, чтобы перейти в редактор форм.

Удаление документа

В меню документа выберите "Удалить" и подтвердите действие.

6. Заполнение форм документов

Структура редактора

Редактор состоит из:

  • Навигационного меню слева (дерево разделов).
  • Области формы справа.
  • Индикатора сохранения и статуса.
  • Панели инструментов (валидация, экспорт, просмотр).

Навигация по разделам

  • Нажмите на раздел в левом меню.
  • Используйте кнопки "Назад" и "Далее".
  • Индикатор прогресса показывает, какие разделы заполнены.

Типы полей

  • Текстовое, числовое, дата, дата-время.
  • Выпадающие списки с поиском и автодополнением.
  • Множественный выбор (чекбоксы).
  • Радиокнопки.
  • Таблицы с возможностью добавления/удаления строк.
  • Загрузка файлов и изображений.
  • Редактируемый текст (Diplodoc/MD).

Условное отображение полей

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

Автосохранение

Изменения сохраняются автоматически. В верхней части отображается статус: "Сохранено", "Сохранение...", "Ошибка сохранения". Для принудительного сохранения нажмите "Сохранить".

Поиск в документе

Используйте поле поиска для быстрого перехода к полям и разделам.

7. Валидация и проверка ошибок

Автоматическая валидация

Система проверяет:

  • Обязательность полей.
  • Формат данных (email, ИНН, даты, числа).
  • Соответствие справочникам.
  • Соответствие XSD-схемам Минстроя РФ.

Проверка ошибок

  1. Нажмите "Проверить ошибки".
  2. В панели ошибок отобразится список замечаний с указанием раздела и поля.
  3. Нажмите на ошибку — редактор перейдёт к соответствующему полю.
  4. Исправьте данные и повторите проверку.

Подсветка ошибок

Поля с ошибками выделяются цветом, рядом отображается поясняющее сообщение.

8. Экспорт документов

Доступные форматы

  • XML — структурированный файл для передачи в экспертизу/ГИС.
  • PDF — человекочитаемая печатная форма.
  • DOCX — для дальнейшего редактирования в Word.
  • HTML — для предварительного просмотра в браузере.

Экспорт из редактора

  1. Нажмите "Скачать" или "Экспорт".
  2. Выберите формат.
  3. Дождитесь формирования файла и сохраните его.

Рекомендации

  • Перед экспортом устраните все ошибки валидации.
  • Используйте XML для официальной передачи данных.
  • PDF/DOCX используются для согласования и печати.

9. Общие папки и файлы

Файловое хранилище

Раздел "Мой диск" и общие папки проектов позволяют хранить файлы в S3-совместимом хранилище.

Создание общей папки

  1. В проекте перейдите в "Общие папки".
  2. Создайте папку, укажите название и пароль (опционально).
  3. Получите ссылку для загрузки файлов внешними пользователями.

Загрузка и скачивание файлов

  • Загружайте файлы через drag-and-drop или кнопку.
  • Просматривайте список файлов с фильтрами.
  • Скачивайте файлы по ссылке или из интерфейса.

10. Приглашения и совместная работа

Приглашение в организацию

  1. В панели управления организации откройте "Пользователи".
  2. Нажмите "Пригласить" и укажите email.
  3. Приглашённый пользователь получит письмо со ссылкой.

Приглашение в проект/документ

  1. В контекстном меню проекта или документа выберите "Поделиться".
  2. Выберите пользователя и роль.
  3. Отправьте приглашение.

Уведомления

Раздел "Уведомления" содержит приглашения, системные сообщения и статусы.

11. Отчёты об изменениях

Система позволяет сравнивать версии документов и формировать отчёты об изменениях (change reports). Отчёты доступны в соответствующем разделе проекта.

12. Автозаполнение и справочники

Автозаполнение ПЗ

Раздел "Автозаполнение ПЗ" позволяет автоматически заполнять пояснительную записку на основе данных из проекта и связанных документов.

Справочники

  • ОКТМО, ОКСМ, функциональные классы.
  • Справочники адресов и организаций (DaData).
  • Пользовательские сохранённые реквизиты.

13. Профиль и настройки

Редактирование профиля

  1. Нажмите на аватар в правом верхнем углу.
  2. Выберите "Профиль".
  3. Измените ФИО, телефон, должность, компанию.
  4. Сохраните изменения.

Смена пароля

  1. В профиле выберите "Сменить пароль".
  2. Введите текущий и новый пароль.
  3. Подтвердите изменения.

Двухфакторная аутентификация

При включении в настройках организации привяжите телефон и используйте SMS-коды для входа.

14. Панель управления организацией

Панель управления организации доступна по адресу /идентификатор_организации/control-panel. В ней администраторы могут:

  • Управлять пользователями и приглашениями.
  • Настраивать права доступа к проектам.
  • Просматривать статистику.
  • Управлять типами документов и новостями.
  • Настраивать параметры лицензии.
  • Выполнять обновление системы.

15. Часто задаваемые вопросы

Общие вопросы

В: Как начать работу?
О: Зарегистрируйтесь, создайте организацию/проект и добавьте документ.

В: Какие браузеры поддерживаются?
О: Современные версии Chrome, Firefox, Safari, Edge.

В: Нужно ли устанавливать ПО?
О: Клиентское приложение работает в браузере. Устанавливается только серверная часть программного комплекса.

Проекты и документы

В: Можно ли восстановить удалённый документ?
О: Нет, удаление окончательно. Используйте резервные копии.

В: Как пригласить коллегу?
О: Через панель управления организации → "Пользователи" → "Пригласить".

Редактор форм

В: Почему поле не отображается?
О: Некоторые поля показываются условно. Проверьте связанные поля.

В: Как часто сохраняются изменения?
О: Автоматически при изменениях; статус отображается в редакторе.

Валидация и экспорт

В: Что означает ошибка валидации?
О: Данные не соответствуют XSD-схеме Минстроя РФ. Исправьте поле согласно описанию.

В: Какой формат выбрать для экспертизы?
О: XML — основной формат для передачи данных. PDF/DOCX — для согласования.

Технические вопросы

В: Что делать, если страница не загружается?
О: Проверьте сеть, обновите страницу, очистите кэш или попробуйте другой браузер.

В: Как связаться с поддержкой?
О: Напишите на support@doxml.ru или через форму обратной связи.

Заключение

Руководство пользователя содержит базовую информацию для работы с DoXML. Более детальные инструкции доступны в разделе "Помощь" интерфейса и в документации администратора.

Скачать документ