Общая схема модуля рабочей документации
Что это
Модуль Рабочая документация ведёт жизненный цикл листов документации внутри проекта: от заведения позиции в реестре до публикации с QR-штампом. В нём собирается работа с комплектами, документами, листами, их ревизиями, замечаниями и решениями согласующих и утверждающих.
Модуль работает в паре с модулем События и процессы: маршрут согласования и решения участников хранятся в Событиях, а содержимое (листы, ревизии, замечания) — здесь.
Как обычно работают
Главный сдвиг по сравнению с привычными системами: lifecycle есть только у листа. Комплект и документ — это группировки в реестре, у них нет своего статуса, своих ревизий, своей «текущей версии». Решения утверждающего, замечания, статусы публикации — всё привязано к листам, не к документу.
От старта проекта до выпуска документации на стройку проходит четыре крупных шага:
- Завести структуру документации. На главном экране модуля в левой панели есть кнопка «Структура документации». На открывшемся экране создаются комплекты, документы и листы. Это делается один раз при старте проекта — до запуска любого процесса.
- Настроить шаблон маршрута процесса. В модуле «События и процессы» создаётся шаблон с этапами загрузки, валидации, согласования и утверждения; назначаются ответственные. На этапе «Загрузка» назначается автор — именно этот человек получит право запускать процесс.
- Автор запускает процесс по нужному шаблону — со страницы «Маршруты процессов» или из своего кабинета событий. Запустить процесс может только пользователь, указанный автором в шаблоне; у других пользователей кнопки «Запустить процесс» нет.
- Пакет проходит этапы маршрута — автор → валидатор → согласующий → утверждающий. Решения принимаются по каждому листу отдельно: каждая страница загруженного PDF становится новой ревизией соответствующего листа, и по ней принимаются решения, фиксируются замечания, проставляется QR.
Полный пошаговый путь — на странице Маршрут загрузки рабочей документации. Это рекомендуемая точка входа для нового человека.
Жизненный цикл листа
У каждого листа в системе есть одна ось статуса — один из четырёх значений. Плюс рядом два флага: счётчик открытых замечаний и признак «есть блокирующее замечание». Метка «Можно использовать», которую видит пользователь, считается из этих трёх вещей автоматически.
Когда новая версия становится актуальной
В модуле «Документация» в итоговой таблице показывается только утверждённая версия листа. Загруженная, но ещё не утверждённая версия видна только в карточке листа и на экране маршрута пакета.
Версия становится актуальной в момент, когда утверждающий нажал «Завершить утверждение» и для этого листа принял одно из трёх «положительных» решений: «Утвердить окончательно», «Опубликовать с замечаниями» или «Выдать во временное производство». Если решение «Вернуть на доработку» — в итоговой таблице остаётся предыдущая утверждённая версия.
Постфактум
После того как лист уже опубликован, метка «Можно использовать» может меняться без перезапуска маршрута:
- Закрыли замечание через карточку замечания — метка пересчитывается автоматически.
- Появилось новое замечание (например, нормоконтроль поставил постфактум) — метка пересчитывается автоматически.
- Ручной перевод статуса в карточке листа: пользователь может перевести «Опубликовано с замечаниями» в «Опубликовано окончательно» (только если открытых замечаний нет) или обратно. Это единственное действие, которое требует явного нажатия — все остальные переходы автоматические. Подробнее в Карточка листа.
Решения по каждому листу — независимо
В одном пакете документа разные листы могут получить разные решения утверждающего. Это нормально: лист 1 — «Утвердить окончательно», лист 2 — «Опубликовать с замечаниями», лист 3 — «Вернуть на доработку». Каждый идёт в модуль «Документация» по своему сценарию.
Подробности
- Все 7 шагов первичной загрузки и отличия повторной — в Маршруте загрузки рабочей документации.
- Сводные таблицы статусов и решений — в разделе Единый словарь ниже.
- Действия каждой роли — в статьях Автор, Валидатор, Согласующий, Утверждающий.
- Как замечания влияют на метку — в Обзоре замечаний.
- Ручной перевод статуса — в Карточке листа.
Что хранится в модуле
| Что | Где смотреть |
|---|---|
| Комплекты, документы, листы реестра | Реестр рабочей документации |
| Карточка одного листа со всеми ревизиями и историей | Карточка листа |
| Пакет загрузки в работе | Экран маршрута пакета документации |
| Замечания по листам | Реестр замечаний и карточка замечания |
| Состояние решений и публикации по листам | Реестр согласований и карточка согласования листа |
| Обзорные числа и тренды | Координация и Аналитика |
Основные сущности
- Комплект — верхний уровень иерархии. Объединяет связанные документы (например, «КЖ Часть 3»). У комплекта нет собственного lifecycle, ревизий и статусов.
- Документ — группа листов одной темы в реестре. У документа есть код, наименование и список листов. У документа нет собственных ревизий, нет «текущей версии документа», нет общего статуса — всё считается как агрегат от листов.
- Лист — единица учёта lifecycle. Постоянная позиция в реестре с устойчивым идентификатором, который не меняется ни при каких загрузках. У листа есть код, наименование, текущая ревизия, история ревизий, статус публикации, открытые замечания, история решений.
- Ревизия листа — состояние листа в одной загрузке автора. У листа последовательные ревизии 1, 2, 3 и т.д. В каждый момент одна из них — текущая. Замечания и решения привязаны к конкретной ревизии листа.
- Пакет загрузки — рабочая единица одной загрузки. Создаётся, когда автор отправляет PDF; для каждой страницы, сопоставленной с листом, создаётся новая ревизия этого листа. Пакет проходит этапы валидации, согласования и утверждения, потом закрывается. Листы, которых не было в этой загрузке, не меняются.
- Замечание — формальная запись о проблеме на конкретной ревизии листа. У одного листа может быть много замечаний, в каждом — пункты и привязки на PDF. Открытые замечания наследуются на новую ревизию.
- Решение — вердикт согласующего (2 варианта) или утверждающего (4 варианта) по конкретной ревизии листа.
- Сборка PDF документа — отчётный артефакт: единый PDF документа, собранный из текущих ревизий его листов на момент запроса. Это не lifecycle-сущность: сборка может быть устаревшей, при следующем запросе соберётся свежая.
Кто работает в модуле
Четыре основные роли в маршруте загрузки и согласования:
| Роль | Что делает |
|---|---|
| Автор | Загружает файл, инициирует процесс, отвечает на замечания |
| Валидатор | Проверяет загруженный пакет, штампует QR, отправляет на согласование |
| Согласующий | Принимает решения по каждому листу и передаёт на утверждение |
| Утверждающий | Принимает финальные решения и завершает процесс |
Помимо них в модуле есть типовые задачи разных людей, которые не являются отдельными ролями в системе:
| Кто | Задача | Где это в модуле |
|---|---|---|
| Нормоконтроль | Создаёт замечания на любом этапе, контролирует блокирующие замечания | Реестр замечаний, карточка замечания |
| Руководитель проекта | Смотрит общие сводки и тренды по проекту | Координация, Аналитика |
| Инженер ПТО или администратор проекта | Ведёт структуру документации, импортирует Excel | Кнопка «Структура документации» на главном экране |
| Строитель или прораб | Сканирует QR на распечатанном листе, проверяет актуальность версии | Мобильный сканер QR |
ℹ️ Отдельной роли «координатор» в системе нет. Раздел «Координация» — это функциональный экран (дашборд), доступный любому пользователю с доступом к проекту. На него обычно заходят руководители проекта и нормоконтроль.
Подмодули
Модуль большой и делится на тематические подмодули.
Основной операционный контур
- Реестр рабочей документации — комплекты, документы, листы.
- Реестр РД через Excel — массовая работа с реестром.
- Работа в модуле РД (основной экран) — главный экран.
- Экран создания загрузки автора — форма загрузки.
- Экран маршрута пакета документации — главный экран валидатора, согласующего и утверждающего.
- Карточка листа — карточка отдельного листа.
Замечания
- Замечания: обзор — что такое замечание и его жизненный цикл.
- Создание замечания — форма с разметкой на PDF.
- Реестр замечаний — общий список и экспорт.
- Карточка замечания — детальная работа с замечанием.
Согласования
- Реестр согласований — состояние публикации и решений по листам.
Координация и аналитика
- Координация рабочей документации — дашборд.
- Аналитика рабочей документации — графики и сводки.
Ревизии и QR
- Ревизии листа и история загрузок — как устроены ревизии листа и пакеты загрузок.
- Сравнение ревизий и снимки сравнения — сравнение PDF.
- Логика QR в процессе РД — правила выпуска QR.
- Сканирование QR-кодов — мобильное сканирование.
Открытие документов и роли
- Открытие и скачивание документов — где брать актуальный PDF.
- Роль автора, Роль валидатора, Роль согласующего, Роль утверждающего.
Связь с событиями
- Интеграция РД и модуля событий — как работают вместе.
Главный показатель работы
Результат работы в модуле — не просто загруженный файл, а лист с понятным сводным состоянием. Главный сводный показатель — «Можно ли использовать этот лист на стройке прямо сейчас?»
Единый словарь статусов, меток и решений
Чтобы не путаться в терминах, в модуле зафиксированы четыре закрытых набора значений.
Статус публикации листа (одна из четырёх):
| Статус | Когда возникает |
|---|---|
| В работе | Публикации ещё не было. Лист либо у автора, либо проходит валидацию, согласование, утверждение. Либо вернулся на доработку. |
| Опубликовано с замечаниями | Утверждающий выпустил лист в работу, но с известными открытыми замечаниями. |
| Временно допущено | Утверждающий выпустил лист во временное производство (до полной доработки). |
| Опубликовано окончательно | Лист закрыт как финальный. Возможно только если на нём нет открытых блокирующих замечаний. |
Других статусов на этой оси нет.
Сводная метка «можно использовать» (одна из пяти):
| Метка | Цвет | Условие |
|---|---|---|
| Можно использовать | зелёный | Статус «опубликовано окончательно», открытых замечаний нет. |
| Можно использовать с замечаниями | оранжевый | Статус «опубликовано с замечаниями» или «опубликовано окончательно» с открытыми не блокирующими замечаниями. |
| Нельзя использовать как финальный | красный | Есть открытое блокирующее замечание. |
| Временно допущен | синий | Статус «временно допущено» без открытых блокирующих замечаний. |
| В работе | серый | Статус «в работе». |
Метка вычисляется автоматически из статуса публикации и состояния замечаний. Видна в реестре согласований и в карточке каждого листа.
Решения согласующего по листу (одно из двух):
- Согласовать — лист идёт дальше на утверждение.
- Дать замечание — создаётся замечание, лист считается требующим доработки.
Решения утверждающего по листу (одно из четырёх):
- Утвердить окончательно — лист становится «опубликован окончательно». Недоступно при открытом блокирующем замечании.
- Опубликовать с замечаниями — лист становится «опубликован с замечаниями».
- Выдать во временное производство — лист становится «временно допущен».
- Вернуть на доработку — лист идёт обратно автору; статус листа при этом не меняется.
Единый словарь статусов, меток и решений
Эта таблица — единственный источник правды для всей документации РД-модуля. Если в другой статье встречаются другие формулировки — это ошибка, нужно править ту статью.
Статус публикации листа
Один из четырёх. Хранится в системе для каждого листа.
| Название | Цвет | Когда выставляется |
|---|---|---|
| В работе | серый | Первичный статус листа до публикации. Также если лист вернули на доработку. |
| Опубликовано с замечаниями | оранжевый | Решение утверждающего «Опубликовать с замечаниями». |
| Временно допущено | синий | Решение утверждающего «Выдать во временное производство». |
| Опубликовано окончательно | зелёный | Решение утверждающего «Утвердить окончательно» или ручной перевод без открытых замечаний. |
Метка «Можно использовать»
Сводный пользовательский показатель. Вычисляется автоматически из статуса и замечаний. Прямо задать нельзя.
| Метка | Цвет | Условие |
|---|---|---|
| Можно использовать | зелёный | Статус «Опубликовано окончательно», открытых замечаний нет. |
| Можно использовать с ограничениями | оранжевый | Статус «Опубликовано с замечаниями» ИЛИ «Опубликовано окончательно» с открытыми незаблокирующими замечаниями. |
| Нельзя использовать как финальный | красный | Есть хотя бы одно открытое блокирующее замечание (независимо от статуса). |
| Временно допущен | синий | Статус «Временно допущено» без открытых блокирующих замечаний. |
| В работе | серый | Статус «В работе». |
Решения утверждающего (по каждому листу отдельно)
| Решение | Когда доступно | К какому статусу приводит |
|---|---|---|
| Утвердить окончательно | На листе нет открытых замечаний. | «Опубликовано окончательно» |
| Опубликовать с замечаниями | На листе есть хотя бы одно открытое замечание. | «Опубликовано с замечаниями» |
| Выдать во временное производство | Всегда. | «Временно допущено» |
| Вернуть на доработку | Всегда. | Статус не меняется, лист идёт автору. |
Решения согласующего (по каждому листу отдельно)
| Решение | Что значит |
|---|---|
| Согласовать | Лист уходит дальше на утверждение. |
| Дать замечание | Создаётся замечание прямо на PDF, лист помечается как требующий доработки. |
Важное правило: решение по листу само по себе процесс не двигает. Процесс между этапами двигают только финальные кнопки «Отправить на согласование», «Передать на утверждение», «Завершить утверждение» в шапке экрана. Подробнее в Экран маршрута пакета документации.
Как читать раздел дальше
Если вы впервые знакомитесь с модулем:
- Начните с дорожной карты: Маршрут загрузки рабочей документации — главная точка входа для онбординга, сквозной путь от настройки проекта до публикации.
- Заведите структуру: Реестр рабочей документации — экран «Структура документации», без этого ничего нельзя загрузить.
- Посмотрите главный экран: Работа в модуле РД — что вы видите при открытии модуля.
- Изучите экран маршрута пакета: Экран маршрута пакета документации — рабочее место валидатора, согласующего и утверждающего.
- Разберитесь с замечаниями: Замечания: обзор.
- Посмотрите карточку листа: Карточка листа — место, где собирается всё про один лист.
- Откройте координационный дашборд: Координация рабочей документации.