Сопровождение и доработка ПО

Аудит программного кода перед доработкой: когда нужен

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

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

Аудит программного кода нужен тогда, когда вы собираетесь дорабатывать систему, а ее устройство и состояние вам неизвестны. Он показывает, на что можно опереться, где находятся риски и в каком порядке двигаться дальше. Если код писали давно или другие люди, начинать доработку без такой проверки значит платить за работу без понимания системы.

Что такое аудит кода и зачем он перед доработкой

Аудит означает независимый осмотр системы изнутри: как устроен код, как хранятся данные, где система запущена и что с чем связано. Задача осмотра в том, чтобы понять состояние продукта до того, как в него начнут вносить изменения.

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

Заказчику без технического образования трудно оценить слова подрядчика о том, что систему надо переписать с нуля. Осмотр дает основу для обсуждения: у вас появляется описание состояния, которое можно показать любому специалисту.

Когда аудит нужен до доработки

Аудит стоит заказывать, если верно хотя бы одно из условий:

Тяжелее всего, когда разработчик исчез и проект остался без хозяина. Этот случай разобран в статье о передаче проекта другому разработчику, и аудит там почти всегда идет первым шагом.

  • Разработчик ушел, а документации нет или она давно устарела.
  • Код достался от подрядчика, с которым вы больше не работаете.
  • Каждая правка ломает что-то рядом, и команда боится трогать систему.
  • Вы не знаете, где лежит база данных и у кого есть к ней доступ.
  • Вам назвали объем работ, но проверить его обоснованность вы не можете.
  • Вы хотите развивать продукт, который работает годами, а целиком его никто не видел.

Когда без аудита можно обойтись

Если система небольшая, автор на связи, а описание актуально, хватит обычного знакомства с продуктом в начале работы. Полный аудит там даст мало нового.

Задача тоже бывает узкой и разовой. Например, нужно поменять текст в уведомлении, которое система отправляет клиентам. Но и тогда полезно выяснить, что еще затрагивает правка.

Решение зависит от цены ошибки. Чем сильнее от системы зависят продажи, исполнение заказов и финансы компании, тем дороже обходится слепая доработка.

Что смотрят при проверке

Набор проверок зависит от продукта, но общие направления у них одинаковые:

Отдельно смотрят на то, чего не видно в самом коде: пароли, ключи и доступы, которые знает только один человек. Если он уходит, система остается без владельца.

Глубина осмотра зависит от задачи. Для небольшой веб-системы хватает обзора основных частей, а для большой, с множеством связей, нужна более подробная работа.

  • читаемость и структура кода: можно ли разобраться в нем без автора;
  • база данных: как организованы данные и есть ли резервные копии;
  • инфраструктура: где система запущена и кто управляет доступами;
  • интеграции с другими системами и сервисами;
  • тестовая среда и порядок выкладки изменений;
  • известные ошибки и накопленные обходные решения.

Что должно получиться на выходе

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

Рисками называют все, что может остановить продукт или привести к затратам: единственный носитель знаний, отсутствие резервных копий, устаревшие компоненты. Каждый риск описывают так, чтобы его можно было проверить и оценить.

После этого доработку планируют по приоритетам: объем и порядок работ сверяют с реальным состоянием кода и записывают в план.

Аудит и рефакторинг: что делать первым

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

Без аудита неясно, что именно перестраивать. Можно потратить силы на аккуратный, но редко используемый модуль и оставить без внимания опасное место, на котором держится вся система.

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

Если после аудита систему нужно вести постоянно, прочитайте материал про сопровождение программного обеспечения.

Как начинается работа

Работа начинается с заявки на сайте: в ней указывают имя, способ связи, услугу и описание задачи. Ответ на заявку приходит в течение рабочего дня, первая встреча длится шестьдесят минут и проходит онлайн. Со стороны Smart Solutions управленческий и операционный консультант ведет проект сам и делает его с командой разработчиков. Порядок постоянный: сначала диагностика, потом приоритеты, и только после этого изменения. После встречи следует знакомство с продуктом, при котором получают доступ к коду, базе данных и инфраструктуре.

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

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

Что подготовить к первой встрече

Для аудита понадобятся репозиторий, доступ к средам, база данных, список интеграций и текущие задачи.

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

Цены не публикуются, поэтому оценить задачу заранее по прайсу нельзя. Прайса на сайте нет. Чтобы обсудить задачу, оставьте заявку, ответ придет в течение рабочего дня. Порядок работы описан в разделе «Как начинается работа».

Частые вопросы по услуге

Когда нужен аудит программного кода перед доработкой?

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

Чем рефакторинг программного кода отличается от аудита?

Аудит оценивает состояние системы и называет риски. Рефакторинг перестраивает внутреннее устройство кода при тех же функциях для пользователя. Начинают с аудита, потому что иначе неясно, что именно стоит улучшать в первую очередь.

Что получает собственник по итогам аудита?

Он получает документ с описанием состояния системы, перечнем рисков и порядком дальнейших действий. По нему можно сверить объем доработки с реальным положением дел. Решение о следующем шаге остается за собственником.

Другие статьи раздела