Использовать этот шаблон
Confluence — одна из самых используемых баз знаний в мире, а отличные шаблоны Confluence делают её масштабируемой. С Trupeer вы можете сэкономить часы на дизайне шаблонов Confluence, начав с нашего бесплатного руководства и библиотеки шаблонов, настроив их с помощью ваших бренд-гайдлайнов и превращая страницы Confluence в видео-обходы, которые оживляют документацию.
Большинство команд, которые настраивают шаблоны Confluence, в итоге приходят к одному и тому же: сорок шаблонов в пространстве, три из них используются, а остальные продолжают копировать страницу прошлого квартала и удалять содержимое.
Создать шаблон — самая простая часть, и Atlassian хорошо описывает это в документации. Важнее всего то, что вы в него вложите, где вы это разместите и сможет ли кто-то найти нужное в тот момент, когда оно понадобится.
Что такое шаблоны Confluence
Повторно используемая структура страницы, которая становится отправной точкой для новой страницы. Когда кто-то создаёт страницу по шаблону, он получает уже готовые заголовки, разметку, макросы и обучающий текст — то есть заполняет, а не проектирует.
Существует четыре типа, и понимание того, с чем вы имеете дело, избавляет от путаницы.
Тип | Создано | Доступно в | Редактируется вами |
|---|---|---|---|
Системные шаблоны | Atlassian, встроенные | Везде | Нет |
Blueprints | Atlassian или приложения | Везде | Не напрямую |
Глобальные шаблоны | Ваши администраторы | Все пространства | Да, с правами администратора |
Шаблоны пространства | Администраторы пространства | Одно пространство | Да |
Большая часть того, что команда создаёт, — это шаблоны пространства. Глобальные шаблоны нужны для вещей, которые требуются каждому пространству, например формат заметок о встрече или запись решения.
Blueprints Confluence vs шаблоны
Частая причина путаницы — и стоит разобраться в этом, прежде чем пытаться создать то, что шаблон не умеет.
Шаблон — это структура страницы. Вы создаёте по нему страницу, и получаете эту структуру.
Blueprint — это шаблон плюс поведение. Blueprints могут показывать диалог до создания страницы, генерировать больше одной страницы, создавать индексную страницу со списком всех страниц этого типа и применять логику, которую обычный шаблон не может. Привычные примеры — meeting notes и decision blueprints от Atlassian, а поддерживаемая ими индексная страница — та часть, которую шаблон не может воспроизвести.
Практические выводы: вы можете создавать и редактировать шаблоны самостоятельно, но вы не сможете собрать blueprint без разработки приложения. Если вам нужно поведение, похожее на blueprint, без разработки, обычно используют шаблон в сочетании с макросом Create from Template на родительской странице, а также отчёт по свойствам страницы, чтобы собрать индекс.
Если кто-то просит «blueprint», обычно он имеет в виду, что ему нужна индексная страница.
Глобальный или шаблон пространства?
Решите до того, как будете собирать, потому что перенос позже означает пересоздание.
Глобальный, когда он нужен каждому пространству, когда важна согласованность по всей организации или когда он поддерживает процесс на уровне всей компании. Заметки о встречах, записи решений, отчёты об инцидентах, уставы проектов.
Пространство, когда это специфично для способа работы одной команды, когда это будет меняться часто или когда вы всё ещё тестируете, полезно ли это. Большинство шаблонов начинаются отсюда, и некоторые «выпускаются» дальше.
Ловушка — сделать всё глобальным, потому что так кажется аккуратнее. Глобальная библиотека из шестидесяти шаблонов неудобна для навигации, а администраторы пространства не могут исправить глобальный шаблон, который им не подходит.
Как настроить этот шаблон в Trupeer
Шаг 1: Откройте раздел Templates
Перейдите в раздел Templates из главной навигации.
Шаг 2: Выберите и откройте шаблон
Нажмите на любой шаблон, с которым хотите работать, чтобы открыть его.
Шаг 3: Разверните просмотр шаблона
При необходимости разверните просмотр шаблона, чтобы увидеть полную разметку и детали более чётко.
Шаг 4: Отредактируйте шаблон
Нажмите Edit, чтобы начать изменять выбранный шаблон.
В редакторе вы можете:
Добавить новые разделы
Задать или обновить правила форматирования
Добавить логотип и настроить его положение и связанные параметры
Шаг 5: Сохраните настроенный шаблон
После того как вы внесёте все необходимые изменения, нажмите Save, чтобы сохранить обновлённый шаблон как свой.
Шаг 6: Предпросмотр и точная настройка шаблона
Когда вы захотите увидеть, как выглядит ваш настроенный шаблон, откройте Preview.
На экране предпросмотра при необходимости вы можете продолжить вносить правки напрямую, чтобы шаблон выглядел ровно так, как вам нужно.
С этим руководством по шаблонам Confluence вы можете:
Экономить время на документации: используйте проверенные шаблонные паттерны Confluence вместо того, чтобы начинать с нуля.
Добиваться согласованности: каждая команда использует одну и ту же структуру для похожих документов.
Оставаться в фирменном стиле: применяйте логотип, шрифты и цвета с помощью бренд-кита Trupeer.
Закрывать все сценарии: шаблоны для встреч, проектов, решений, ретроспектив и многого другого.
Добавлять видео-обходы: встраивайте видеоуроки прямо в страницы Confluence.
Достигать глобальных команд: переводите контент Confluence на 65+ языков в один клик.
Когда стоит создать свой
Не так часто, как думают. Atlassian поставляет большое количество шаблонов, а в Marketplace их ещё больше.
Создавайте свой, когда существующий шаблон близок, но в нём неправильные разделы, когда вам нужны поля, специфичные для компании (например, cost centre или строка согласования), когда вы хотите стабильную структуру для того, что выпускаете еженедельно, или когда одну и ту же страницу постоянно копируют и редактируют.
Не создавайте шаблон для того, что выходит два раза в год, или когда реальная проблема в том, что люди не знают, как написать документ, а не в том, как его структурировать. Шаблон решает проблему форматирования. Он не решает проблему мышления.
Как создать шаблон Confluence
Механика немного отличается между Confluence Cloud и Data Center, а Atlassian периодически меняет детали, поэтому для точных путей кликов проверьте их актуальную документацию. Общая схема процесса остаётся стабильной.
Перейдите в настройки пространства для шаблона пространства или в область глобального администрирования для глобального. Шаблоны находятся в области администрирования, а не создаются из страницы.
Создайте новый шаблон и дайте ему понятное имя.
Соберите структуру в редакторе шаблона: заголовки, разметки, таблицы, макросы.
Добавьте переменные для всего, что пользователь должен заполнить по запросу.
Добавьте текст-заполнитель, чтобы объяснить, что должно быть в каждом разделе.
Добавьте метки, чтобы страницы, созданные по шаблону, автоматически категоризировались.
Напишите описание. Это то, что люди видят при выборе шаблона, и почти всегда оставляют пустым.
Сохраните, затем создайте тестовую страницу по нему и посмотрите, что на самом деле испытывает пользователь.
Восьмой шаг ловит большинство проблем. Редактор шаблона и получившаяся страница выглядят по-разному, и то, что казалось понятным в редакторе, часто оказывается не таким.
Создание шаблона из существующей страницы
В Confluence нет встроенного варианта «преобразовать эту страницу в шаблон» в один клик — и это удивляет людей. Что работает на практике:
Откройте существующую страницу, скопируйте её содержимое, создайте новый шаблон в пространстве или в области глобальных шаблонов и вставьте содержимое. Затем удалите всё, что относится именно к этому экземпляру: имена, даты, реальные данные, завершённый контент. Замените удалённый контент текстом-заполнителем с объяснением, что должно быть там, и добавьте переменные для полей, которые нужно запрашивать.
Именно шаг с «очисткой» обычно идёт не так. Шаблон, сделанный из реальной страницы, где конкретика удалена наполовину, создаёт страницы с данными другого человека — и это будет копироваться дальше бесконечно, пока кто-то не заметит.
Некоторые приложения Marketplace добавляют прямое преобразование страницы в шаблон — стоит рассмотреть это, если вы делаете так часто.
Переменные
Поля, которые пользователь должен заполнить, когда создаёт страницу по шаблону. Они отображаются как форма до открытия страницы.
Используйте их для небольшого набора значений, которые определяют страницу: название проекта, клиент, дата, номер спринта, владелец. Когда кто-то создаёт страницу, он заполняет эти значения один раз, и они подставляются везде, где встречается переменная.
Две ограничения, которые стоит знать. Переменные заполняются во время создания и затем не редактируются как переменные — они просто становятся текстом на странице. И лучше держать их в небольшом количестве, потому что шаблон, который открывается с формой из двенадцати полей, быстро забрасывают в пользу копирования старой страницы.
Три-пять переменных — разумный максимум.
Текст-заполнитель
Обучающий текст, который отображается серым в шаблоне и исчезает сразу, как только пользователь начинает печатать поверх него. Это самая недоиспользуемая функция в шаблонах Confluence и та, которая сильнее всего улучшает внедрение.
Хороший текст-заполнитель подсказывает человеку, что должно быть в разделе, и, по возможности, как выглядит хороший результат. «Опишите решение, варианты, которые рассматривались, и почему выбрали именно этот. Два или три предложения». Это намного полезнее, чем пустой заголовок.
Ключевое свойство — он не сохраняется. Обычный текст, оставленный в шаблоне, публикуется внутри реальных страниц, и вы обнаружите обучающий текст, который живёт постоянно в половине вашей документации. Текст-заполнитель исчезает, когда его заменяют, и исчезает, когда страница публикуется без изменений.
Используйте его для каждого раздела, где человек может разумно задуматься, что там должно быть — а таких разделов большинство.
Метки
Шаблоны могут автоматически применять метки ко всем страницам, созданным по ним.
Это важнее, чем кажется, потому что метки делают контент Confluence находимым и пригодным для отчётов. Шаблон заметок о встречах, который применяет метку meeting-notes, означает, что вы можете собрать индекс всех заметок о встречах в пространстве, фильтровать по метке в поиске и использовать отчёты по свойствам страниц.
Задайте метки в шаблоне — и пользователям не придётся помнить. Пусть пользователи добавляют метки вручную, и почти никто этого не сделает.
Макрос Create from Template
Ближайшее к поведению blueprint без разработки приложения — и функция, о которой большинство людей даже не знает.
Разместите макрос на странице, укажите на шаблон — и он отрисует кнопку. Любой, кто нажмёт на неё, создаст новую страницу по этому шаблону, при желании — как дочернюю страницу указанной родительской страницы.
Это решает проблему находимости — главную причину, почему шаблоны остаются невостребованными. Вместо того чтобы ожидать, что люди перейдут к выбору шаблона и будут искать в списке, вы размещаете кнопку там, где идёт работа: кнопка на домашней странице команды с надписью «New meeting note», кнопка в пространстве проекта с надписью «Raise a decision record».
Если объединить это с отчётом по свойствам страницы на той же странице, вы получите почти blueprint: кнопку для создания и автоматически поддерживаемый индекс всего, что было создано.
Если вы создаёте что-то одно по этому руководству — создайте именно это.
Дизайн шаблона, который люди действительно будут использовать
Меньше разделов. Шаблон из двенадцати разделов заполняют наполовину и бросают. Обычно достаточно шести.
Упорядочивайте по тому, когда люди знают нужное. Сверху разместите то, что они могут заполнить сразу, а ниже — то, что требует исследования.
Текст-заполнитель везде, с объяснением, что должно быть в каждом разделе.
Таблицы для всего структурированного, потому что свободный текст под заголовком даёт несогласованный контент.
Не называйте конкретных людей. Они меняют роли, а шаблон — нет.
Следите за шириной страницы. Шаблоны, разработанные на большом мониторе, в других местах могут выглядеть тесно, а разметки на всю ширину подходят не для каждого типа контента.
Будьте осторожны с макросами. Не каждый макрос ведёт себя одинаково внутри шаблона, и сложная вложенность — это то место, где шаблоны ломаются так, что трудно отлаживать.
Напишите описание. Это то, что люди читают при выборе, и почти всегда оно пустое.
Как сделать шаблоны находимыми
Реальная причина, почему шаблоны не работают, и почти ничто в документации Atlassian не затрагивает это.
Стандартный путь требует помнить, что шаблоны существуют, открывать выбор шаблона и определять нужный из списка имён. На каждом из этих шагов копировать страницу прошлого квартала проще.
Что работает:
Кнопки макроса Create from Template на тех страницах, где люди начинают работу.
Индексная страница шаблонов в каждом пространстве с перечнем того, что есть, и когда использовать каждый.
Описательные названия. «Еженедельные заметки команды», а не «Template 3» или «TMPL_MTG».
Заполненные описания, потому что выборщик их показывает.
Меньше шаблонов. Шесть находимых и поддерживаемых шаблонов лучше, чем сорок ненайденных.
Упоминание шаблонов в процессе, а не просто наличие. Если в вашем чек-листе онбординга написано «create a project brief», привяжите к этому кнопку.
Как добиться внедрения
Спросите тех, кто будет использовать, какие разделы им нужны, ещё до сборки. Шаблоны, которые администратор делает для команды, в которой он не участвует, игнорируют.
Запустите пилот с одной командой перед глобальным развёртыванием.
Покажите один раз, вживую. Тридцать секунд на командной встрече лучше, чем объявление, которое никто не читает.
Замените альтернативу. Если люди копируют старую страницу, архивируйте старую или сделайте кнопку более удобной, чем поиск.
Смотрите, что удаляют. Если каждый пользователь удаляет один и тот же раздел, уберите его.
Смотрите, что добавляют. Если люди стабильно добавляют раздел, добавьте его в шаблон.
Последние два сигнала — самые полезные, но почти никто на них не смотрит.
Поддержка библиотеки
Назначьте владельца для каждого шаблона, роль с именем, а не администратор пространства в целом.
Проверяйте раз в квартал, удаляя всё, что не используется. Confluence не сообщает напрямую об использовании шаблонов, поэтому прокси — это подсчёт страниц, которые несут метку шаблона.
Версионируйте изменения в описании шаблона, чтобы люди понимали, что он обновился.
Активно чистите библиотеку. Библиотека, где треть шаблонов устарела, учит людей тому, что ни один из них не заслуживает доверия.
Проверяйте после обновлений Confluence, потому что изменения в редакторе иногда влияют на то, как шаблоны отображаются.
Известные ограничения
Стоит знать это заранее, прежде чем вы будете проектировать вокруг того, что не работает.
Не каждый макрос ведёт себя одинаково в шаблоне, как на странице, и некоторые не переносятся корректно. В целом вложения нельзя включать в шаблон. Переменные — только для момента создания, а не «живые» поля. Нет встроенного преобразования страницы в шаблон. Шаблоны не могут принудительно обеспечивать завершённость, поэтому ничто не мешает пользователю опубликовать страницу со всеми пустыми разделами. И вы не сможете построить настоящее blueprint-поведение, включая создание нескольких страниц и автоматическое поддержание индекса, без разработки приложения.
Несколько приложений Marketplace закрывают эти пробелы — стоит изучить их, если ограничения блокируют что-то важное.
Лучшие практики
Шаблоны пространства по умолчанию, глобальные — только когда они нужны всем.
Шесть разделов или меньше.
Текст-заполнитель в каждом разделе.
Максимум три-пять переменных.
Метки применяются шаблоном, а не пользователем.
Описания написаны.
Кнопки макроса Create from Template там, где начинается работа.
Пилот с одной командой перед развёртыванием.
Владелец и ежеквартальная проверка для каждого шаблона.
Удаляйте всё, что не используется.
Частые ошибки
Собирают шаблон, не спросив людей, которые будут его использовать.
Двенадцать разделов, поэтому страницы заполняют наполовину.
Нет текста-заполнителя, поэтому никто не знает, что где должно быть.
Обучающий текст набран как обычный текст — и затем появляется на каждой опубликованной странице.
Оставляют реальные данные в шаблоне, сделанном из существующей страницы.
Вшивают имена конкретных людей.
Пустые описания, поэтому выборщик бесполезен.
Всё создаётся как глобальный шаблон.
Шаблоны существуют, но нигде не связаны с теми местами, где люди работают.
Сорок шаблонов, три в использовании.
Нет владельца, поэтому ничего не обновляется.
Ожидают, что шаблон решит проблему, которая на самом деле в том, что люди не знают, что писать.
Шаблон даёт структуру, а не контент
Шаблоны Confluence хорошо решают структурную проблему. Они не могут решить более распространённую: люди знают, какие разделы нужны документу, но всё равно не могут их заполнить, потому что описываемый процесс живёт в чьей-то голове.
Этот разрыв проявляется в шаблонах, заполненных одной строкой на раздел. Структура правильная, а контент тонкий — и никакой текст-заполнитель это не исправит.
Зафиксируйте процесс один раз — и Trupeer AI создаст письменную документацию и озвученный видео-обход из того же прохода, который вы можете встроить в страницу Confluence вместо того, чтобы описывать систему прозой. Примените ваш бренд-кит, чтобы всё совпадало, переведите на 65+ языков для распределённых команд и храните набор в вашей базе знаний вместе с тем, что уже живёт в Confluence.
Зафиксируйте. Оформите в бренде. Переведите. Trupeer-ите.
Часто задаваемые вопросы
Как создать шаблон в Confluence?
Шаблоны создаются из настроек пространства для шаблона пространства или из глобального администрирования для глобального — а не из страницы. Соберите структуру в редакторе шаблона, добавьте переменные для запрашиваемых полей, добавьте текст-заполнитель с объяснением каждого раздела, примените метки и напишите описание. В документации Atlassian есть актуальные шаги «клик за кликом», которые меняются периодически.
Как создать шаблон Confluence из существующей страницы?
Нет встроенного преобразования в один клик. Скопируйте содержимое страницы, создайте новый шаблон, вставьте его, затем удалите всё, что относится именно к этому экземпляру: имена, даты, реальные данные и завершённый контент. Замените то, что вы удалили, текстом-заполнителем. Именно шаг с «очисткой» обычно идёт не так, и оставшиеся реальные данные копируются дальше бесконечно.
Шаблоны Confluence бесплатны?
Confluence включает большой набор встроенных шаблонов и blueprints во всех тарифах, а вы можете создавать свои без дополнительных затрат. Некоторые приложения Marketplace, которые добавляют функциональность шаблонов, например преобразование страницы в шаблон или пакетное управление, платные.
В чём разница между blueprint Confluence и шаблоном?
Шаблон — это структура страницы, по которой вы создаёте страницу. Blueprint — это шаблон плюс поведение: он может показывать диалог, создавать несколько страниц и поддерживать индексную страницу со списком всего, что было создано по нему. Вы можете создавать шаблоны самостоятельно, но blueprints требуют разработки приложения. Если кто-то спрашивает про blueprint, обычно ему нужна индексная страница — и вы можете приблизиться к этому с помощью макроса Create from Template и отчёта по свойствам страницы.
Как использовать шаблоны в Confluence?
При создании страницы выбирайте шаблон, а не начинайте с пустого. Если в шаблоне есть переменные, вам предложат заполнить их до открытия страницы. Либо нажмите кнопку макроса Create from Template, размещённую на странице — это более надёжный путь, потому что он помещает шаблон туда, где люди уже работают.
Что такое макрос Create from Template?
Это макрос, который вы размещаете на странице и который отображает кнопку. Нажатие на неё создаёт новую страницу по указанному шаблону, при желании — под указанной родительской страницей. Это самое эффективное исправление для низкого внедрения шаблонов, потому что убирает необходимость кому-то искать выборщик шаблонов. Сочетайте это с отчётом по свойствам страницы на той же странице — и вы получите почти blueprint-поведение.
Что такое текст-заполнитель шаблона Confluence?
Обучающий текст, который отображается серым в шаблоне и исчезает сразу, как только пользователь начинает печатать поверх него, и не появляется на опубликованной странице, если его не трогать. Используйте его, чтобы объяснить, что должно быть в каждом разделе. Это отличается от обычного текста, который вводят в шаблон: он сохраняется и публикуется внутри реальных страниц.
Как сделать красивые шаблоны страниц Confluence?
Умеренность помогает больше, чем декор. Используйте разметки экономно, потому что тяжёлые много-колоночные дизайны плохо выглядят на небольших экранах. Используйте таблицы для структурированного контента вместо свободного текста. Добавляйте макросы информации и заметок, чтобы выделить две-три вещи, которые действительно важны, а не всё подряд. Держите разделы короткими. И проверяйте, как это выглядит в обычном браузере по ширине, а не только на большом мониторе, на котором вы это проектировали.
Сколько шаблонов Confluence должна иметь команда?
Меньше, чем в итоге получают большинство команд. Шесть находимых и поддерживаемых шаблонов стоят больше, чем сорок в выборщике, который никто не прокручивает. Если после квартала треть вашей библиотеки не используется, почистите её: устаревшая библиотека учит людей не доверять ничему из неё.
Почему никто не использует наши шаблоны Confluence?
Обычно проблема не в качестве, а в находимости. Стандартный путь требует помнить о существовании шаблонов, открывать выборщик и определять нужный, и на каждом шаге копировать старую страницу проще. Размещайте кнопки Create from Template там, где начинается работа, пишите описания и убедитесь, что шаблон упоминается в процессе, а не просто доступен.
Можно ли редактировать шаблон Confluence после того, как по нему создали страницы?
Да, и редактирование не меняет страницы, которые уже были созданы. Шаблоны — это отправная точка, а не «живая» ссылка, поэтому существующие страницы сохраняют структуру, с которой они были созданы. Это означает, что исправление шаблона улучшит только будущие страницы, а всё уже неправильное останется неправильным.
Что такое переменные шаблона Confluence?
Поля, которые пользователь должен заполнить при создании страницы по шаблону, например название проекта или дата. Значения подставляются везде, где встречается переменная. Они заполняются во время создания и затем становятся обычным текстом, а не остаются редактируемыми полями. Держите их в диапазоне трёх-пяти, потому что длинная форма при создании страницы возвращает людей к копированию старых страниц.
