Confluence · Cloud

Excerpt в Confluence Cloud: одна инструкция вместо нескольких копий

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

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

Задача: общий блок расходится в разных инструкциях

Представим учебный сценарий: команда поддержки ведёт инструкции по доступу к нескольким сервисам. В каждой странице повторяется один блок о том, какие сведения приложить к заявке. После изменения процесса редакторы исправляют одну страницу, а остальные продолжают показывать старые требования. Это пример задачи, а не описание выполненного клиентского проекта.

Для такого блока можно использовать Excerpt на странице-источнике и Insert excerpt на страницах-потребителях. В документации также встречается название Excerpt Include. Фрагмент хранится в одном месте. Инструкции продолжают содержать собственные шаги, но общий текст перестаёт быть независимой копией. Далее предлагается порядок пилота, проверки и передачи в сопровождение.

Применимость и подготовка пилота

Руководство предназначено для Confluence Cloud и обычных страниц в облачном редакторе. У Cloud нет фиксированной версии установки, которую можно указать для всех клиентов: интерфейс обновляется постепенно. Не переносите эти шаги автоматически на Data Center или старый редактор; сначала откройте документацию своей версии. Здесь используются встроенные макросы, установка Marketplace-приложения для этого сценария не требуется.

Подготовьте одну исходную страницу, две тестовые инструкции и двух пользователей: редактора и обычного читателя. Возьмите нейтральный текст без персональных данных и секретов. Отдельно зафиксируйте, кто должен читать исходную страницу и кто вправе её менять. На бесплатном плане нельзя настраивать ограничения доступа к отдельному содержимому; не планируйте конфиденциальный пилот на основании недоступных возможностей тарифа.

Создайте исходный фрагмент

Создайте страницу «Общие блоки поддержки» в согласованном пространстве. Через меню вставки найдите макрос Excerpt и добавьте его на страницу. Задайте понятное уникальное имя, например request-required-details. Внутрь поместите небольшой законченный блок: название сервиса, описание симптома, время возникновения и обезличенный пример ошибки. Не включайте в него инструкции, которые различаются между сервисами.

Опубликуйте страницу и запишите её ссылку и имя фрагмента в рабочий реестр. Если на одной странице хранится несколько блоков, каждому дайте отдельное имя. Без имени выбор нужного фрагмента становится неоднозначным: документация предупреждает о поведении первого безымянного Excerpt. Параметр скрытия фрагмента на исходной странице относится к отображению; его нельзя использовать вместо управления доступом.

Подключите блок к двум инструкциям

Откройте первую тестовую инструкцию и найдите Insert excerpt в меню вставки. Выберите исходную страницу, затем имя request-required-details в списке фрагментов. Посмотрите предварительный результат и вставьте макрос. Пока сохраняйте рамку и заголовок, чтобы редактору было проще заметить связь с источником. Повторите настройку во второй инструкции и опубликуйте обе страницы.

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

Проверьте результат от имени читателя

Добавьте в исходный фрагмент безвредную контрольную фразу, опубликуйте изменение и заново откройте обе инструкции. Критерий приёмки: фраза отображается в двух местах, хотя потребителей отдельно не редактировали. Затем удалите контрольную фразу из источника и повторите проверку. Это предлагаемый тест, а не заявление о выполненной проверке в вашей Confluence.

Повторите просмотр под обычной учётной записью и проверьте прямое открытие исходной страницы. Отдельно посмотрите доступ из пространства, где находится вторая инструкция. Если доступ к источнику и потребителю различается, не расширяйте права вслепую ради исчезновения ошибки: сначала согласуйте аудиторию. Проверьте также отображение на узком экране, читаемость ссылок и отсутствие формулировок вроде «выше», которые теряют смысл после вставки.

Типовые ошибки и безопасный откат

Если выводится другой блок, сравните выбранную страницу, пространство и точное имя Excerpt. Если фрагмент пуст или недоступен, сначала проверьте, опубликован ли источник и способен ли читатель открыть его напрямую. После переноса или переименования страницы повторите пилотную проверку связей, прежде чем изменять десятки инструкций. Не делайте вложенную цепочку из множества включений: расследование ошибки должно оставаться понятным следующему редактору.

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

Передача библиотеки в сопровождение

Назначьте владельца каждого общего блока и правило согласования изменений. Держите фрагмент коротким, с устойчивым назначением: один блок отвечает на один повторяющийся вопрос. Пример записи реестра: request-required-details; владелец — руководитель поддержки; потребители — инструкции доступа к двум сервисам; проверка — просмотр обычным читателем после изменения. Это организационная рекомендация, а не встроенный механизм согласования макроса.

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

Официальная документация

Применить это к вашей системе

Обсудим контекст, ограничения и безопасный порядок изменений.

Обсудить задачу