Из чего система состоит
Структурный ответ: части и то, как они складываются. Именно за этим первым делом приходит новый разработчик, новый технический директор или владелец, у которого технической картины никогда не было.
- Продукт Карта системы Карта системы — это структурированный ответ на вопрос, из чего состоит программа и как её части связаны между собой. Что в неё входит, что делает её достоверной и чем она отличается от архитектурной схемы. Что такое карта программной системы?
- Продукт Реестр компонентов Почему список компонентов сложнее, чем кажется, что делает запись устойчивой от анализа к анализу и почему именно тождество, а не название, решает, переживёт ли реестр своё второе обновление. Как получить надёжный список всего, из чего состоит система?
- Продукт Карта интеграций Внешние сервисы, очереди, базы данных и чужие API, без которых система не работает: как их найти, почему список почти всегда неполон и что делать с теми частями, которые никто не может подтвердить. От чего на самом деле зависит работа моей системы?
Насколько этому можно верить
То, что отличает проект 1ADK от уверенно звучащего пересказа. У каждого утверждения есть источник, а всё, что установить не удалось, записано открытым вопросом, а не тихо опущено.
- Продукт Доказательства Каждое утверждение 1ADK несёт файл, диапазон строк или конфигурацию, из которых оно взято. Что такое доказательство, что означает уверенность и почему проверяемое утверждение лучше уверенного объяснения. Как проверить, правда ли то, что сказано о моей системе?
- Продукт Неизвестное Неизвестное — это результат, а не сбой. Почему «не найдено» не равно «этого нет», как открытый вопрос записывается и закрывается и почему документ без пробелов должен вас насторожить. Как документировать то, чего о системе никто не знает?
Что с этим происходит со временем
Картина системы полезна ровно до тех пор, пока она ещё верна. Эти две страницы — довод в пользу того, почему 1ADK это подписка, а не отчёт.
- Продукт История изменений Сравнение двух анализов одной системы даёт четыре разных ответа: появилось, изменилось, исчезло и больше не подтверждается. Почему именно четвёртый — причина продолжать анализировать. Как отследить, что меняется в архитектуре моей системы?
- Продукт Техническая память Документация устаревает, потому что её пишут один раз и поддерживают руками. Что такое техническая память вместо неё, почему её нужно пересобирать, а не править, и что это меняет для владельца. Почему техническая документация всегда устаревает?
Вместо того чтобы читать об этом
Демонстрация — это полностью проанализированная система: вымышленная и помеченная как вымышленная на каждом экране, показанная теми же страницами, которыми пользуется собственный проект клиента. Двух минут хватит, чтобы понять, нужно ли вам всё это.