В текущем спринте нам с командой надо было реализовать операцию по отправке группы платежей в Банк (подписание и прочие подготовительные операции выполнялись в старой версии системы). Времени — всего неделя. Из наработок, которые мы могли бы переиспользовать, API, позволяющий отправлять в Банк на исполнение единичный платёж.
Команда принимает решение — для каждого платёжного поручения группы, выбранного на фронте, делать вызов существующего API для поштучной отправки платежей. Спустя неделю отчитываемся о достижении цели спринта. Новый функционал открыт на клиентов. Теперь они могут за пару кликов отправлять сразу десять, двадцать и больше платежей в Банк на исполнение. Ценность определённо есть.
Но какой ценой была достигнута цель спринта? Ростом нагрузки на сеть. Увеличением времени обработки запросов клиентов. Таймаутами. Решение было неоптимальным. У команды образовался техдолг.
Технический долг — это накопленные в программном коде или архитектуре проблемы, связанные с пренебрежением к качеству программного продукта. Эти проблемы мы фиксируем и обещаем когда-то устранить. Поэтому технический долг сопряжён с дополнительными будущими затратами на его устранение.
Техническим долгом надо управлять, стремясь к его минимизации. Ведь чем меньше техдолг, тем выше качество программного продукта. Однако единовременно его очень трудно устранить в связи с потребностью в дополнительных затратах и желанием Бизнеса (да и некоторых участников команд развития) заниматься преимущественно разработкой новых фич. Именно поэтому устранение технического долга надо планировать, выделяя необходимые ресурсы и время.
Технический долг может относиться к продуктам, развитием которых занимаются выделенные команды. Однако и по продуктам без закреплённой команды развития также может существовать техдолг. Кто в таком случае отвечает за его устранение?
В нашей Дирекции за развитие функционального слоя и обеспечение качества разрабатываемых решений отвечают Центры компетенций — аналитики, java и javascript-разработки, тестирования. Соответственно, если есть продукт без команды развития, по которому имеется техдолг, то ресурсы на его устранение следовало бы запрашивать в Центрах компетенций. Но какой из них должен отвечать за устранение технического долга по продукту без команды развития?
В корпоративном направлении Центра компетенций аналитики удалённых каналов доступа мы решили взять технический долг под контроль. Начали с определения понятия техдолга аналитики. Под ним мы договорились понимать то же, что и обычный технический долг, только применительно к артефактам работы аналитика, а именно архитектурной и проектной документации. При этом техдолг аналитики мог проявляться в трёх аспектах, связанных с выкаченным в бой функционалом и влияющих на приоритет его устранения:
- Отсутствие документации — высокий приоритет.
- Неактуальность документации — средний приоритет.
- Несоответствие документации стандарту её оформления — низкий приоритет.
После определения понятия мы решили сформировать бэклог технического долга аналитики. Начали с высокоприоритетного техдолга (Priority = High), связанного с отсутствием документации на выкаченный в бой функционал. Информация по всем выкаченным в бой программным продуктам, в том числе наличию архитектурной и проектной документации на них, находится у функционального сопровождения. Мы запросили у коллег из сопровождения информацию по наличию документации по всем продуктам нового интернет-банка (НИБ) для юридических лиц и индивидуальных предпринимателей. В результате мы получили довольно внушительный перечень отсутствующих документов. Для каждого такого документа была создана отдельная задача с признаком “техдолг” (Issue Type = Тех. долг) в специальном проекте в JIRA.
Развитием большинства продуктов с отсутствующими документами занимались выделенные команды развития. Поэтому большая часть техдолга нашла ответственных за его устранение среди аналитиков соответствующих команд (Assignee, Alfa Teams). Верификатором по задаче устранения техдолга решили сделать техлида аналитика, ответственного за задачу.
Однако были и продукты, за которыми не была закреплена ни одна команда развития. Устранять техдолг аналитики по таким продуктам решили в рамках личных целей аналитиков Центра компетенций. Чуть больше информации про личные цели можно получить в докладе Алексея Лобзова на митапе Гильдии Аналитиков.
Выкатка поставок в бой в НИБ выполняется через отдельную доску в JIRA. В задачи на выкатку мы добавили поле для указания ссылки на документацию на поставку, если она имеется, либо на задачу техдолга, если документацию только предстоит написать (Priority = High)/ актуализировать (Priority = Medium)/ привести к стандарту (Priority = Low). Таким образом, чтобы не тормозить разработку, мы решили разрешить выкатываться в бой с техническим долгом по документации, но при условии, что он будет зафиксирован в виде отдельной задачи в JIRA. Это позволило бы нам как минимум не забыть о том, что у нас есть техдолг аналитики.
Конечно, аналитики могли бы хитрить, указывая в новом поле ссылку на старую версию документации, которая могла быть неактуальной или не соответствующей стандарту, либо на документацию по совершенно другому программному продукту вместо того, чтобы заводить и указывать ссылку на задачу по устранению технического долга аналитики. Однако мы решили исходить из того, что наши коллеги работают честно и не скрывают проблемы по своим проектам.
В любом случае, никто не запрещает техлиду либо специалисту функционального сопровождения перед раскаткой ознакомиться с описанием поставки, в том числе приложенной документацией на неё. Даже если приведена ссылка на нужную документацию, её актуальность можно легко проверить как минимум по дате изменения. А соответствие стандарту — по полученным аппрувам и комментариям от коллег-аналитиков, которые обращают на это внимание при ревью документов.
Таким образом, мы сделали первый большой шаг к централизованному управлению техническим долгом аналитики в корпоративном направлении нашего Центра компетенций. Мы создали правила учёта техдолга и сформировали бэклог задач на его устранение. Мы даже определили ответственных по большинству из созданных задач.
Обладая данными по техдолгу аналитики в разрезе команд развития, мы можем совместно с Бизнесом планировать его устранение за счёт включения соответствующих мероприятий в квартальные цели команд. Что же касается техдолга по продуктам без команд развития, пока планируем закрывать его в рамках личных целей аналитиков Центра компетенций.
Больше информации по теме можно получить из доклада Анатолия Олейнера на недавно прошедшем Open Analysis System Meetup. Как только наберём достаточно статистики по устранению техдолга, поделимся в нашем блоге.
А сейчас вопрос к вам, читателям. Есть ли в вашей компании процесс управления техдолгом в целом и техдолгом аналитики в частности? Как он организован? Какими инструментами пользуетесь?
Комментарии (13)
KoteMilote
16.12.2021 12:50+2А как техдолг аналитики влияет на продукт и разработку?
Как в прошлом аналитик, а теперь разработчик считаю, что: После того как фича выставлена в прод вся написаная документация по ней, теряет гарантированную актуальность.
Единственное среди документов которые должны быть обязательны - это актуальная спецификация API
alobzov Автор
16.12.2021 13:59+3Функциональному сопровождению проектная документация нужна для разбора инцидентов. Сотрудники саппорта не полезут в код смотреть реализацию. Они работаю с документами.
Solution-архитекторы используют архитектурные документы на систему для проектирования новых решениях, в которых эта система будет использоваться.
Эксперты по информационной безопасности также смотрят документацию и проводят на её основе экспертизу системы в своей области.
В Банке у документации множество потребителей. Они не читают код. И поэтому документация должна соответствовать реализации. А несоответствие документации и реализации - это проблема, которую надо решать
SpiderEkb
16.12.2021 14:42+2Плюс когда работающий на бою код приходит на доработку (не знаю как у вас, у нас на уровне EQ это сплошь и рядом - поменялся бизнес-процесс или появились новые требования...) актуальная документация очень помогает быстро разобраться где именно требуется доработка. Особенно это касается кода, реализующего сложную бизнес-логику (возможно, это опять особенности уровня EQ).
Так что на своем уровне всегда стараемся максимального соответствия FSD коду. И наоборот (вплоть до вставки пунктов FSD в комментарии - "этот кусок кода реализует этот пункт FSD" и т.п.)
des1roer
16.12.2021 13:32А создание документации на основании кода не рассматривали? OpenAPI, парсить коменты из кода, e.t.c.
alobzov Автор
16.12.2021 14:01+2Рассматривали. Есть наработки. Но текущие возможности OpenAPI не удовлетворяют всем потребностям для ведения документации по банковским продуктам
SergeyT-hh
16.12.2021 18:48+1А как вы справляетесь с накоплением техдолга во время исправления техдолга? :)
т.е. в то время пока вы актуализируете артефакты аналитики разработка ведь продолжается? и актуализируемые артефакты опять устаревают) или актуализация выполняется по завершении разработки какого то функционального модуля?
alobzov Автор
16.12.2021 18:59+2В идеале артефакты работы аналитика должны появляться вместе с артефактами работы разработчика. Т.е. выкатили в бой функционал. А он в свою очередь покрыт документацией. Если функционал выкатился без появления/ актуализации документации, возникает техдолг аналитики на этот конкретный функционал.
Внимания заслуживает ситуация автоматического закрытия техдолга. Хороший пример - проект миграции, когда аналитики не актуализируют документы на старую систему. В этом нет смысла, т.к. скоро ей на замену придёт новая со своей документацией
hungry_forester
17.12.2021 16:24Но какой ценой была достигнута цель спринта? Ростом нагрузки на сеть. Увеличением времени обработки запросов клиентов. Таймаутами. Решение было неоптимальным. У команды образовался техдолг.
Довольно-таки дискутируемый вопрос, даже вне контекста.
Есть ли деньги на разработку оптимального решения?
Каковы критерии оптимальности решения?
Много ли таких клиентов, которым надо отправлять пачку платежек?
Как вы в этом тысячелетии умудрились разработать клиент-банк, который отправляет платежки поштучно?
Отвечу и на вопросы.
Есть ли в вашей компании процесс управления техдолгом в целом и техдолгом аналитики в частности? - нет, технического долга собирается довольно мало, а делать что-то красивое вместо некрасивого обычно настолько затратно, что контролируется это верхним руководством, а не внутри команды к.-л. проекта
Как он организован? - всё в рамках управления проектом, если есть насущная нужда осовременить или доработать нечто - то это включается в план работы.
Какими инструментами пользуетесь? - JIRA
По большому счету, техдолг от бэклога в моем случае недалеко ушел.
SpiderEkb
18.12.2021 08:50Как вы в этом тысячелетии умудрились разработать клиент-банк, который отправляет платежки поштучно?
Это зависит не только от клиент-банка. Тут еще на стороне АБС должен быть сервис-модуль, обрабатывающий платежки в пакетном режиме.
Т.е. все выглядит примерно так: "мы тут новую фичу хотим запилить, сделайте нам вот такой вебсервис и сервис-модуль".
В принципе, для АБС выгоднее получать пакет из 100 платежек, нежели 100 платежек по одной штуке т.к. есть возможность сразу распараллелить обработку на несколько потоков (заданий) и тем самым сократиь время.
Но все это будет делаться уже на стороне АБС, силами других команд и на совершенно другом технологическом стеке.
tegrato
17.12.2021 22:08Аутсорсным командам скорее всего не получится официально заниматься техдолгом, если у них почасовая оплата.
alobzov Автор
18.12.2021 10:17В этом плане у нас легче. Внешние сотрудники преимущественно на аутстаффе. Поэтому они также вовлечены в работу с техдолгом, как и штатные сотрудники
TerraV
Я правильно понимаю что у вас есть видение что такая работа с тех долгом должна помочь, но факты будут самое раннее через 6 месяцев? Потому что по опыту первые две недели все идет согласно плану а потом ресурсы растаскиваются по горячим проблемам и в результате меняется примерно ничего.
alobzov Автор
Сейчас есть понимание объёма техдолга и начата работа по его контролируемому устранению. Безусловно, если Бизнес не будет вовлечён в эту работу и в отсутствии лидеров процесс заглохнет. Но коммуникация с первыми есть, лидеры также имеются (техлиды аналитики). Поэтому есть шанс на успех