Для чего нужны макросы в confluence

Как использовать макросы в статьях

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

Список макросов находится в меню форматирования:

Вложения

Вложения — вывод в тексте статьи файлов, прикрепленных к ней:

Пример использования макроса Вложения:

Мультимедиа

Мультимедиа — вывод видео-плеера в текст статьи (видео необходимо прикрепить к статье):

Пример использования макроса мультимедия:

Раскрыть

Раскрыть — для добавления блока скрытого контента:

Панель

Панель — для добавления блока с выделенным текстом, например для описания документа.

Оглавление

Таблица навигации — для вывода содержания документа. Содержание формируется автоматически по заголовкам. В настройках макроса можно установить, какие заголовки будут принимать участие в формировании.

Пример макроса Таблица контента смотрите в начале этой статьи.

Вывод документов Office

Вывод содержимого вложенных файлов в формате Word, Pdf, Excel:

Макрос Table Filter

Используйте этот макрос, чтобы добавить фильтр в таблицу с данными.

Источник

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 в своём классическом смысле:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Автор:

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

Источник

What are macros?

Macros are powerful tools that help you to extend the capabilities of your Confluence pages, allowing you to add extra functionality or include dynamic content. You know you’ve inserted a macro onto the page because macros present you with additional parameters in a modal window. For example, insert the Table of Contents macro to display all the headings on your page as clickable links or use the Attachments macro to list files attached to a page.

Macros require more setup than the basic elements or formatting tools you can insert. You know you’ve inserted a basic element because those items just give you a few options in the floating toolbar. For example, insert a Status lozenge or a Date, or applying formatting to text like a Quote or a Heading.

Use a macro

To edit a macro:

Parameters

Many macros have optional parameters you can use to control the macro’s output.

With the Attachments Macro, for instance, you have two optional parameters allowing you to:

Placeholders

Macro placeholders are displayed in the editor where you have added a macro to the page.

When editing a page, you can:

Macros in the legacy editor only

Below is a list of the macros available in the legacy editor.

Click a macro name for details of the usage, including optional parameters and examples.

For alternate methods for accomplishing the goal of older macros, check out these suggestions.

Macros available in both editors

Below is a list of the macros available in both editors.

Click a macro name for details of the usage, including optional parameters and examples.

Macros from the Marketplace

Many more macros are available from the Atlassian Marketplace.

Источник

Confluence Support

Knowledge base

Products

Jira Software

Project and issue tracking

Jira Service Management

Service management and customer support

Jira Core

Manage any business project

Confluence

Bitbucket

Git code management

Resources

Documentation

Usage and admin help

Community

Answers, support, and inspiration

Suggestions and bugs

Feature suggestions and bug reports

Marketplace

Billing and licensing

Frequently asked questions

Viewport

Confluence

Versions

Macros

Confluence Data Center and Server documentation

On this page

In this section

Related content

Still need help?

The Atlassian Community is here for you.

Macros are how you supercharge your Confluence pages.

You can use macros to:

Take your Confluence space to the next level using macros.

On this page:

Screenshot: Page containing Status, Page Properties Report, Livesearch, and Profile Picture macros to help people find information about particular projects.

Macro basics

Add a macro to your page

To add a macro to your page:

In the editor you’ll see a placeholder that represents the macro. Once you publish your page, you’ll see the macro in its full glory.

Edit a macro

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

Head to the documentation for specific macros below for full details of the parameters available in each macro.

Confluence macros

Here’s a list of macros currently available with Confluence Server and Data Center.

Click a macro name for details of the usage, including optional parameters and examples.

Get more macros

This documentation provides information on all the macros that are provided with Confluence by default. There may be other macros in your site, from Marketplace Apps, or perhaps developed in-house.

Third-party macros from the Atlassian Marketplace

You can find a wide range of Atlassian and third party macros at The Marketplace. These are distributed as apps and can be installed by a Confluence Administrator.

Create your own macros

Macro usage statistics

Confluence administrators can check how often each macro is used in your site.

To see how often a macro is used, go to > General Configuration > Macro Usage. This lists how often each macro is used in current spaces but doesn’t include any macros used on pages in archived spaces or macros provided by disabled apps.

Unknown macro

In view page mode, disabled macros show a placeholder image:

When macros with body content are disabled, the content will be preserved and display in the editor.

To display the content in view mode:

In the editor, the disabled macro will switch to the new macro and display your content. Update the page to display the content in view mode.

Do more with Confluence

Extend Confluence with one of the hundreds of other macros in the Atlassian Marketplace, such as:

Источник

Проектирование в 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. При этом каждый человек в своей карточке сотрудника ведет важную историю и свой план развития — создает вложенную страницу из шаблона планов развития.

Заключение

Ведите любую документацию так, чтобы за нее не было стыдно, а пользователям не было мучительно больно!

Очень надеюсь, что статья будет полезна и во всех документациях мира наступит порядок.

Источник