Руководство по эксплуатации программного обеспечения | DreamDocs
Документация DreamDocs

Руководство по эксплуатации программного обеспечения

Порядок работы, регламентные операции, мониторинг, резервное копирование и типовые ошибки

ПродуктDreamDocs
ПравообладательООО «Апэрбот»
Версия документа1.0
Дата актуализации1 июня 2026 года

1. Общие сведения

DreamDocs - программное обеспечение для интеллектуальной обработки документов. Система предназначена для загрузки файлов, распознавания текста, классификации документов, извлечения атрибутов, проверки качества, ручной верификации, сравнения, анонимизации и выгрузки результатов обработки.

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

Параметр Описание
Объект эксплуатации ПО DreamDocs, включая пользовательский интерфейс, административные функции, OCR/AI обработку, отчеты и API-интеграции.
Основные пользователи Администраторы, менеджеры обработки, аннотаторы, валидаторы, наблюдатели, технические специалисты сопровождения.
Основные данные Файлы документов, карточки документов, извлеченные атрибуты, таблицы, статусы обработки, справочники, роли, настройки проектов, журналы событий.
Форматы входных файлов PDF, TIFF, Word, Excel, BMP, JPEG, GIF, PNG, HTML и другие форматы, поддерживаемые конкретной поставкой.
Форматы выгрузки Excel, CSV, PDF, исходные файлы, обработанные документы, DOCX с текстовым слоем, JSON-отчеты и иные форматы, настроенные в проекте.

2. Термины и роли пользователей

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

Термин Описание
Рабочая область Логическое пространство, объединяющее проекты, пользователей, роли, типы документов, типы полей и справочники.
Проект Область обработки документов с собственными настройками, пользователями, типами документов, правилами обработки и отчетами.
Документ Объект системы, созданный из файла или части файла. Один загруженный файл может содержать один или несколько документов.
Тип документа Шаблон обработки, определяющий состав атрибутов, таблиц, правил извлечения и проверок.
Аннотатор Интерфейс проверки и исправления распознанных атрибутов документа.
Валидатор Пользователь или роль, выполняющая финальную проверку и подтверждение результата обработки.
OCR Модуль оптического распознавания текста и формирования текстового слоя документа.
AI/ML/LLM Модули интеллектуальной классификации, извлечения данных, анализа текста, автозаполнения и ответов на вопросы по документам.
Роль Основные полномочия
Admin Полное управление рабочей областью или проектом: пользователи, роли, настройки, типы документов, импорт, экспорт, OCR/ML, интеграции.
Manager Контроль процесса обработки, назначение ответственных, работа с очередью, просмотр статистики и отчетов.
Annotator Загрузка, просмотр, разметка, редактирование и проверка документов в пределах выданных прав.
OnlyOwned Работа только с документами, назначенными или принадлежащими пользователю.
ReadOnly Просмотр документов, проектов и отчетов без изменения данных.
Технический администратор Сопровождение инфраструктуры, обновлений, резервного копирования, журналов, мониторинга и интеграций.

3. Начало работы и доступ в систему

Доступ к DreamDocs предоставляется через веб-интерфейс. Конкретный адрес системы определяется при развертывании. Для входа пользователь указывает логин и пароль. После успешной авторизации система открывает список доступных рабочих областей или проектов.

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

  1. Откройте адрес DreamDocs в браузере, рекомендованном администратором.
  2. Введите имя пользователя или электронную почту.
  3. Введите пароль и нажмите [Войти].
  4. Если включена многофакторная проверка или подтверждение по почте, выполните дополнительные действия по инструкции администратора.
  5. После входа убедитесь, что выбрана корректная рабочая область.

3.2. Восстановление пароля и профиль

  • При ошибке входа проверьте корректность логина, раскладку клавиатуры и Caps Lock.
  • При утрате пароля используйте ссылку [Забыли пароль?], укажите электронную почту и задайте новый пароль после подтверждения.
  • В профиле пользователь может просмотреть персональные данные, изменить имя, фамилию, электронную почту, язык интерфейса и пароль, если это разрешено политикой системы.
  • Удаление профиля является необратимым и должно выполняться только после передачи активных проектов и прав другим ответственным лицам.
