Как сделать презентацию в confluence
Добавил пользователь Владимир З. Обновлено: 04.10.2024
Пространство Confluence - это контейнер, который содержит страницы и страницы блога. Вы также можете думать о пространстве как о двух типах каталогов, которые можно использовать в своей работе.
В Confluence есть два типа пространств:
- Пространства сайта-Эти пробелы могут бытьКосмический справочникНайти в. Здесь вы можете создавать документы для обмена контентом и совместной работы с другими пользователями. Иногда называют глобальным пространством.
- Личные пространства—— Каждый пользователь Confluence может создать собственное личное пространство. Вы можете сохранить эти пространства как личные или открыть их для просмотра и редактирования другими пользователями. Личное пространство будет вКаталог людейВключено в список нейтрально.
Вы можете использовать в верхней части ConfluenceSpaces > Create space (Космос> Создать пространство) ПриходитеCreate a Space. В этом пространстве можно хранить соответствующую классификационную информацию. Люди используют пространство Confluence по следующим двум основным причинам: чтобы создать пространство для команды проекта или чтобы создать пространство для проекта.
Можно создать пространство для отделов, которым необходимо координировать работу, таких как маркетинговая команда, команда разработчиков, ИТ-команда и команда кадров. Если у вас много проектов, независимо от того, является ли ваш проект большим или небольшим, создание пространства для проекта принесет ему много преимуществ.Каждый может работать вместе в пространстве проекта и хранить связанные файлы.
В Confluence вы можете создавать неограниченное пространство.
Как мне использовать пространство?
СоздайтеКак можно больше места для лучшего выполнения необходимых вам задач:
- Командные помещения—— Предоставьте каждой группе (QA, HR, Engineering, Support, . ) свое собственное пространство, чтобы они могли легче находить нужную информацию или облегчить другим поиск нужной информации.
- Пространства проекта-Сместите всю информацию, связанную с вашим проектом, в одном месте. Это позволяет каждому члену команды проекта обмениваться информацией, не отправляя электронные письма.
- Личное пространство—— Сохраните всю свою работу в личном пространстве, сохраните собственный список задач и в то же время измените перемещенное содержимое перед перемещением содержимого в любое другое общее пространство.
Узнай пространство в любое время
Космический менеджер
Если у вас есть права администратора пространства, вы можете:
Разрешения на пространство
Некоторая информация, которую необходимо четко понимать об администраторах пространства:
- Пользователь, создавший пространство, автоматически получит полномочия администратора пространства.
- Права администратора пространства могут предоставлять права администратора другим пользователям.
- Администраторы пространства не обязательно должны быть администраторами Confluence. Администраторы пространства и системные администраторы могут иметь разные варианты разрешений. Например, независимо от того, какие разрешения у вас есть в пространстве, вы являетесь администратором своего личного пространства.
Хотите узнать больше об использовании космоса? См. Следующие рекомендации:
Последние несколько митапов выявили, что Вики-система Confluence является одним из весьма популярных инструментов среди некоторых белорусских аналитиков и что способы его использования всё ещё недостаточно широко известны и вызывают массу любопытства у многих наших коллег.
Как известно, если есть интерес, то поступает и предложение :)
В этой статье я не буду писать о том, какой инструмент подходит лучше для работы с требованиями или, например, почему надо выбрать для этого именно Confluence. Мы не будем раскрывать тему стандартных преимуществ wiki-систем вроде централизованного доступа к актуальным материалам, версионности и возможностей совместной работы.
Статья ориентирована на тех читателей, кто уже сделал свой выбор (или выбор уже сделан за них), а также на тех, кто желает попробовать использовать Confluence в работе.
В первой части мы познакомимся с системой, попробуем разрушить некоторые стереотипы и показать, что этот зверь не только не страшный, но и очень даже полезный – почти такой же полезный, как ваш кот.
Вторая часть статьи будет ориентирована больше для работы, чем для знакомства. В ней рассмотрим некоторые лайфхаки, которые существенно упрощают жизнь BA, SA, PM, QA, …(добавьте свой вариант). Постараюсь не забыть о возможностях Confluence, без которых мне было бы уже трудно представить приятную работу.
Не обойдётся и без порции Рождественской Магии в канун праздников…
Модульность Confluence и Atlassian Market
“Базовая комплектация” Confluence вполне себе позволяет выполнять простые операции по управлению требованиями с достаточной степенью комфорта. Тем не менее, много-много радостей от работы доставят платные и бесплатные дополнения. У Atlassian есть собственный маркет, в котором можно выбрать add-on на ваш вкус, в соответствии с потребностями вашего процесса или особенностями проекта. Среди дополнений, которые можно скачать и установить, встречаются как наработки Atlassian, так и предложения сторонних разработчиков, которые, по всей видимости, изначально разработали дополнения для себя, а затем представили его широкой аудитории.
Обзор каждого из дополнений для Confluence – это тема для отдельной статьи, но я всё же не удержусь от упоминания самых-самых, которые использую сам.
Любителям MS Word!
Первый из указанных выше митапов выявил одно из популярных заблуждений о том, что Confluence не настолько удобен для редактирования текстов и, в частности, для оформления требований, как старый добрый и махровый MS Word.
Если ваша задача в том, чтобы оформить документ для печати с использованием специально заданных шрифтов, требований к отступам и полям – то действительно, навряд ли вам стоит рассматривать какую-либо вики в принципе. Однако, если же от вас ожидают не более чем аккуратно оформленные и читабельные требования, которые, возможно, потом захочется сохранить файлом для отправки, печати, прочтения и подписи – смело работайте в Confluence, сохранив все традиционные преимущества wiki.
Итак, давайте рассмотрим случай, когда вам прислали MS Word документ с начальными требованиями и администратор создал пустой (или не совсем пустой) спэйс (Space или пространство имён) для вашего проекта.
Кстати, изобретатели вики придумали пространство имён для того, чтобы позволить создавать статьи с одинаковым именем в нескольких разных областях знаний. Например, википедия объясняет этот термин следующим образом.
Во избежание путаницы, именам в одном пространстве имён не дают более одного значения. Например, в пространстве имён улиц любого города названия улиц, как правило, не повторяются.
У вас есть документ. Есть вики. Вы смотрите на документ. Смотрите на вики. Смотрите снова на документ. Смотрите снова на вики. Думаете. Ещё думаете. Вики смотрит на вас… Что с ними делать?
Иногда начинающие пользователи просто берут и прикрепляют документ как приложение к страничке вики. Если при этом было установлено и включено бесплатное дополнение Office Connector, которое включено в базовую комплектацию, то довольный пользователь радостно обнаруживает текст загруженного документа встроенным прямо в страничку, с кнопкой для редактирования.
Это уже прикольно и весело, но для управления требованиями не годится. Также как не годится, например, устроить пикник прямо в комнате, не выходя на улицу. Пикник вроде бы и есть, но понарошку, не настоящий.
Надо отметить, что если ваша задача в том, чтобы показать/прикрепить/опубликовать в сети презентацию, то описанное решение не так уж плохо и может быть вполне уместно: пользователю не нужно будет ничего скачивать, контент прикреплённого документа будет виден сразу на странице.
Такой подход НЕ предполагает удобное редактирование.
Однако, если мы хотим в дальнейшем как-то работать с текстом из любого стороннего документа, то лучше всего его перенести непосредственно в вики. Для того, чтобы это сделать, можно предложить как минимум два способа.
а) Импорт документа. Про него ниже.
б) Способ “от кэпа” – копирование контента из документа. На самом деле, может быть вполне оправдано, когда вы хотите правильно сформулировать и оформить требования, “пропустив исходный текст через себя”.
При должном форматировании документа Confluence позволит даже создать отдельную страничку для каждой секции, найденной в word файле, до уровня заголовков, нужного вам. Таким образом, структура импортированных в вики страниц будет совпадать со структурой оригинального документа.
Форматирование – переформатирование..
Текст перенесён. Теперь перед нами встала задача его редактирования. Могу ошибиться, но предположу, что первое, что отличает текстовый редактор MS Word от текстового редактора Блокнот, – это, пожалуй, возможность “богатого” форматирования текста, призванного сделать текст более читабельным: Жирность, Курсив, Подчёркнутость, Заголовки, Списки…
Все эти базовые приёмы форматирования текста также хорошо и на лету работают в Confluence, как в редакторе от Майкрософт.
С одной стороны, как обычно, присутствует панель WYSIWYG редактора с привычными опциями форматирования и для любителей горячих клавиш и быстрого набора красивых текстов сочетания Ctrl+B, Ctrl+U, Ctrl+I и автонумерацию никто не отменял.
С другой стороны – доступна вся мощь работы с wiki markup language…
Ссылки – гиперссылки и что такое wiki markup language
Так вот, в отличие от работы в MS Word, вы можете добавлять ссылки на существующую страницу даже без обращения к опции меню “добавить ссылку”. Не обязательно ходить в разные там меню: когда вы работаете в вики, ссылки можно вставлять прямо по ходу написания текста, открыв квадратную скобку “[…” и начав писать имя страницы, на которую вы хотите сделать ссылку. Confluence подскажет вам выпадающим списком, какие страницы уже созданы, и вы можете выбрать существующую страницу, на которую должна указывать ссылка.
А ещё вы можете написать заголовок несуществующей страницы и закрыть скобку “]”. Такая ссылка будет подсвечена по-особенному: нажав на неё, Confluence предложит создать новую страницу с заголовком, соответствующим введённому тексту. Заголовок страницы вы, впрочем, можете изменить, изменив заодно и URL, но все встречающиеся в вики ссылки на вашу страницу при этом сохранятся, что может быть неожиданным, но приятным сюрпризом!
Квадратная скобка – это наследие wiki markup языка, который был основным в ранних версиях продукта. Сейчас он уже не используется в явном виде, как в былые времена, однако некоторые его элементы всё ещё работают и поддерживаются, существенно упрощая редактирование текста и создание требований.
Ветераны помнят время, когда можно было переключиться в режим wiki markup и насладиться работой в plain text редакторе с использованием олдскульной разметки во всей красе, как показано на фотографии.
Сегодня аналогичный контент в режиме редактирования выглядит примерно так, как и финальный вариант отображения страницы. Atlassian подарили пользователям такую долгожданную реалистичность в 4-й версии Confluence, полностью переработав редактор и лишив тем самым фанатов удовольствия ковыряния в вики разметке.
Так выглядит результат редактирования.
Возможности быстрого форматирования удачнее всего, на мой взгляд, иллюстрирует видео от производителя, выпущенное в преддверии той версии, когда был отменён wiki markup в своём классическом смысле:
А как сделать ссылку на конкретное место на странице?
А очень просто. Как мы с вами уже знаем, ссылка записывается, например, вот так: “[ссылка на страницу A]”. И так: “[ссылка на страницу A|Текст ссылки]”.
А если вы хотите сделать ссылку на произвольное место на странице – используйте макрос Подробнее о нём на wiki Atlassian.
Кроме этого, если вы хотите вставить ссылку, которая, например, обязательно должна открыться в новом окне, то на такой случай предусмотрено бесплатное скачиваемое дополнение Linking.
Что ещё за макросы?
Макросы — это встроенные возможности Confluence, придуманные для облегчения жизни пользователям и для открытия доступа к бесконечным возможностям работы! Очень часто дополнения, представленные для Confluence в Atlassian маркете, – это именно возможности использования макросов. В языке вики-разметки макрос начинается открывающей фигурной скобкой “”. Есть и такие, которые подгружают к странице целые компоненты сторонних систем, как например макрос , позволяющий рисовать Balsamiq Mockups прямо не уходя со страницы.
Некоторые популярные макросы:
Макросы для вставки документов: excel, word, pdf,
Макросы для интеграции с EverNote, Google Drive, Dropbox
Макросы для работы с таблицами
Надеюсь, если вы ещё не пробовали Confluence, то теперь вам наверняка захочется его попробовать. Если же пробовали и всё равно нашли что-то новое и полезное, то я буду считать миссию этой части статьи выполненной.
В следующей части мы рассмотрим, как же применить возможности Confluence к работе аналитика:
как аналитик вносит требования в систему, как между ними можно выстраивать связи и управлять изменениями, нужна ли аналитику матрица трассировки требований
рассмотрим способ организации требований и существующие подходы к структуре
и раскроем некоторые секреты про то, как Confluence помогает во взаимодействии с командой и с заказчиком.
Коммуникативный педагогический тренинг: способы взаимодействия с разными категориями учащихся
Сертификат и скидка на обучение каждому участнику
Описание презентации по отдельным слайдам:
Использование продуктов JIRA и Confluence в компании Artezio
Автоматизированные процессы в компании Artezio
Одна из хороших практик компании Artezio – это непрерывный анализ деятельности предприятия и поиск путей оптимизации ее деятельности путем внедрения автоматизации бизнес процессов
Работа службы технической поддержки
Работа кадровой службы
Процессы работы с потенциальными клиентами
Процессы учета рабочего времени и выставления счетов
Процессы создания и поддержки проектных окружений
Система менеджмента качества
Единая система предоставления прав доступа к информационным ресурсам компании
История выбора инструментов
MS SharePoint 2003
MS Project 2003
CRM
Business contact manager
Bugzilla
Отсутствие мульти платформенности
Большой штат обслуживающего персонала
Необходимость в наличии большого количеств физических серверов
Неудобные интерфейсы для конечных пользователей
Низкая устойчивость
Ограниченные средства улучшения, доработки и расширения систем
Почему Jira+Confluence?
Простой и понятный пользовательский интерфейс
Большие возможности для конфигурации системы под нужны компании
Свободный доступ к изменению компонентов системы
Большое количество уже реализованных плагинов
Возможность интеграции с другими системами
Большие возможности для визуализации данных
Мултиплатформенность
Удобство эксплуатации
Мульти платформенность
Поддерживаемые платформы
Java версии: JRE / JDK 1.5 и 1.6
Операционные системы: Microsoft Windows, Linux / Solaris, Apple Mac OS X
Сервера приложений: Jboss, Apache Tomcat, Oracle, WebLogic, IBM WebSphere
Базы данных: MySQL, PostgreSQL , Microsoft SQL Server,
Oracle , HSQLDB
Браузеры: Microsoft Internet Explorer, Mozilla Firefox, Safari
Простой и понятный
пользовательский интерфейс
Доступ к элементам управления и возможность их конфигурации
Возможности для поиска данных
Навигация
Работа со списками
История изменений
Визуализация информации
Экспорт данных в различных форматах
Интеграция с MS Office
Возможности для конфигурации
системы
Конфигурация прав доступа, ролей и пользователей
Конфигурация типа элемента системы
Конфигурация содержимого элемента системы
Конфигурация порядка действий над элементом системы
Конфигурация рабочего пространства проектов и пользователей
Конфигурация пользовательского интерфейса
Конфигурация рассылок
Конфигурация прав доступа, ролей
и пользователей
Система Jira предлагает многоуровневый подход к разграничению прав пользователей:
Права на доступ к проекту
Права на доступ к операции над объектом системы
Права на доступ к конкретному объекту
Конфигурация типа элемента
системы
Система Jira позволяет оперировать различными бизнес объектами, наборы которых полностью конфигурируются
Примеры: Счета, замечания, потенциальные клиенты, проекты….
Конфигурация содержимого
элемента системы
Любой набор полей элементов
Определение типа и содержимого элемента
Всплывающие подсказки и придективный ввод
Списки поиска значений
Вложения
Любой способ размещения полей
Возможность реализации ввода на нескольких страницах
Возможность добавления сопутствующих действий прямо в форму редактирования и создания элементов (отслеживание дубликатов, обращение с другим элементам)
Возможность использования ограничения на поля ввода
Конфигурация порядка действий
над элементом системы
Система Jira предлагает возможности для полной конфигурации наборов действий и состояний объектов системы. Причем в зависимости от типа объекта и проекта данные наборы могут конфигурироваться отдельно
Примеры: жизненный цикл проекта, действия над счетом, карьерное продвижение сотрудника
Конфигурация рабочего пространства
проектов и пользователей
Элементы
История
Описание
Доступ к фильтрам
Доступ к графикам
Плагины
Поиски
Отчеты и диаграммы
Для аналитических целей JIRA создает карту проекта.
Также имеется целый ряд необходимых стандартных отчетов.
* нерешенные высокоприоритетные задачи
* количество задач созданных одним пользователем
* среднее время решения задачи
* отношение реального и задданного времени решения задач
* количество задач созданных в день, неделю, месяц, год
* популярные задачи (набравшие большинство голосов)
* задачи назнвченные для указанной версии или этапа
* задачи имеющие определенные статус
* задачи имеющие определенный приоритет
* отчет по использованию времени
* отчет о затратах времени на выпуск опредленной версии
* отчет о нагрузке на разработчиков
Кроме стандартных отчетов, JIRA позволяет написать свои отчеты.
Свободный доступ к изменению
компонентов системы
Система Jira предоставляет доступ к кодам и детальные инструкции по возможностям изменения системы
Отчеты
Поиск
Пользовательские формы
Возможности конфигурирования
Решение для кадровой службы
Решение для маркетинговой службы
Решения для инфраструктуры проектов
Решение для службы технической поддержки
База знаний компании
Единое информационное пространство компании
Интеграция с Wiki, AD
Доступность и производительность наших решений
Решение для кадровой службы
Учет кандидатов
Анализ результатов собеседований
Электронная версия резюме
Учет отпусков и больничных
Основная черта – простой и понятный интерфейс
Решение для маркетинговой службы
Учет потенциальных клиентов
Анализ результатов тендеров
Учет договоров и счетов
Основная черта – специфичная настройка прав доступа к конфиденциальной информации
Решения для инфраструктуры
проектов
Создание инфраструктуры проектов
Изменение в составе проекта, кадрах и инфо ресурсах
Унифицированный подход к работе на всех проектах
Аудит проектов
Основная черта – согласование порядка действий с жизненным циклом проекта
Решение для службы технической поддержки
Возможность полной локализации проблемы
Простота и понятность работы по созданию запросов
Возможность отслеживать статус решения проблемы
Характерная черта – возможность заведения проблем при помощи e-mail
База знаний компании
Удобная навигация
Унификация сбора “хороших практик”
Удобный поиск
Наглядное представление информации
Характерная черта – графическое согласование содержимого базы знаний с RUP диаграммой
Единое информационное пространство компании
Характерная черта – маршрутизация доступа для различных групп пользователей
Структура наших решений
5 лет бесперебойной работы
База данных более 1Gb (2.5 миллиона записей)
2x Xeon E5405, 8GB ОЗУ, RAID 5
Более 300 активных пользователей
Seldemirov Aleksandr / 22.11.2021
В этой серии рассказываем о Confluence — инструменте не только для совместной работы с документами, но и для создания единой базы знаний компании. Этот продукт, так же как Trello и Jira, принадлежит компании Atlassian, имеет прекрасную интеграцию с этими системами, но может использоваться и самостоятельно.
Что позволило этому инструменту стать одним из наиболее популярных решений в своем сегменте?
Какую проблему решает Confluence?
Рассказывает сооснователь компании ITQuick, Дмитрий Шишкин:
В Confluence есть два базовых сценария и более 75 (!) настраиваемых шаблонов.
- Совместная работа с документами, причем в любых подразделениях компании: маркетинг, продажи, финансы, ИТ и т. д.
- Создание и сохранение знаний в компании. Confluence позволяет не просто совместно работать над документами, а централизованно хранить информацию, владеть единой картиной (а не терять ее в цепочках электронных писем, различных версий документов, презентаций, таблиц, которые находятся где-то на серверах, где-то на компьютерах пользователей).
Таким образом, Confluence относится к двум классам IT систем: системы совместной работы и системы управления знаниями.
Помимо базовых сценариев Confluence имеет широкий спектр дополнительных возможностей:
- Контроль версий документов: Confluence по умолчанию сохраняет версии в процессе работы. Причем позволяет настраивать уведомления об изменениях для других пользователей. Здесь также легко восстанавливать любые версии и сравнивать их между собой. (Это часто бывает необходимо для ведения внутренних регламентов и инструкций. Или, например, в ИТ — хранение версий документов, связанных конкретными релизами систем.)
- Инструмент для решения операционных вопросов — ведения протоколов встреч, решений и задач. В частности, Confluence позволяет создавать задачи напрямую в Jira, где можно уже отслеживать их исполнение.
- На базе Confluence можно создавать справочную информацию для клиентов или пользовательскую документацию по программным продуктам компании.
- В Confluence есть возможность тонкой настройки прав доступа. Мы часто пользуемся этим в своих проектах. Часть страниц видим только мы, а часть страниц может быть доступна нашему заказчику. На этих страницах мы размещаем план проекта, а также отчеты из Jira с актуальными статусами по задачам. Данные в этих отчетах автоматически формируются в Jira. Также это работает и в другую сторону. Например: из протокола встречи с заказчиком, созданного в Confluence, можно создавать задачи сразу в Jira.
Таким образом, есть множество сценариев использования Confluence для сопровождения всего цикла разработки и поддержки ИТ-продуктов: от написания требований, планирования и выпуска релизов до получения обратной связи от пользователей, ведения ретроспектив и демо и создания проектной отчетности онлайн.
Дмитрий Вирин, специалист по Jira и Confluence
Confluence на сегодняшний день — это одна из самых популярных систем управления знаниями за счет удобного веб-интерфейса, высокой безопасности и доступной цены.
Если вы приобретаете Confluence, то его можно использовать как самостоятельный инструмент.
Но если вы точно знаете, что Jira вам необходима, то очень советуем приобрести ее вместе с Confluence. Эти две системы — от одного разработчика, они интегрированы по умолчанию и хорошо дополняют друг друга: задачи вы ведете в Jira, а в Confluence содержится описание всех процессов, схемы и графики.
После настройки проекта в Jira можно разместить инструкции в Confluence и поделиться ссылками со всеми участниками проекта, там же можно разместить все регламенты процессов, договоренности между исполнителями и заказчиками, все документы, относящиеся к проекту.
Серверная и облачная версии — в чем разница?
Облачная версия имеет более скромный функционал, но она не требует покупки серверов, с ней проще начать работать. Для начала работы достаточно зарегистрироваться на сайте Atlassian и нажать пару кнопок в мастере для создания пространства.
Серверная версия устанавливается на стороне заказчика и имеет более высокую защищенность, скорость и расширенный набор функций.
В России компании предпочитают серверные решения облачным. В первую очередь это связано с политикой безопасности и с требованиями российского законодательства по обработке персональных данных. Также при использовании серверной версии значительно упрощается задача интеграции с внутренними системами компании.
Для достижения наивысшей эффективности работы команд выбирайте наиболее качественные и удобные инструменты. Мы остановили свой выбор на Jira и Confluence и до сих пор считаем этот выбор верным.
Меня зовут Маша, я работаю инженером по обеспечению качества в группе компаний Тинькофф. Работа QA предполагает множество коммуникаций с разными людьми из разных команд, а я к тому же была менеджером и лектором образовательных программ, поэтому моя карта коммуникаций была максимально широкой. И в какой-то момент я взорвалась: я поняла, что больше не могу, не могу, не могу заполнять адовые тонны нечитаемых таблиц и документов.
Наверняка каждый из вас представил себе сейчас то, о чем я говорю, и облился холодным потом: списки фамилий без алфавитного порядка, таблицы в сотни столбцов со съехавшей версткой, таблицы в тысячи строк, в которых нужно стирать свой палец об колесико мыши, чтобы посмотреть заголовок, тонны страниц непронумерованных инструкций, сотни пересылаемых друг другу писем с данными, которые надо проанализировать и систематизировать и запихнуть в такие же нечитаемые таблицы.
И вот, когда я немного остыла, я решила написать эту статью. Я расскажу о том, как можно нормально (даже порой удобно) вести разнообразную непродуктовую документацию. Надеюсь, что статья разлетится по сети и уровень адища в соседних с разработкой отделах хоть чуть-чуть снизится, а люди (и я в том числе) станут чуточку счастливее.
Инструменты
Продуктовая документация часто хранится рядом с кодом, и это хорошо. А непродуктовая документация обычно хранится где попало. Часто люди стараются переносить информацию из разных мест в Confluence, и мы не исключение. Так что весь дальнейший рассказ о нем.
Вообще Confluence — это продвинутый вики-движок. Он позволяет работать с данными в разных видах отображения: текст с форматированием, таблицы, разнообразные диаграммы. Это очень интересный и мощный инструмент, но если не уметь его готовить, то вы получите очередную свалку нечитаемых документов. Я научу вас готовить!
Макросы
Почти вся магия Confluence строится на макросах. Макросов очень много, и их можно комбинировать друг с другом. Они бывают платными и бесплатными, далее будут разные примеры макросов со ссылками на документацию для них.
Интерфейс работы с макросами максимально прост. Чтобы добавить макрос, надо нажать на плюс и выбрать нужный элемент из списка.
Если макрос самодостаточный, то есть не требует вставки чего-то еще внутри себя, — он выглядит как блок.
Если для работы макроса нужно что-то поместить внутрь него, он выглядит как рамка.
При этом можно помещать внутрь одной рамки сколько угодно других, лишь бы в вашей пирамиде была логика.
У каждого макроса есть предварительный просмотр: в нем сразу видно, правильно ли вы заполнили и настроили макрос.
Шаблоны
Тогда в созданную страницу добавится весь контент, который есть в шаблоне.
Создавать страницы из шаблонов может кто угодно, а вот создавать или редактировать сами шаблоны — только те, у кого есть на это права. В шаблон можно добавить дополнительные инструкции о том, как следует вести страницу.
Магия таблиц
Вообще-то я, как технарь, нежно люблю таблицы и могу почти любую информацию в них завернуть (хотя это и не всегда эффективно). Сами по себе таблицы четкие, структурированные, масштабируемые, волшебные!
Но даже такую замечательную сущность, как таблица, можно испортить. А можно удачно использовать и даже улучшить. Об этом ниже.
Фильтрация (платный плагин)
Внутрь этого макроса надо засунуть таблицу (можно даже самую уродливую, главное — запихнуть ее целиком). В макросе можно выбрать столбцы для фильтра с выпадающим списком, текстового фильтра, числового и фильтра по датам.
Вот представьте, что всю информацию по кандидатам на все вакансии записывают табличным списком. Естественно, неотсортированным — люди же приходят на собеседования не по алфавиту. А вам надо понять, проводили ли вы собеседование с конкретным соискателем раньше. Надо просто засунуть этот ад в макрос фильтра, добавить текстовый фильтр по фамилии — и вуаля, информация у вас на экране.
Стоит отметить, что фильтрация огромных таблиц может влиять на работу системы и время загрузки страниц, поэтому засунуть огромную таблицу в фильтр — временный костыль, лучше выстроить процесс, в котором людям не приходится создавать огромные нечитаемые таблицы (пример процесса будет в конце статьи).
Сортировка (платный плагин)
Например, у вас есть та же самая таблица с соискателями и надо прикинуть, сколько собеседований было проведено в определенный месяц, — сортируйте по дате и радуйтесь.
Сводные таблицы (платный плагин)
Естественно, группировать можно по нескольким признакам сразу, все возможности можно посмотреть в документации.
Диаграммы (платный плагин)
Естественно, в этом макросе тоже есть настройки. Ссылку на документацию к любому макросу можно найти в режиме редактирования этого макроса.
Простота агрегации
Информация из предыдущих пунктов наверняка не была для вас откровением. Но теперь вы точно умеете пользоваться макросами, а я могу перейти к более интересной части статьи.
Метки
Плохо, когда люди хранят информацию в одной неструктурированной статье или огромной таблице. Еще хуже — когда части этой информации не только нечитаемо оформлены, но и раскиданы по просторам Confluence. Благо есть возможность собрать раскиданную информацию в одном месте. Для этого надо воспользоваться метками (знакомыми всем по соцсетям тегами).
На любую страницу можно добавить любое количество меток. Если нажать на метку, вы попадете на страницу агрегации, где есть ссылки на все материалы с этой меткой, а также с набором связанных меток. Связанные метки — это те, которые часто встречаются на одной странице.
Свойства страниц
Обратите внимание на ID — его удобно задавать, чтобы навешивать разные группы свойств на разные страницы (или даже разные группы свойств на одну страницу).
Отчеты
Получается сводная таблица по информации из разных источников. Приятно, что у нее есть удобные функции: адаптивная верстка, сортировка по любому столбцу. Также такую отчетную таблицу можно конфигурировать внутри макроса.
При конфигурировании можно убрать из отчета какие-то столбцы, задать состояние по умолчанию или количество отображаемых записей. А еще можно задать ID свойства страницы, чтобы видеть только нужную информацию.
Например, у вас есть множество страниц сотрудников, у этих страниц есть набор свойств про человека: какого он уровня, где находится, когда пришел в команду и так далее. Это свойства отмечены ID = employee_inf. И есть второй набор свойств на этой же странице, в котором собрана информация о человеке, как о части команды: какую роль человек выполняет, в какой команде находится и так далее. Эти свойства отмечены ID = team_inf. Тогда при сборке отчета вы можете вывести только информацию по одному айдишнику или сразу по двум — как удобнее.
Прелесть такого подхода в том, что каждый может собрать нужную для себя информационную таблицу, которая не будет ничего дублировать и будет обновляться при обновлении основной страницы. Например: тимлиду не важно, когда его разработчики устроились на работу, но важно, какую роль каждый из них выполняет в команде. Тимлид соберет себе отчет по команде. А бухгалтеру вообще все равно, кто какую роль выполняет, но важны должности — он соберет себе отчет по должностям. При этом источник информации не будет дублироваться или переноситься.
Итоговый процесс
Инструкция
Итак, мы можем красиво структурировать и эффективно агрегировать информацию в Confluence на примере использования макросов. Но в идеале нужно сделать так, чтобы новая информация сразу была структурированной и попадала во все уже используемые механизмы агрегации.
Тогда итоговый процесс будет выглядеть так:
- Вы создаете шаблон для информации определенного типа.
- В этот шаблон добавляете метки и свойства страницы в макросе.
- В любом удобном месте создаете корневую страницу с кнопкой, по клику на которую создается дочерняя страница из шаблона.
- Пускаете на корневую страницу пользователей, которые потенциально будут генерировать нужную информацию (по нужному шаблону, нажимая на кнопку).
- Собираете себе отчет по свойствам страницы через метки, которые вы указали в шаблоне.
- Радуетесь: у вас есть вся нужная информация в удобном формате.
Подводные камни
Как инженер по качеству, я смело могу утверждать, что ничего идеального в мире нет. Даже божественные таблицу неидеальны. И в приведенном выше процессе есть подводные камни.
Пример хранения непродуктовой документации
Через описанный выше процесс можно организовать хранение почти любой информации. Прелесть подхода в том, что он универсальный: когда пользователи к нему привыкают, они перестают генерировать бардак. Также большой (но не бесплатный) плюс — возможность собирать на лету разнообразную статистику и рисовать по ней красивые диаграммы.
Приведу пример нашего процесса ведения информации о команде.
Для каждого человека в команде мы решили создать карточку сотрудника. Соответственно, у нас есть шаблон, по которому каждый новый человек создает себе эту карточку и ведет в ней всю личную информацию.
Как видите, у нас развернутая таблица свойств и сразу есть инструкции о том, как именно вести данную страницу. Часть тегов проставляют сами сотрудники по инструкциям, в шаблоне только основные: тег карточки employee-card, тег направления direction-involve и тег команды team-qa.
В итоге после того, как каждый создал себе карточку, получается полная таблица с информацией по сотрудникам. Эту информацию можно использовать в разных точках. Ресурсные менеджеры могут собрать себе общие таблицы, а лиды команд — командные таблицы, добавляя в выборку тег команды.
По тегам можно увидеть разные сводки, например по qa-upgrade-plan отобразатся все задания на развитие QA. При этом каждый человек в своей карточке сотрудника ведет важную историю и свой план развития — создает вложенную страницу из шаблона планов развития.
Заключение
Ведите любую документацию так, чтобы за нее не было стыдно, а пользователям не было мучительно больно!
Очень надеюсь, что статья будет полезна и во всех документациях мира наступит порядок.
Читайте также: