Богатый выбор шаблонов confluence

Введение

Австралийская компания Atlassian известна своими программными продуктами для управления проектами разработки программного обеспечения. Широкую популярность завоевали инструмент управления проектами и баг-трекер JIRA, а также система совместной работы над информацией Confluence.

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

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

Таким образом, как вики-система Confluence обладает такими преимуществами как централизованный доступ к данным, возможность совместной работы над ними, а также версионность.

Рисунок 1 — Централизованный доступ к данным — главное преимущество Confluence

В данной статье не будут рассмотрены вопросы, почему нужно выбрать именно Confluence и чем данная система лучше других. Статья посвящена тому, как Confluence можно использовать для работы с требованиями и разработки технической документации проекта: формирования технического задания, программы и методики испытаний, а также создания руководств администратора, пользователя и так далее. Поэтому данный обзор скорее ориентирован на тех, кто уже выбрал Confluence или желает попробовать данный продукт в работе над технической документацией.

Сначала я вкратце расскажу о базовых принципах работы в Confluence, далее рассмотрю некоторые технические задачи, встречающиеся при создании документации и то, как их можно решить с помощью возможностей данного ПО.

Linchpin theme plugin

Если у вас в компании много сотрудников, но вы не хотите тратить много денег, то вот решение для вас. Этот плагин от //SEIBERT/MEDIA будет стоить 1000$ за 500 юзеров, и 1250$ уже за 1000 (цена для датацентра). Если же у вас до сотни человек в компании, нужно заплатить всего лишь 10$. За эти деньги вы получите расширенный редактор для настройки собственной темы Конфлюенс. Отзывов не так много, но все положительные. С помощью этого плагина можно поменять все детали интерфейса. Без каких-либо огромных усилий с технической стороны вы можете подстроить все под ваш корпоративный стиль — загрузить лого, вставить картинку на фон, подстроить размер шрифта, перекрасить все в другой цвет — да пожалуйста. Если вам что-то не нравится, поменяйте это снова! Что делать, если вы создали шедевр и хотите внедрить его куда-то еще? Просто экспортируйте его и интегрируйте куда вам нужно.

Сведения об использовании коллекции

HubSpot

Главная страница команды

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

Использование шаблона Подробнее

Создайте виртуальный офис

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

Просмотр шаблона →

ATLASSIAN

Повестки еженедельных совещаний

Эффективно проводите регулярные собрания, еженедельно отслеживая список задач и последующие действия

Использование шаблона Подробнее

Проводите эффективные удаленные совещания

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

Просмотр шаблона →

ATLASSIAN

Карта проекта

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

Использование шаблона Подробнее

Выразите общее видение

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

Просмотр шаблона →

MURAL

Мозговой штурм

Планируйте, проводите и документируйте удаленные сеансы мозгового штурма для поиска очередной отличной идеи.

Использование шаблона Подробнее

Вдохновляйте участников удаленной команды на совместную работу

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

Просмотр шаблона →

ATLASSIAN

90-дневный план

Создайте 90-дневный план по найму персонала, который поможет новичкам быстро адаптироваться и добиться успеха в компании.

Использование шаблона Подробнее

Подготовьтесь к росту

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

Наш шаблон 90-дневного плана поможет новичкам быстро адаптироваться в компании, а участникам команды — освоиться на новых позициях. Этот шаблон можно настроить по своему усмотрению: указать контрольные точки, которых сотрудник должен достичь в первые 90 дней, добавить ресурсы и так далее.

Просмотр шаблона →

Создаем структуру

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

Термины и определения — обязательный раздел, с которого начинается разработка любой проектной документации

Важно, чтобы вся проектная команда, от конечных пользователей, до разработчиков (зачастую слабо представляющих суть бизнеса) строго придерживалась общей терминологии. Справочник терминов следует поддерживать и актуализировать на всех этапах проекта.

Бизнес-требования — раздел, содержащий высокоуровневые артефакты, выявляемые, как правило, на этапе старта проекта: бизнес-цели (финансовые и нефинансовые), риски, классификация пользователей продукта (в виде ролей), сценарии использования. Ближайший аналог этой ветки — документ о концепции или видение продукта (scope and vision). Каждое бизнес-правило, риск, роль, сценарий предпочтительно оформлять в виде отдельных страниц, каждая из которых имеет атрибуты: уникальный код, наименование, статус, дата регистрации. Все взаимозависимые артефакты должны иметь связь между собой, например: бизнес-сценарии использования должны иметь ссылки на роли, проверяемые бизнес-правила и т.д.

Описание решения — элементы спецификации: модель данных, функциональные требования (в виде дерева функций или в разбивке по функциональным компонентам продукта), нефункциональные требования (качество, безопасность, интерфейсы), исключения и ограничения.

Материалы проекта — содержат все рабочие материалы: требования непосредственно к проекту (порядок взаимодействия заказчика и исполнителя, требования к рабочим местам на территории заказчика и т.д.), список участников проекта (каждого участника оформляем в виде отдельной страницы), протоколы встреч (интервью, наблюдений), переписка — исходный материал для разработки требований. В этом же разделе хранятся динамически формируемые отчеты — релизы, срез состояния требований, отчет по участникам проекта.

Структура документации почти без изменений заимствована из замечательного руководства по разработке требований к ПО: «Software Requirements» (K. Wiegers, J. Beatty). Кстати, тот же Карл Вигерс рекомендует, придерживаясь схожей структуры, заполнять её постепенно, оставляя пустые разделы на будущее. Например, заполнять раздел «Риски» по мере их выявления.

Theme builder for confluence

Если вы заядлый кодер (или целая команда), это именно то, что вам нужно. В этом приложении от Adaptivist  есть более 30 макросов, с помощью которых можно самостоятельно улучшить Конфлюенс: подогнать страницы, функционал и линии поведения. Адаптируйте пользовательский интерфейс под себя: весь контент можно расположить в блоках, а если вам пока не нужна какая-то информация, блок с ней можно скрыть, и показать, когда он снова станет актуальным. Контент можно сделать визуально еще понятнее, если расположить его в карусели — тут есть и такая функция. Одним словом, с помощью этого аддона у вас будет возможность с нуля построить свой собственный интерфейс, предусмотреть каждую мелочь, что очень удобно, если вы перфекционист до мозга костей.

Цена приемлимая — 10$ за 10 пользователей, и 450$ уже за 25.Но если почитать отзывы, то у некоторых возникали проблемы с этим приложением, есть и вопросы по нему — видимо, это не самый простой в использовании аддон, хоть и очень многообещающий.

В итоге, учитывая все вышеперечисленные критерии, есть два отличных варианта: Refined Theme и Brikit Theme Press. У Refined Theme for Confluence наверное самый удобный способ организации всей информации благодаря сайтам и категориям. Еще одно крутое приложение — Brickit Theme Press. С его помощью ваши сотрудники легко могут как редактировать, так и создавать свои собственную тему, меню, футеры и структуру сайта. Если у вас в штате много сотрудников и небольшой бюджет, то оптимальным решением станет Linchpin Theme Plugin. Он не такой популярный, как Refined Theme, и не самый крутой в плане особых функциональных характеристик, но расширенный графический редактор позволяет менять каждую мелочь, максимально оптимизируя Конфлюенс под нужды вашей рабочей среды.

У всех аддонов есть бесплатный пробный период на 1 месяц. Так что использовать базовый интерфейс — это еще не приговор, и вам точно есть из чего выбрать. Если вы сомневаетесь по поводу выбора подходящей темы для Конфлюенс, наша команда специалистов по Confluence всегда поможет вам определиться и подберет оптимальное решение, произведет его инсталляцию и настройку. Если ни одно из готовых приложений вас не устраивает, у нас есть опыт разработки собственных кастомных тем.

Как использовать шаблон «Требования к продукту»

Шаг 1. Внесите основную информацию

Подготовьте почву для работы: расскажите о продукте или функции в верхней таблице шаблона. Когда планируется релиз? Каков текущий статус? Кто в основной команде? Можно ввести команду /дата, чтобы быстро добавить целевую дату релиза, и /jira, чтобы напрямую сослаться на эпики или задачи в Jira. Также можно @упоминать участников команды, чтобы держать всех в курсе.

Шаг 2. Опишите цель и показатели успеха

Вы запускаете новый продукт или функцию не просто так (по крайней мере, хочется надеяться). В разделе Objective (Цель) шаблона вкратце объясните, как этот проект согласуется с более масштабными целями вашей организации. Зачем вообще нужна эта новая функция или продукт? Затем в таблице Success metrics (Показатели успеха) перечислите цели, связанные с продуктом или функцией, а также показатели, которые вы будете использовать для отслеживания успеха. Например, вы хотите сделать продукт удобнее для пользователей, и эту задачу можно будет считать выполненной, когда показатели удовлетворенности клиентов увеличатся как минимум на 15 %.

Шаг 3. Перечислите предположения и варианты их реализации

Поскольку продукт или функция совершенно новые, у вас мало исходной информации для работы. Тем не менее у вас наверняка есть предположения, а их можно весьма успешно использовать для определения дальнейших действий. В разделе Assumptions (Предположения) шаблона запишите все ваши предположения о пользователях, технических ограничениях и бизнес-целях. Предполагаете, что новой функцией чаще всего будут пользоваться на планшетах? Укажите это здесь. 

С учетом этих предположений внесите все рассмотренные требования к продукту в таблицу Options (Варианты). Если функцией будут пользоваться преимущественно на планшетах, необходимо адаптировать ее для мобильных устройств. Кроме описания самого требования, в таблицу можно внести пользовательскую историю (например: «Иван — менеджер проектов, который хочет проверять прогресс своей команды в дороге»)

Здесь также можно назначить уровень важности, отметить задачи из Jira и добавить любые другие нужные вам заметки

Шаг 4. Добавьте сопроводительную документацию

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

Шаг 5. Ожидайте появления открытых вопросов и расширения области проекта

Иногда запуск функции или продукта оборачивается бесконечной чередой вопросов: только вы решите один, как появляется еще пять. В эту таблицу можно вносить вопросы (например, как вы будете информировать своих пользователей об новой функции?) по мере поступления, чтобы не потерять их из виду. В эту же таблицу можно внести ответ и дату, когда он был зафиксирован. Таким образом вы сможете отслеживать свой прогресс и развитие продукта. 

Мысль о расширении области проекта обычно вызывает нервную дрожь, поэтому такую перспективу лучше заранее предотвратить. В последнем разделе шаблона перечислите, что выходит за рамки планируемой функции или релиза. Сформулируйте это максимально четко (и уточняйте формулировку по мере развития проекта), чтобы все знали, где находятся границы.

Устанавливаем связи

Еще один важнейший элемент зрелой проектной документации — связи (или ссылки) между артефактами. Функциональные требования должны иметь перекрестные ссылки (если они взаимозависимы), проверяться на соблюдение качественных требований и бизнес-правил. Также, аналитику необходимо знать, из какого рабочего материала (протокола встречи, интервью, документации) «произрастает» данное требование и иметь возможность при необходимости изучить исходный документ.
Разработчику будет полезно выявить задачи по указанному требованию и исходный код, созданный/модифицированный в рамках данных задач.

Ниже приведена модель связей, используемая в нашем шаблоне проекта.

Области Концепция, Спецификация, Материалы проекта — размещаются в Confluence. Управление задачами ранее осуществлялось в Jira (в настоящее время — в OTRS),
в качестве репозитория кода используется Bitbucket (git).

Confluence предоставляет максимум удобств по формированию ссылок (связей). При необходимости сослаться в требовании на тот или иной артефакт — достаточно просто скопировать и вставить ссылку на нужную страницу — автоматически подставится наименование.
Еще более удобный вариант, чтобы быстро сослаться — нажать открывающую квадратную скобку и начать набирать наименование страницы.

Вы спросите: «А как же быть, если я хочу определить все входящие ссылки на бизнес-правило/требование/etc»? «Как понять, где оно используется»?

На помощь приходит плагин STAGIL Incoming Links for Confluence
(
https://marketplace.atlassian.com/plugins/de.stagil.silcm.stagil-incoming-links-confluence-macro/server/overview).

После установки плагина, в нужном месте страницы вставляется одноименный макрос. Установив на связанный материал необходимые теги, можно разграничить связанные страницы по категориям, например: связанные бизнес-правила, атрибуты качества, протоколы встреч. Результат работы макроса ввыводится в виде наименований связанных страниц и ссылок на них. Есть разные стили вывода.
Плагин, увы, платный. Ранее существовал бесплатный аналог (Incoming Links), не поддерживающийся в нынешней (6.5.1) версии Confluence.

В Confluence есть возможность работы «из коробки» с task-менеджером Jira. При нажатии Ctrl-Shift-J вызывается окно для вставки соответствующих задач из Jira. И наоборот — в задаче Jira указывается, на какой странице упомянута соответствующая задача. Интеграция Confluence с другими системами управления задачами (Redmine, OTRS, openproject) также не составит большого труда благодаря наличию REST API.

Conclusion

As this guide should make clear, there are plenty of options available on the market when it comes to corporate knowledge sharing and collaboration tools.

The key question to ask, though, is precisely what do you need? For example, do you want to have task tracking or employee engagement tools integrated within the platform? Or to have a product that’s geared towards specific departments in your organization?

From our perspective, though, Confluence definitely sits at the front of the pack. It comes with a powerful feature set and flexibly serves a wide range of functions.

Its best feature, however, is arguably its deep integration with the Atlassian ecosystem and particularly with Jira. This makes it simple to connect your organizational knowledge base with what your teams are doing on the ground – providing rocket fuel for your organization!

Let us know what you think in the comments. Are there great products that we’ve left out – or have you had good (or bad) experiences with the products that we’ve described? We’d love to hear from you!

Recommended articles: 

• 16 Best Jira Alternatives for agile teams in 2020
• Jira Confluence Integration: The complete 2020 guide

1.Refined theme for confluence

У этого приложения от RefinedWiki огромное количество положительных отзывов на маркете, что определенно внушает доверие. Среди основных фич — все пространство удобно организовано с помощью категорий в выпадающем меню. А в прошлом году разработчики добавили еще и функцию сайтов — то есть вы можете добавить не только сами категории, а и структурировать их, сделав отдельный сайт, или даже несколько. Плюс, вы можете настроить цветовые решения под стиль вашей компании. Можно разбить весь контент по модулям, а чтобы нужные документы не потерялись из виду, в тему добавлены меню и иконки. Но даже если вам все равно не удалось найти какой-то файл, всегда можно вбить его название в поисковую строку. Настраивайте футер и клавиши быстрого доступа как нужно именно вам. Что касается доступа, он также настраивается под каждого пользователя, и вы сами выбираете кто может просматривать ту или иную информацию. Также в теме есть специальный портал для блога. Плюс, вы можете настроить цветовые решения под стиль вашей компании. Если вы сомневаетесь в выборе данной темы, для наглядности в маркете есть ссылка на демо сайт. Цена также довольно приятная: за 10 пользователей нужно заплатить 10$, и 500$ за 25.

Экспорт документации

Благодаря относительной распространенности Confluence (в том числе как корпоративной базы знаний) и удобным механизмам выгрузки данных, проблем с передачей проектной документации практически не возникает.
Заказчикам, использующим Confluence, мы экспортируем проектное пространство в формате XML, они загружают его на своей стороне. Всем прочим:

• В формате HTML -древовидная структура, относительно удобная навигация;
• Эспорт иерархии страниц в формате PDF.

Нажимаем … > Открыть в иерархии (если пункт не виден — проверить полномочия пользователя) > Вкладка «Экспорт» > Выбирается формат > Пользовательский экспорт (с указанием страниц), либо Обычный.
При выборе экспорта в формате PDF, результат представляет собой готовый к печати файл, с оглавлением.

Важно! Если документация ведется не на английском языке, необходимо предварительно в настройках системы (Языковая поддержка экспорта в PDF) инсталлировать поддерживающий язык шрифт (например, OpenSans). В противном случае вместо текста вы рискуете получить набор краказябр.. Отдельные страницы можно выгрузить (или наоборот — импортировать в Confluence) в формате MS Word.

Отдельные страницы можно выгрузить (или наоборот — импортировать в Confluence) в формате MS Word.

Преамбула

Некоторое время тому назад мне довелось принять участие в качестве аналитика в проекте внедрения и серьезной кастомизации одной
безумной корпоративной информационной системы. Компания-подрядчик, получившая проект,
не имела каких-то общих стандартов в части управления требованиями к продукту и каждая команда (как правило, состоящая из 8-12 человек)
самостоятельно выбирала для своего проекта соответствующий инструментарий по управлению требованиями. Большинство коллег отдавало предпочтение
старым добрым Excel + Word + SVN, кто понастырнее — использовали MediaWiki. О приобретении каких-то громоздких решений наподобие IBM Rational DOORS или
SAP Solution Manager и речи не шло.

Как аналитик, я сформировал для себя следующий перечень требований к необходимому мне инструментарию:

• Классификация и приоритизация артефактов;
• Поддержка версионности;
• Возможность выстраивания иерархий;
• Возможность связывания между собой артефактов проектной документации (бизнес-требования, роли, сценарии, правила), отслеживать связанные требования;
• Возможность связывать функциональное требование с задачами для разработчика и исходным кодом в репозитории;
• Многопользовательский режим;
• Связь требований с протоколами встреч, интервью, перепиской и контактами;
• Возможность указания меток (тегов) для материалов;
• Система должна позволять получать оперативный срез по требованиям в виде отчета,
  с указанием статуса и основных атрибутов (наименование, ID, бизнес-заказчик, дата регистрации и т.д.);
• Выгрузка отмеченных материалов в общий документ (SRS, спецификацию) в форматах Word / PDF
  (до сих пор встречаются заказчики, желающие иметь проектную документацию «на бумаге», брр)
• Опционально — прикрепление файлов (с возможностью предпросмотра);
• Опционально — возможность рисовать диаграммы;
• Стоимость системы должна быть адекватной и подходить для небольшой команды (8 человек).

Через неделю поисков, чтения обзоров, изучения опыта коллег из других компаний и сравнения возможностей я принял решение остановиться на Atlassian Confluence.

Enterprise theme for confluence

Лаконичный дизайн этой темы от Bitvoodoo ag точно понравится всем владельцам серьезных компаний. Можно выбрать любой из встроенных графических шаблонов и оставить все настройки по умолчанию, а можно и адаптировать их под ваш стиль. Настраивайте свою панель управления, добавляя или убирая различные функции. Можно персонализировать лендинг и настроить показ новостей — для этого предусмотрен специально разработанный ряд макросов. Встроенные макросы, каких нет в базовой версии Конфлюенс, хорошо подходят для настройки корпоративного интранета либо базы знаний. Есть функция горизонтальной навигации в футере и хедере, где можно также прикрепить ссылки на пространства, страницы и внешние URL. Приложение доступно на многих языках. Есть и мобильная оптимизированная версия, которая выглядит так же, как и основная — в телефоне вы получаете доступ к контенту через специальное меню.

За ваш Конфлюенс и поддержание его жизни отвечает специальный Спейс менеджер, которого можно назначить в два клика. Разработчики также предусмотрели очень подробную документацию, которая поможет пользователям разобраться во всех нюансах. И даже если после этого у вас останутся вопросы, вы всегда можете обратиться в службу поддержки.

Цена стартует от 10$ за 10 пользователей, 25 пользователей обойдутся уже в 400$.

Brikit theme press

Это расширение предыдущей версии приложения Zen Foundation от Brikit. Если у вас небольшая компания, то эта тема вам вполне подойдет, ведь ее можно приобрести начиная от 10$ за 10 человек, а вот 25 пользователей уже обойдутся в 700$ (дороже, чем у Refined Theme). Разработчики сделали упор на простоту — для настройки Конфлюенс не нужно ничего кодить самостоятельно, за вас уже придумали готовые шаблоны. Остается только собрать свой собственный интерфейс из нужных блоков. Это не столько сама тема для конфлюенс, сколько конструктор сайтов. Здесь также предусмотрены широкие возможности в дизайне. Удобная навигация позволит объединить всех сотрудников и их документы, а затем выбрать, кому дать доступ к файлам. Огромное преимущество — мобильная версия, чтобы пользователи имели доступ с других устройств и были на связи в любое время.