Пароль

Рекомендуется использовать пароль не менее 8 символов, содержащий заглавные и строчные буквы, цифры и специальные символы. Требования могут быть усилены администратором.

4. Рабочие области и проекты

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

4.1. Создание и выбор рабочей области

  1. Откройте пункт [Рабочие области] в меню профиля или в административной панели.
  2. Нажмите [Добавить рабочую область].
  3. Укажите уникальное название и, при необходимости, описание.
  4. Назначьте владельца и участников, если это предусмотрено интерфейсом.
  5. Сохраните изменения и проверьте, что рабочая область отображается в списке.

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

  1. Перейдите в выбранную рабочую область.
  2. Нажмите [Добавить проект].
  3. Введите название проекта и подтвердите создание.
  4. Откройте настройки проекта и укажите типы документов, пользователей, роли и параметры обработки.
  5. Сохраните изменения.
Раздел настроек проекта Назначение
Основные настройки Название проекта, описание, параметры хранения, импорт и экспорт проекта.
Пользователи Добавление участников, изменение ролей, удаление пользователей из проекта.
Типы документов Подключение и настройка типов документов, используемых в проекте.
Типы полей Настройка форматов, правил отображения и способов хранения атрибутов.
Таблицы и справочники Предопределенные значения для валидации и автозаполнения полей.
Сценарии Пользовательские скрипты, правила постобработки и автоматизации.
Отчеты Аналитика обработки, качества, активности и аудита.
Импорт / экспорт Перенос настроек проекта между рабочими областями и создание резервной копии.

5. Типовой процесс обработки документов

Обработка документов в DreamDocs строится как последовательность этапов. Часть этапов выполняется автоматически, часть - пользователями с соответствующими правами.

Этап Описание Ответственный
1. Загрузка Пользователь загружает файл, архив, папку или документ с веб-страницы. Оператор / Admin
2. Предобработка Система анализирует файл, формирует страницы, выполняет базовую проверку качества. Система
3. OCR Формируется текстовый слой, извлекается текст, таблицы и координаты найденных фрагментов. Система
4. Разделение Многостраничный файл разделяется на отдельные документы или документы объединяются при необходимости. Система / пользователь
5. Классификация Система определяет тип документа по правилам, ML-модели или LLM-классификатору. Система
6. Извлечение полей Заполняются реквизиты, таблицы и нормализованные значения. Система
7. Валидация Выполняются проверки форматов, справочников, обязательности и междокументных связей. Система / пользователь
8. Ручная проверка Аннотатор исправляет поля, подтверждает значения, добавляет комментарии. Аннотатор
9. Финальное подтверждение Документ переводится в статус готовности или одобрения. Валидатор / Manager
10. Выгрузка Данные экспортируются в файл, архив, API или внешнюю учетную систему. Пользователь / интеграция

5.1. Статусы обработки

Статус Значение Действие пользователя
Загружается Файл передается в систему или ожидает регистрации. Дождаться завершения загрузки.
Ждет обработки Файл поставлен в очередь OCR/AI обработки. Контролировать очередь и доступность сервисов.
Размечается Выполняется автоматическая или ручная разметка. При необходимости открыть документ и проверить поля.
Требует исправления Обнаружены ошибки распознавания, валидации или структуры документа. Открыть документ, исправить поля, повторить обработку при необходимости.
Готово Документ обработан и может быть проверен или выгружен. Проверить результат и выполнить экспорт.
Одобрено Документ прошел финальную проверку. Использовать результат для передачи во внешние системы.
Ошибка Обработка завершилась некорректно. Проверить качество файла, настройки проекта, очередь задач и журналы.

6. Работа с документами и файлами

6.1. Загрузка документов

