Как навести порядок в хаосе

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


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


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

1.2. Глоссарий
Использую базовую версию таблицы с двумя полями: "Термин" и "Описание". Если нужен расширенный вариант, вот шаблон из статьи.


1.3. Реестр бизнес-процессов
Перечислите БП системы. Предлагаю структуру: "Название БП", "Что делает", "Зачем" и "С каким БП связан", а если у вас микросервисы, добавьте в таблицу ещё входные и выходные данные.

1.3.1. Дочерние страницы под каждый БП
Если кажется, что описание процесса получается слишком большим, вам не кажется. Декомпозируйте.


1.4. Модель предметной области
Покажите как связаны сущности в системе. В качестве нотации используйте концептуальную ER диаграмму без атрибутов.

1.5. Реестр интеграций
Подойдёт если у вас больше 5-10 интеграций и вы о них знаете. Но с хорошим open Api рискуете пропустить интеграцию и о новой системе узнает только поддержка при создании токена😁


1.6. Шаблоны
Создайте шаблоны под каждую задачу, к которой аналитики подходят по-разному: ТЗ, моделирование, постановка задач, регламенты проведения встреч и т.д.

Я создала шаблон "идеального ТЗ". Как выяснила в процессе работы, он перегружен и нуждается в оптимизации, но всё ещё служит хорошей отправной точкой.


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

Мой топ макросов для Confluence

В своей практике применяю минимальный набор макросов и стараюсь писать понятно — текст сам подскажет какая функция вам подойдёт.


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

— Раскрыть
Универсальный инструмент. Да прибудет с вами сила противостоять желанию засунуть в него всю информацию, как в шкаф перед приходом гостей😬. Внутри блока тоже все должно быть структурированно и понятно.
🔵Использую в сочетании с макросом "Блок кода" для оформления примеров запроса и ответа с подсветкой синтаксиса, для дополнительной информации и для макетов. Помещаю скрины под кат и таблица выглядит компактнее.
🔵Для всего объёмного и не нужного на постоянной основе (например, запрос, ответ или логика работы эндпоинта).

— Статус
Добавим цвет.
🔵Здесь упоминаю названия методов по аналогии со Swagger UI (GET синий, POST зелёный, DELETE красный, PUT и PATCH желтые).
🔵Также раньше разными цветами обозначали задачи на front и back, но мне больше нравится писать текстом [F], [B] и ставить тэги в самих задачах.
Если ваш таск-трекер - Jira, обратите внимание на "Фильтр/проблема Jira".

— Информация, предупреждение, подсказка и примечание
Помогают улучшить читабельность основных моментов в тексте. Используйте макрос "Информация", если текст приходит на ум со словами “кстати”. Если хочется что-то посоветовать делать, то "Подсказка". Если не делать, то "Предупреждение". А обратить внимание - это "Примечание".

— Разметка страницы.
Полезно, если хотите создать 2-3 колонки на странице. Например, когда нужно показать вид страницы в зависимости от роли пользователя.

— Заголовки, списки, таблицы.
Это база для создания структуры.


Поделитесь своими лайфхаками для оформления документации в комментариях💕
P.S.: если нужно больше макросов, вот статья

Как улучшить процессы
и сделать их повторяемыми и управляемыми (2 уровень CMMI):


Инструкция:
1️⃣ Выпишите все рабочие процессы.
2️⃣ Декомпозируйте их на задачи.
3️⃣ Определите технику или алгоритм работы с каждой задачей и составьте таблицу соответствия.
4️⃣ Создайте шаблоны для задач, для которых это возможно.
Минимально — шаблон ТЗ и постановки, но также в работе помогут формы писем для подведения итогов встречи, согласования ТЗ, напоминания о согласовании.

5️⃣ Сформируйте процесс работы.
💩В какой последовательности выполняете задачи;
💩После какого артефакта или события задача считается выполненной;
💩Когда задачу или пункт в алгоритме нужно пропустить.

6️⃣ Протестируйте полученный процесс на практике
7️⃣ Скорректируйте алгоритм или шаблон по результатам
8️⃣ Повторяйте 6 и 7 пункты при работе с каждой задачей.

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

Да прибудет с вами дисциплина.


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

P.S.: в комментариях оставила таблицу соответствия техник и задач БА. Скачивайте💕