Единый источник правды за пять шагов

Во втором выпуске подкаста технического коммуникатора ТЕХКОМПОД затронул тему единого источника правды и каким образом данный подход можно реализовать в Confluence.

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

Итак, приведу схему реализации концепции единого источника с элементами корпоративного хранилища данных на упрощенном примере.

Представьте, что Вы создаете три документа (если конкретнее, три руководства) для одной из Ваших информационных систем:

• руководство администратора,
• руководство оператора,
• руководство пользователя отчетности.

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

Предположим, что это следующие разделы:

• назначение системы,
• список сокращений.

Следовательно, повторяющиеся разделы являются прекрасными претендентами для многократного переиспользования из единого источника.

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

Шаг 1. Создайте раздел Уровень распространения, в который включите страницы в соответствии с наименованиями повторяющихся разделов Вашей документации. Например, Назначение системы и Список сокращений (Рисунок 1).

Шаг 2. Создайте раздел Документация, в который добавьте структуру разрабатываемых документов. Например, Руководство администратора, Руководство оператора и Руководство пользователя отчетности (Рисунок 2).

Шаг 3. Проработайте и отразите взаимосвязи информации из уровня распространения (источник) и конечными документами (цель) (Рисунок 3).

Шаг 4. Наполните повторяющиеся разделы документации из уровня распространения необходимой информацией с помощью макроса Выборка (Excerpt). На примере раздела Назначение системы (Рисунок 4).

Шаг 5. Добавьте в структуры Ваших документов необходимую информацию из уровня распространения с помощью макроса Включить выборку. На примере Руководства администратора (Рисунки 5.1-5.2).

Всё! В этих нехитрых пяти шагах и заключена основная идея подхода или концепции единого источника.

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