Загрузка выполняется из карточки проекта или раздела [Документы] через кнопку [Добавить документ]. Пользователь выбирает вкладку [Документы], [Web-страница] или [Создать новый документ].

Параметр Требование / поведение
Поддерживаемые форматы PDF, TIFF, Word, Excel, BMP, JPEG, GIF, PNG, HTML.
Рекомендуемое качество Разрешение не менее 300 dpi, отсутствие бликов, теней, перекрытий реквизитов, посторонних объектов и сильных искажений.
Многостраничные документы Рекомендуемые форматы: PDF, TIFF, Word, Excel.
Размеры и лимиты Лимиты зависят от конфигурации. В типовой поставке могут задаваться ограничения на количество файлов, общий объем загрузки и максимальный размер одного файла.
Папка проекта При загрузке можно выбрать существующую папку или создать новую виртуальную папку проекта.
Объединение При необходимости несколько файлов могут быть объединены в один файл-контейнер.

6.2. Просмотр и редактирование

  • Левая область карточки документа отображает визуальный рендер PDF или изображений.
  • Правая область отображает поля, таблицы, OCR-текст, комментарии, статусы, ошибки и метаданные.
  • Изменения полей фиксируются в истории с указанием пользователя, даты и версии документа.
  • Если документ редактируется другим пользователем, система может временно ограничить сохранение изменений.
  • Для быстрого просмотра можно использовать предпросмотр, не открывая документ в режиме редактирования.

6.3. Выгрузка результатов

Формат Назначение
Excel Выгрузка извлеченных атрибутов, статусов, метаданных и реквизитов документов.
Excel edited values Выгрузка измененных значений и истории ручных корректировок.
Documents Архив обработанных документов в формате, доступном для последующей передачи.
Source files Исходные загруженные файлы без изменения.
Анонимизированный PDF PDF с замаскированными персональными или конфиденциальными данными.
Текстовый слой DOCX Файл Microsoft Word с распознанным текстом после OCR.
Отчет по автозаполнению Статистика автоматического заполнения полей и проблемных реквизитов.

7. Справочники, типы документов и типы полей

Тип документа определяет структуру извлекаемых атрибутов. Тип поля определяет формат значения и способ проверки. Справочники используются для стандартизации данных и контроля допустимых значений.

7.1. Настройка типа документа

  1. Перейдите в раздел [Типы документов].
  2. Создайте новый тип или откройте существующий.
  3. Добавьте блоки и поля: основные реквизиты, таблицы, подписи, суммы, даты, номера, стороны договора и другие атрибуты.
  4. Для каждого поля выберите тип поля, видимость, обязательность, справочник и правила извлечения, если они применяются.
  5. Сохраните изменения и выполните тестовую обработку документа.

7.2. Справочники

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

8. Сравнение, сплит и анонимизация

Инструмент Назначение Типовые действия
Сплит Разделение многостраничного файла на отдельные документы или объединение документов. Выбор границ, назначение типов, сохранение новой структуры.
Сравнение Сопоставление двух документов или значений полей для выявления расхождений. Сравнение текста, полей, реквизитов, версий или связанных документов.
Анонимизация Скрытие персональных и конфиденциальных данных при выгрузке или передаче документов. Настройка скрываемых полей, формирование анонимизированного PDF.
Чат AI Вопросы к содержимому выбранных документов и поиск фрагментов в контексте. Краткое содержание, поиск фактов, проверка противоречий.
Ограничение

Доступность инструментов зависит от роли пользователя, лицензии, настроек проекта и наличия индексации документов для AI-функций.

9. Отчеты, аудит и мониторинг

Раздел отчетов используется администраторами, менеджерами и специалистами качества для контроля обработки, производительности, качества распознавания, пользовательской активности и аудита безопасности.

