🤩 Confluence - это холодильник

Все туда что-то кладут, но никто не знает, что там есть. Через месяц находите “срочный BRD” рядом с мемом про котиков 💼Мне очень повезло, что в моей компании было не так много документации. И я действительно благодарна за то, что смогла пройти этот путь и описать всё через свою призму 🏌️ Хотите кринж-историю про мою сакральную любовь к Confluence, начавшуюся с другого проекта? Готовьте попкорн — будет отдельный пост (и да, мне стыдно).

Ладно. Шутки в сторону. 🚀 Как, что я документировала и как поддерживаю документацию? + Мои ошибки 1️⃣Описание опыта пользователей через Use Case в графическом и табличном видах: в умных статьях с habr.com графический вариант - база, но табличный лично мне позволил лучше разобраться в том, что я описываю 2️⃣Описание интеграций через Sequence diagram - как сейчас модно говорить: "Базовый минимум" 3️⃣Описание сетевой структуры и в целом ресурсов IT в диаграмме компонентов - вот тут я пострадала, но мне понравилось 🥵. Во-первых, диаграмма настолько большая, что мой любимый plantuml.com не выдержал и 50% объема диаграммы (компонентов было действительно много - и каждый был нужен). Кроме того, такие важные данные не хотелось заносить в облачное решение 🤡 Слава богу, код можно написать в Visual Studio Code, сохранить plantuml в svg 4️⃣Диаграмма контекста и контейнеров: первые два уровня из нотации С4, они помогли мне капнуть глубже 🧐. 5️⃣Эндпоинты и Swagger: черт возьми, по незнанию я вручную писала Swagger на основе devtools 🤡 чуть позже узнала, что Swagger можно спокойно сделать на основе кода 6️⃣Описание различных обработок и процедур, разбор разбора магического JSON - да, на основе кода и devtools. Мне так быстрее. И что вы мне сделаете? Я уже говорила, что я ебанутая. 7️⃣Различные глоссарии, БП по отделам, константы, огромные реестры и т. д. - ничего интересного, но в нужный момент выручает. 8️⃣Ролевая модель: более подробно про нее расскажу в другом посте, но главное, чем я довольна в этой части - я могу забыть своё имя и всё на свете, но я загляну в свою документацию и восстановлю ролевую модель для любого пользователя, как только вспомню русский алфавит.

Пункты 1-6 были описаны в самом начале, пункт 7 расширяется, а пункт 8 постоянно поддерживается в актуальном состоянии 💅

Не учи меня тайной магии - она писалась при мне!

#SABA #Системныйанализ #IT #Аналитика #SABAчка