Что такое карта программной системы?

#Что это такое

Карта системы

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

Если проще Письменный ответ на вопрос «из чего это сделано и что с чем разговаривает» — такой, что каждую строчку можно возвести к чему-то в коде.

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

#Что в неё входит

Всё перечисленное ниже есть в проекте 1ADK, потому что инструкция анализа просит об этом явно. Карта, в которой есть только первая строка, — это картинка; карта, в которой есть все, пригодна тому, кого при этом не было.

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

#Почему это не схема

Архитектурные схемы полезны. Но это другой объект с другими способами ломаться.

Иметь стоит и то, и другое. Беда начинается, когда схемой, нарисованной полтора года назад, отвечают на вопрос о сегодняшней системе, — а на практике так и происходит, потому что другого документа в комнате нет.

#Как она выглядит

Портал клиента         ВЕБ-ПРИЛОЖЕНИЕ
  → читает из          Сервис подписок
  → отправляет в       Сервис биллинга         /api/invoices        POST

Сервис биллинга        СЕРВИС
  → пишет в            Основную базу           payments, invoices
  → публикует в        Очередь платежей
  → вызывает           Платёжного провайдера   ВНЕШНИЙ · REST

Обработчик просрочек   ФОНОВЫЙ ОБРАБОТЧИК
  → читает             Очередь платежей
  → пишет в            Основную базу

Ночная выгрузка        ЗАДАНИЕ ПО РАСПИСАНИЮ
  → читает из          Основную базу
  → пишет в            (получатель не установлен)        НЕИЗВЕСТНО

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

#Пять взглядов на одну систему

Те же компоненты, разложенные по тому вопросу, который вы задаёте.

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

• Приложение — из чего программа состоит, на языке программ.
• Бизнес — что программа делает, на языке компании.
• Организация — кто чем владеет.
• Развёртывание — что где работает.
• Данные — какие сведения существуют и где они живут.

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

#Что делает её достоверной

Три свойства; карта без любого из них — это документ с лучшей вёрсткой.

1. Каждое утверждение можно открыть

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

2. Пробелы видны

   То, что установить не удалось, записано открытым вопросом с причиной. Молчание никогда не означает «там ничего нет».

3. Устаревание заметно

   У карты есть дата и запись об охвате, а следующий анализ сообщает, что изменилось с тех пор, — включая то, какие из её собственных прежних утверждений больше не подтверждаются.

#Чего карта не скажет