Confluence в жизни аналитика — Часть 1

Последние несколько митапов выявили, что Вики-система 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 в своём классическом смысле:

https://www.youtube.com/watch?v=yDqxZ4hWZDI

 

А как сделать ссылку на конкретное место на странице?

А очень просто. Как мы с вами уже знаем, ссылка записывается, например, вот так: “[ссылка на страницу A]”.  И так: “[ссылка на страницу A|Текст ссылки]”.

Если вы хотите сделать ссылку на секцию на вашей странице, то добавьте к заголовку секции решётку “[#Секция]” или так “[#Секция|Текст ссылки на Секцию]”.

А если вы хотите сделать ссылку на произвольное место на странице – используйте макрос {anchor} Подробнее о нём на wiki Atlassian.

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

Что ещё за макросы?

Макросы — это встроенные возможности Confluence, придуманные для облегчения жизни пользователям и для открытия доступа к бесконечным возможностям работы!  Очень часто дополнения, представленные для Confluence в Atlassian маркете, – это именно возможности использования макросов. В языке вики-разметки макрос начинается открывающей фигурной скобкой “{“ и заканчивается закрывающей “}”. Есть и такие, которые подгружают к странице целые компоненты сторонних систем, как например макрос {mockup}, позволяющий рисовать Balsamiq Mockups прямо не уходя со страницы.

Некоторые популярные макросы:

• Макросы для вставки документов: excel, word, pdf,

• Макросы для интеграции с EverNote, Google Drive, Dropbox

• Макросы форматирования {toc}, {color}, ….

• Макросы для работы с таблицами

 

Надеюсь, если вы ещё не пробовали Confluence, то теперь вам наверняка захочется его попробовать. Если же пробовали и всё равно нашли что-то новое и полезное, то я буду считать миссию этой части статьи выполненной.

В следующей части мы рассмотрим, как же применить возможности Confluence к работе аналитика:

• как аналитик вносит требования в систему, как между ними можно выстраивать связи и управлять изменениями, нужна ли аналитику матрица трассировки требований

• рассмотрим способ организации требований и существующие подходы к структуре

• и раскроем некоторые секреты про то, как Confluence помогает во  взаимодействии с командой и с заказчиком.

Пока!

[Обновлено] Продолжение статьи: Confluence в жизни аналитика — Часть 2

Автор:

Денис Ардабацкий

Старший бизнес-аналитик в Oxagile