Группа отчетов Примеры Назначение
Производительность Скорость обработки, затраченное время, количество страниц, отчет по документам. Контроль нагрузки, очередей, времени OCR/ML и производительности операторов.
Качество данных Отчет по полям, качество распознавания, корректность заполнения, автозаполнение. Поиск слабых полей, оценка моделей, планирование доразметки и обучения.
Активность и аудит Изменения в документах, действия над файлами, аудит прав, аудит входов. Контроль действий пользователей, расследование инцидентов и подтверждение корректности операций.
Логи Журналы интерфейса, системные события, ошибки обработки, действия пользователей. Диагностика ошибок, мониторинг стабильности, подготовка данных для сопровождения.

10. Регламентные операции эксплуатации

Регламентные операции выполняются для поддержания работоспособности DreamDocs, контроля качества обработки и предотвращения потери данных.

Периодичность Операция Результат / контроль
Ежедневно Проверить доступность веб-интерфейса и API. Страница входа открывается, пользователи могут авторизоваться.
Ежедневно Проверить очередь загрузок и задач OCR/AI. Нет зависших задач, количество ошибок не превышает допустимые значения.
Ежедневно Проверить отчеты по ошибкам и документам в статусе [Требует исправления]. Проблемные документы назначены ответственным пользователям.
Ежедневно Проверить свободное место на диске и состояние файлового хранилища. Запас свободного места достаточен для текущего потока документов.
Ежедневно Проверить выполнение резервных копий. Резервная копия БД и файлового хранилища создана и доступна.
Еженедельно Проверить отчеты качества по типам документов и полям. Определены поля, требующие дообучения или корректировки правил.
Еженедельно Выгрузить или архивировать журналы событий при необходимости. Журналы сохранены согласно политике хранения.
Еженедельно Проверить состав пользователей и права доступа. Неактуальные пользователи отключены, роли соответствуют должностям.
Ежемесячно Проверить восстановление из резервной копии на тестовом контуре. Подтверждена пригодность резервных копий.
Ежемесячно Оценить потребление ресурсов и прогноз роста хранилища. Подготовлены рекомендации по масштабированию.
По изменению Зафиксировать изменения конфигурации проекта, ролей, интеграций и моделей. Изменения согласованы, протестированы и отражены в журнале сопровождения.

11. Резервное копирование и восстановление

Резервное копирование должно покрывать данные, без которых невозможна эксплуатация DreamDocs: базу данных, файловое хранилище, настройки проектов, конфигурационные файлы, скрипты, справочники, модели и журналы, если они требуются для аудита.

Объект Что сохранять Рекомендуемая периодичность
База данных Пользователи, роли, проекты, документы, поля, статусы, справочники, настройки, журнальные записи. Ежедневно, чаще - при высоком потоке документов.
Файловое хранилище Исходные файлы, обработанные файлы, изображения страниц, текстовые слои, экспортные архивы. Ежедневно или инкрементально.
Конфигурация Переменные окружения, настройки интеграций, параметры OCR/ML, шаблоны, скрипты. При каждом изменении и перед обновлением.
Проекты ZIP-экспорт проекта с настройками, шаблонами и справочниками. Перед значимыми изменениями и по регламенту.
Журналы Системные логи, аудит действий, аудит входов, аудит прав. По политике хранения организации.

11.1. Порядок восстановления

  1. Зафиксируйте инцидент и определите точку восстановления.
  2. Остановите пользовательские операции или переведите систему в режим обслуживания, если это требуется.
  3. Восстановите базу данных из согласованной резервной копии.
  4. Восстановите файловое хранилище и проверьте доступность документов.
  5. Восстановите конфигурацию и секреты из защищенного хранилища.
  6. Запустите сервисы приложения, фоновых задач, OCR/AI и интеграций.
  7. Проверьте вход в систему, открытие проектов, карточки документов, OCR/AI очередь и выгрузку тестового результата.
  8. Задокументируйте результат восстановления и расхождения, если они обнаружены.
RPO/RTO

Целевые значения RPO и RTO устанавливаются договором или внутренней политикой заказчика. Для типовой эксплуатации рекомендуется планировать RPO не более 24 часов и RTO в диапазоне 1-4 часа при наличии резервных копий и доступной инфраструктуры.

12. Обновление, сопровождение и контроль изменений

  • Обновления устанавливаются сначала на тестовом контуре или в технологическом окне, если это предусмотрено архитектурой.
  • Перед обновлением выполняются резервная копия БД, файлового хранилища и конфигурации.
  • После обновления проверяются вход, список проектов, загрузка тестового документа, OCR/AI обработка, ручная правка, экспорт и отчеты.
  • Изменения типов документов, справочников, скриптов и моделей должны фиксироваться в журнале изменений проекта.
  • При откате используется заранее подготовленный план восстановления предыдущей версии и совместимых данных.

13. Типовые ошибки и действия пользователя

Ситуация Возможная причина Действия
Неверная пара логин-пароль Ошибка ввода, смена пароля, неактивная учетная запись. Проверить ввод, использовать восстановление пароля, обратиться к администратору.
Нет доступа к проекту Пользователь не включен в рабочую область или проект, роль не назначена. Проверить роль и права, запросить доступ у администратора.
Кнопка недоступна Недостаточно прав, выбран неподходящий статус, документ редактируется другим пользователем. Проверить роль, статус документа и активные сессии редактирования.
Ошибка загрузки файла Неверный формат, превышение лимита, поврежденный файл, сетевой сбой. Проверить файл, размер, качество, повторить загрузку.
Низкое качество OCR Плохой скан, низкое разрешение, блики, поворот, рукописный текст. Загрузить более качественный файл или выполнить ручную проверку.
Тип документа определен неверно Недостаточно обучающих примеров, похожие типы, слабый текстовый слой. Изменить тип вручную, провести дообучение или уточнить правила классификации.
Поле подсвечено ошибкой Значение не соответствует формату, справочнику или правилу обязательности. Исправить значение, выбрать из справочника, проверить настройку поля.
Save failed Потеря соединения, сбой сервера, конфликт редактирования. Не закрывать страницу, повторить сохранение, проверить соединение и журнал ошибок.
Экспорт не формируется Нет выбранных документов, недостаточно прав, ошибка данных или превышение объема. Сузить выборку, проверить статусы, повторить экспорт, обратиться к администратору.
Задача OCR зависла Очередь перегружена, недоступен OCR-сервис, недостаточно ресурсов. Проверить очередь задач, логи, ресурсы сервера и перезапуск фоновых сервисов по регламенту.

14. Требования безопасности при эксплуатации

  • Доступ предоставляется только именованным пользователям или согласованным техническим учетным записям.
  • Права пользователей должны соответствовать выполняемым функциям и пересматриваться при изменении роли сотрудника.
  • Административные права выдаются ограниченному кругу пользователей и фиксируются в журнале изменений прав.
  • Доступ к административным интерфейсам рекомендуется ограничивать корпоративной сетью, VPN или иными согласованными средствами.
  • Пароли, ключи API, токены, параметры SMTP и интеграций не должны храниться в открытом виде в пользовательских документах или переписке.
  • Журналы входов, действий пользователей и изменений прав должны храниться в соответствии с политикой безопасности организации.
  • При увольнении или смене роли пользователя учетная запись должна быть отключена либо права должны быть пересмотрены незамедлительно.

15. Контакты поддержки и порядок эскалации

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

Уровень Когда используется Что передать
1-я линия Пользовательские вопросы, доступ, базовые ошибки интерфейса. Скриншот, описание шагов, логин пользователя, проект.
2-я линия Ошибки обработки, OCR/AI, отчеты, экспорт, роли, настройки проекта. ID документа, статус, время ошибки, журнал действий, пример файла.
3-я линия Инциденты инфраструктуры, БД, хранилища, очередей, интеграций, обновлений. Системные логи, метрики, конфигурация, версия ПО, результаты проверки сервисов.
Финальная проверка

Перед передачей документа внешней стороне необходимо проверить наименование правообладателя, версию ПО, дату, контактные данные поддержки и состав функций, доступных в конкретной поставке DreamDocs.