Настройте свой сайт и разделы
Прежде чем начать работу с этим обучающим материалом, оформите подписку на бесплатную пробную версию Confluence Cloud. С помощью этого руководства вы настроите свой первый проект. Не закрывайте вкладку, пока будете оформлять подписку. Мы подождем вас.
Это руководство предназначено для Confluence Cloud. Если вас заинтересовала версия продукта с самостоятельным управлением, перейдите по ссылке >>
Если вы используете вариант Confluence Data Center или Confluence Server, узнайте из этого обучающего руководства, как создавать и редактировать страницы в Confluence.
Шаг 1. Изучение разделов
Сайт Confluence разбит на разделы. Разделы — это наборы связанных общим содержанием страниц, с которыми работаете вы и другие участники команды или сотрудники организации. В большинстве организаций используется несколько типов разделов: разделы для команд, разделы проектирования ПО, разделы документации и разделы баз знаний.
Используйте разделы для команд, чтобы вовлечь участников команды в совместную работу для достижения масштабных целей и показателей OKR. Например, вы можете создать раздел для маркетинговой команды, чтобы она ориентировалась на OKR, была в курсе руководств по использованию брендов и основ рекламных сообщений и понимала общую маркетинговую стратегию организации.
Используйте разделы проектирования ПО для отслеживания отдельных инициатив и проектов. Например, можно создать раздел проектирования, который станет единым источником достоверной информации обо всем, что связано с новой функциональной возможностью, которую разрабатывает компания: от требований к продукту и технических характеристик до протоколов собраний и ретроспектив.
Используйте разделы документации для создания и упорядочения технической документации по продуктам и услугам, чтобы упростить ее дальнейшее применение.
Используйте разделы баз знаний для хранения и извлечения ответов на распространенные вопросы, например разъяснения политик или ИТ-решений. Если вы оформили подписку на Jira Service Management, можно интегрировать этот продукт с сайтом Confluence, чтобы клиенты получили доступ к статьям из базы знаний.
Используйте личный раздел в качестве «песочницы» для упорядочения своих заметок, отслеживания личных OKR и целей, а также черновых вариантов предложений по проектам, которые еще не попали в дорожную карту. Установите контакт с командой через записи в блоге. Это помогает познакомиться или сообщить, над чем вы в данный момент работаете.
Прежде чем создавать кучу разделов, подумайте о том, как организация будет использовать Confluence Cloud. Вот некоторые типовые примеры использования.
Проектирование в Confluence
Меня зовут Маша, я работаю инженером по обеспечению качества в группе компаний Тинькофф. Работа QA предполагает множество коммуникаций с разными людьми из разных команд, а я к тому же была менеджером и лектором образовательных программ, поэтому моя карта коммуникаций была максимально широкой. И в какой-то момент я взорвалась: я поняла, что больше не могу, не могу, не могу заполнять адовые тонны нечитаемых таблиц и документов.
Наверняка каждый из вас представил себе сейчас то, о чем я говорю, и облился холодным потом: списки фамилий без алфавитного порядка, таблицы в сотни столбцов со съехавшей версткой, таблицы в тысячи строк, в которых нужно стирать свой палец об колесико мыши, чтобы посмотреть заголовок, тонны страниц непронумерованных инструкций, сотни пересылаемых друг другу писем с данными, которые надо проанализировать и систематизировать и запихнуть в такие же нечитаемые таблицы.
И вот, когда я немного остыла, я решила написать эту статью. Я расскажу о том, как можно нормально (даже порой удобно) вести разнообразную непродуктовую документацию. Надеюсь, что статья разлетится по сети и уровень адища в соседних с разработкой отделах хоть чуть-чуть снизится, а люди (и я в том числе) станут чуточку счастливее.
Инструменты
Продуктовая документация часто хранится рядом с кодом, и это хорошо. А непродуктовая документация обычно хранится где попало. Часто люди стараются переносить информацию из разных мест в Confluence, и мы не исключение. Так что весь дальнейший рассказ о нем.
Вообще Confluence — это продвинутый вики-движок. Он позволяет работать с данными в разных видах отображения: текст с форматированием, таблицы, разнообразные диаграммы. Это очень интересный и мощный инструмент, но если не уметь его готовить, то вы получите очередную свалку нечитаемых документов. Я научу вас готовить!
Макросы
Почти вся магия Confluence строится на макросах. Макросов очень много, и их можно комбинировать друг с другом. Они бывают платными и бесплатными, далее будут разные примеры макросов со ссылками на документацию для них.
Интерфейс работы с макросами максимально прост. Чтобы добавить макрос, надо нажать на плюс и выбрать нужный элемент из списка.
Если макрос самодостаточный, то есть не требует вставки чего-то еще внутри себя, — он выглядит как блок.
Если для работы макроса нужно что-то поместить внутрь него, он выглядит как рамка.
При этом можно помещать внутрь одной рамки сколько угодно других, лишь бы в вашей пирамиде была логика.
У каждого макроса есть предварительный просмотр: в нем сразу видно, правильно ли вы заполнили и настроили макрос.
Шаблоны
Помимо макросов есть удобный инструмент предзаполнения контента — это шаблон.
Шаблоны можно использовать при создании любой страницы: просто нажать на три точки рядом с кнопкой «Создать» и выбрать нужный шаблон.
Тогда в созданную страницу добавится весь контент, который есть в шаблоне.
Создавать страницы из шаблонов может кто угодно, а вот создавать или редактировать сами шаблоны — только те, у кого есть на это права. В шаблон можно добавить дополнительные инструкции о том, как следует вести страницу.
Магия таблиц
Вообще-то я, как технарь, нежно люблю таблицы и могу почти любую информацию в них завернуть (хотя это и не всегда эффективно). Сами по себе таблицы четкие, структурированные, масштабируемые, волшебные!
Но даже такую замечательную сущность, как таблица, можно испортить. А можно удачно использовать и даже улучшить. Об этом ниже.
Фильтрация (платный плагин)
Любую огромную нечитаемую таблицу можно сделать чуть менее огромной и чуть более читаемой с помощью фильтрации. Для этого можно использовать платный макрос «Фильтр таблиц».
Внутрь этого макроса надо засунуть таблицу (можно даже самую уродливую, главное — запихнуть ее целиком). В макросе можно выбрать столбцы для фильтра с выпадающим списком, текстового фильтра, числового и фильтра по датам.
Вот представьте, что всю информацию по кандидатам на все вакансии записывают табличным списком. Естественно, неотсортированным — люди же приходят на собеседования не по алфавиту. А вам надо понять, проводили ли вы собеседование с конкретным соискателем раньше. Надо просто засунуть этот ад в макрос фильтра, добавить текстовый фильтр по фамилии — и вуаля, информация у вас на экране.
Стоит отметить, что фильтрация огромных таблиц может влиять на работу системы и время загрузки страниц, поэтому засунуть огромную таблицу в фильтр — временный костыль, лучше выстроить процесс, в котором людям не приходится создавать огромные нечитаемые таблицы (пример процесса будет в конце статьи).
Сортировка (платный плагин)
С помощью волшебного макроса «Фильтр таблиц» также можно задать сортировку по умолчанию по любому столбцу и пронумеровать строки. Или нажать на любой столбец таблицы, засунутой в макрос фильтра, и произойдет сортировка по этому столбцу.
Например, у вас есть та же самая таблица с соискателями и надо прикинуть, сколько собеседований было проведено в определенный месяц, — сортируйте по дате и радуйтесь.
Сводные таблицы (платный плагин)
Теперь перейдем к кейсу поинтереснее. Представьте, что ваша таблица огромная и надо что-то посчитать по ней. Конечно, можно скопировать ее в Excel, посчитать нужное и выгрузить данные назад в Confluence. А можно один раз применить макрос «Сводная таблица» и получить тот же результат, только еще и обновляемый.
Например: у вас есть таблица, в которой собраны данные всех сотрудников — где они территориально находятся и какие должности занимают. Чтобы посчитать, сколько человек находится в каждом городе, вам нужно выбрать в макросе «Сводная таблица» строку, по которой агрегируются данные (местоположение) и тип операции (сложение).
Естественно, группировать можно по нескольким признакам сразу, все возможности можно посмотреть в документации.
Диаграммы (платный плагин)
Как я уже говорила, не все любят таблицы так сильно, как я. К сожалению, менеджеры в большинстве своем их вообще не любят. Зато все очень любят яркие цветные диаграммы.
Создатели Confluence об этом, безусловно, знали (наверняка у них тоже есть начальство, которое любит отчеты и диаграммы, куда же без него). Поэтому можно воспользоваться волшебным макросом «Диаграмма из таблицы». В этот макрос нужно положить сводную таблицу из предыдущего пункта, и вуаля — ваши серые скучные данные красиво визуализированы.
Естественно, в этом макросе тоже есть настройки. Ссылку на документацию к любому макросу можно найти в режиме редактирования этого макроса.
Простота агрегации
Информация из предыдущих пунктов наверняка не была для вас откровением. Но теперь вы точно умеете пользоваться макросами, а я могу перейти к более интересной части статьи.
Метки
Плохо, когда люди хранят информацию в одной неструктурированной статье или огромной таблице. Еще хуже — когда части этой информации не только нечитаемо оформлены, но и раскиданы по просторам Confluence. Благо есть возможность собрать раскиданную информацию в одном месте. Для этого надо воспользоваться метками (знакомыми всем по соцсетям тегами).
На любую страницу можно добавить любое количество меток. Если нажать на метку, вы попадете на страницу агрегации, где есть ссылки на все материалы с этой меткой, а также с набором связанных меток. Связанные метки — это те, которые часто встречаются на одной странице.
Свойства страниц
На страницу можно добавить еще один интересный макрос для структурирования информации — «Свойства страниц». Внутрь него нужно подать таблицу из двух столбцов, первый будет являться ключом, а второй — значением свойства. Причем макрос можно скрыть со страницы, чтобы он не мешал читать контент, но при этом страница все равно будет отмечена нужными ключами.
Обратите внимание на ID — его удобно задавать, чтобы навешивать разные группы свойств на разные страницы (или даже разные группы свойств на одну страницу).
Отчеты
По меткам можно собирать отчеты. Например, макрос «Отчет о содержимом» собирает все страницы с определенным набором меток.
Но более интересный отчет — это макрос «Отчет по свойствам страницы». Он тоже собирает все страницы с определенным набором меток, но не просто выводит их список, а составляет таблицу (улавливаете связь с началом статьи?), в которой столбцы — это ключи свойств страницы.
Получается сводная таблица по информации из разных источников. Приятно, что у нее есть удобные функции: адаптивная верстка, сортировка по любому столбцу. Также такую отчетную таблицу можно конфигурировать внутри макроса.
При конфигурировании можно убрать из отчета какие-то столбцы, задать состояние по умолчанию или количество отображаемых записей. А еще можно задать ID свойства страницы, чтобы видеть только нужную информацию.
Например, у вас есть множество страниц сотрудников, у этих страниц есть набор свойств про человека: какого он уровня, где находится, когда пришел в команду и так далее. Это свойства отмечены ID = employee_inf. И есть второй набор свойств на этой же странице, в котором собрана информация о человеке, как о части команды: какую роль человек выполняет, в какой команде находится и так далее. Эти свойства отмечены ID = team_inf. Тогда при сборке отчета вы можете вывести только информацию по одному айдишнику или сразу по двум — как удобнее.
Прелесть такого подхода в том, что каждый может собрать нужную для себя информационную таблицу, которая не будет ничего дублировать и будет обновляться при обновлении основной страницы. Например: тимлиду не важно, когда его разработчики устроились на работу, но важно, какую роль каждый из них выполняет в команде. Тимлид соберет себе отчет по команде. А бухгалтеру вообще все равно, кто какую роль выполняет, но важны должности — он соберет себе отчет по должностям. При этом источник информации не будет дублироваться или переноситься.
Итоговый процесс
Инструкция
Итак, мы можем красиво структурировать и эффективно агрегировать информацию в Confluence на примере использования макросов. Но в идеале нужно сделать так, чтобы новая информация сразу была структурированной и попадала во все уже используемые механизмы агрегации.
Тут на помощь придет связка макросов и шаблонов. Чтобы заставить людей создавать новые страницы в нужном формате, можно использовать макрос «Создать из шаблона». Он добавляет на страницу кнопку, по нажатию на которую создается новая страница из нужного вам шаблона. Таким образом вы заставляете людей сразу работать в нужном вам формате.
В шаблон, из которого вы даете создавать страницу, нужно заранее добавить метки, макрос «Свойства страницы» и таблицу нужных вам свойств. Также рекомендую добавить инструкции о том, какими значениями следует наполнять страницу, и значения свойств.
Тогда итоговый процесс будет выглядеть так:
- Вы создаете шаблон для информации определенного типа.
- В этот шаблон добавляете метки и свойства страницы в макросе.
- В любом удобном месте создаете корневую страницу с кнопкой, по клику на которую создается дочерняя страница из шаблона.
- Пускаете на корневую страницу пользователей, которые потенциально будут генерировать нужную информацию (по нужному шаблону, нажимая на кнопку).
- Собираете себе отчет по свойствам страницы через метки, которые вы указали в шаблоне.
- Радуетесь: у вас есть вся нужная информация в удобном формате.
Подводные камни
Как инженер по качеству, я смело могу утверждать, что ничего идеального в мире нет. Даже божественные таблицу неидеальны. И в приведенном выше процессе есть подводные камни.
- Если вы решите поменять названия или состав свойств страницы, вам придется проапдейтить все уже созданные объекты, чтобы их данные корректно подтянулись в сводный отчет. Это печально, но, с другой стороны, заставляет детально продумать «архитектуру» вашего набора информации, что является весьма интересной задачей.
- Вам придется написать приличное количество инструкций о том, как заполнять информационные таблицы и пользоваться тегами. Но, с другой стороны, вы можете просто кинуть во всех нужных людей этой статьей.
Пример хранения непродуктовой документации
Через описанный выше процесс можно организовать хранение почти любой информации. Прелесть подхода в том, что он универсальный: когда пользователи к нему привыкают, они перестают генерировать бардак. Также большой (но не бесплатный) плюс — возможность собирать на лету разнообразную статистику и рисовать по ней красивые диаграммы.
Приведу пример нашего процесса ведения информации о команде.
Для каждого человека в команде мы решили создать карточку сотрудника. Соответственно, у нас есть шаблон, по которому каждый новый человек создает себе эту карточку и ведет в ней всю личную информацию.
Как видите, у нас развернутая таблица свойств и сразу есть инструкции о том, как именно вести данную страницу. Часть тегов проставляют сами сотрудники по инструкциям, в шаблоне только основные: тег карточки employee-card, тег направления direction-involve и тег команды team-qa.
В итоге после того, как каждый создал себе карточку, получается полная таблица с информацией по сотрудникам. Эту информацию можно использовать в разных точках. Ресурсные менеджеры могут собрать себе общие таблицы, а лиды команд — командные таблицы, добавляя в выборку тег команды.
По тегам можно увидеть разные сводки, например по qa-upgrade-plan отобразатся все задания на развитие QA. При этом каждый человек в своей карточке сотрудника ведет важную историю и свой план развития — создает вложенную страницу из шаблона планов развития.
Заключение
Ведите любую документацию так, чтобы за нее не было стыдно, а пользователям не было мучительно больно!
Очень надеюсь, что статья будет полезна и во всех документациях мира наступит порядок.
Добавить информационную страницу/оглавление раздела
2. Заполните все поля: введите название страницы, содержание страницы*, и Содержимое. Содержимое 1. 4 — это кнопки навигации по лекции, Вы можете создать кнопку для перехода в начало страницы, на следующую/предыдущую страницу, в конец/начало лекции или закончить лекцию. Нажмите Сохранить страницу.
*Содержание страницы Вы можете импортировать из файла формата *.docx, для этого воспользуйтесь инструкцией Импорт текста из Word в Moodle.
О нас и условия работы — добавляем страницы на сайт
Рассмотрим, как добавить и изменить эти страницы в твоем Селфри!
Расположение в админке: Содержание › Страницы › Пользовательские
Описание
Любые страницы, на которые ты хочешь добавить какую-то информацию, связанную с твоим магазином, можнос создать и настроить в разделе «Содержание». Вот краткий перечень возможных страниц:
- О нас
- Условия работы
- Доставка
- Таблица размеров
- Помощь
- Как оплатить
- Вопросы и ответы
И еще много других страниц и разделов, которые будут необходимы именно своему Селфри.
Страница со списком разделов, которые будут на твоем сайте, представляет собой дерево разделов и подразделов. Это дерево располагается в таблице с колонками:
- Название (разделов и их подразделов).
- Адрес (название разделов или подразделов, написанных латиницей. Выводится в адресной строке).
- Меню (в каком блоке меню выводится раздел).
- Язык (в какой языковой версии выводится раздел и его подразделы).
- Действия (что можно делать с разделом и его подразделами).
Каждый раздел и подраздел является страницей и различие в них только по принадлежности к иерархии дерева: одни страницы являются разделами, а другие страницы — их подразделами. Поэтому, для ясности, будем называть страницы «Разделы» и «Подразделы».
Меню на сайте
Разделы и подразделы могут находиться в трех различных меню на сайте:
В колонке
(доступно для просмотра
только при нахождении
в разделе или подразделе,
созданном в «Содержании»)
Так же раздел можно вообще не выводить в меню.
Меню в колонке можно настроить в разделе «Конфигурация»:
Выбрать страницы для отображения в различных меню можно в разделе «Навигация»:
Добавить раздел
Разделы (и подразделы) добавляются друг за другом (новый добавляется в конец дерева), поэтому желательно заранее продумать последовательность разделов (подразделов) в каждом меню. Изменить порядок следования разделов в меню можно в разделе «Навигация».
Чтобы добавить раздел, нажимаем кнопку «Добавить»:
Откроется форма добавления страницы:
Эту страница может быть :
-
или подразделом;
- добавлена или не добавлена в меню;
Основные данные
Адрес страницы и заголовок H1 будет введен автоматически:
Если хотим изменить адрес или заголовок H1, то убираем что написано и вводим с клавиатуры новый адрес:
Так как мы делаем раздел, то оставляем значение «Раздел»:
Выбираем в каком меню отображать раздел.
Кликаем мышкой на треугольник, чтобы открыть список меню:
Из появившегося списка выбираем нужное меню:
Содержание
Это то, ради чего и создается раздел: информация, необходимая покупателю.
Сюда можно добавить текст, картинки и «отформатировать» все добавленное, как в редакторе MS Word:
После заполнения основной информации о разделе и содержания, раздел можно сохранить:
После нажатия кнопки «Сохранить», новый раздел появится в дереве разделов в админке:
Раздел появится и на сайте, в том меню, которые было указано при создании:
Атрибуты поисковой оптимизации
Заполнение «Атрибутов поисковой оптимизации» необходимо для продвижения сайта. Поисковая оптимизация для этого раздела доступна в полной версии коробки. подробности смотри в админке, нажав на баннер:
Действия с разделом
После того, как раздел создан, его можно отредактировать или удалить. Чтобы выполнить действия с разделом, воспользуемся меню в колонке действия:
Редактировать
В админке
Выбираем раздел для редактирования и нажимаем на кнопку с шестеренкой:
В появившемся меню выбираем пункт «Редактировать»:
После нажатия на Редактирование, откроется такая же страница, как при добавлении раздела. Принципы редактирования такие, как описано выше в описании добавления раздела.
На сайте
Кликаем на название раздела в админке:
После клика, в новой вкладке браузера откроется выбранный раздел на сайте, где будет отображаться кнопка «Редактировать текст»:
Нажимаем кнопку «Редактировать». Откроется текстовый редактор (как при добавлении Содержания):
Вносим необходимые изменения и сохраняем их, нажав кнопку «Сохранить»:
После сохранения, все изменения сразу видны на сайте.
Удалить
Если необходимо удалить раздел, необходимо помнить:
- Раздел удаляется навсегда и со всей информацией.
- Если в разделе есть подразделы, то они автоматически станут подразделами раздела выше.
Чтобы удалить раздел, в колонке Действия нажимаем кнопку с шестеренкой напротив удаляемого раздела:
В появившемся меню кликаем на пункт «Удалить»:
После нажатия на пункт «Удалить», необходимо подтвердить удаление. Если действительно хотим удалить раздел, нажимаем «Да»:
После нажатия на кнопку «Да», раздел удалится.
Все подразделы удаленного раздела становятся подразделами раздела выше:
Подраздел «Женские размеры» после удаления раздела «Таблица размеров»
принадлежит разделу «Вопросы и ответы»
Добавить подраздел
Добавить подраздел можно двумя способами:
- Нажать на кнопку «Добавить».
- Выбрать раздел и в него добавить подраздел с помощью кнопки из колонки «Действия».
Рассмотрим оба варианта.
С помощью кнопки «Добавить»
Добавление подраздела такое же, как в случае с разделом (см. добавить раздел). Различие только в пункте «Является»:
И так, нажимаем кнопку «Добавить» и в открывшейся форме заполняем все поля, как описано в добавлении раздела:
В строке «Является» нажимаем на треугольничек рядом со словом «Разделом»:
В появившемся меню кликом мышки выбираем пункт «Подразделом»:
После выбора «Подразделом» появилось еще поле: выбор раздела, в котором будет новый подраздел:
Кликаем на треугольничек справа от названия названия раздела:
В появившемся списке, кликом мышки выбираем нужный нам раздел:
После того, как все настроено, сохраняем изменения, нажав кнопку «Сохранить»:
После сохранения, в админке мы увидим новый подраздел:
На сайте так же появится новый подраздел в указанном разделе:
С помощью Действий
Чтобы добавить подраздел с помощью меню Действия, выбираем раздел и нажимаем на кнопку с шестеренкой:
В появившемся меню, выбираем пункт «Добавить подраздел»:
После нажатия на пункт, откроется форма для добавления подраздела, где уже будет указано к какому разделу будет он относиться:
Заполняем все поля, как описано в «Добавлении раздела» и сохраняем страницу, нажав на кнопку «Сохранить»:
После сохранения, подраздел появится в админке:
Действия с подразделом
Подразделы, как и разделы можно редактировать и удалять.
Редактировать
Отредактировать подраздел можно двумя способами.
- В админке с помощью Действий
- На сайте на странице подраздела
Удалить
Чтобы удалить подраздел, в колонке «Действия» нажимаем на кнопку с шестеренкой:
В появившемся меню, выбираем кликом мышки пункт «Удалить»:
Чтобы удалить подраздел, необходимо подтверждение. Если вы уверены, что хотите удалить раздел, нажмите «Да»: