Перейти к содержимому

Сергей Пальчиков

Технический эксперт

Есть типичная и болезненная ситуация: продукт уже написан, работает и продаётся, а документации на него либо нет совсем, либо она хаотична и не соответствует формальным требованиям. Команда торопилась с запуском и откладывала бумаги «на потом».

«Потом» наступает, когда появляется потребность в статусе отечественного ПО — для налоговых льгот или доступа к госзакупкам.

В этот момент выясняется:

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

Именно с такими задачами чаще всего работает Сергей.

Более тринадцати лет он руководил командами разработки, где документация создавалась одновременно с кодом. Поэтому он точно знает, чего не хватает, когда всё приходится готовить в обратном порядке.

Опыт руководителя разработки — ключевое преимущество.

Разработка технической документации по готовому коду — задача не литературная, а инженерно-аналитическая. Нужно разобраться в чужой кодовой базе (часто с минимальными пояснениями авторов), восстановить архитектурные решения, которые в своё время никто не зафиксировал, и оформить результат в форме, которую примет экспертиза Минцифры.

Сергей окончил Московский институт инженеров железнодорожного транспорта по специальности «Автоматика, телемеханика и связь», получил MBA по управлению предприятиями в Академии народного хозяйства при Правительстве РФ. Главный актив — практический опыт:

  • технический директор в молодой компании по разработке ПО;
  • руководитель разработки продуктов в структуре Госкорпорации;
  • руководитель департамента исследований и научно-технических разработок в компании, связанной с Интеллектуальной транспортной системой г. Москвы.

Всё это время он ставил задачи программистам, аналитикам и техническим специалистам и принимал результат — то есть годами смотрел на код и документацию одновременно, с обеих сторон.

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

Что входит в разработку документации на ПО по готовому коду?

Для включения в реестр Минцифры пакет документов делится на правовую и техническую части. Именно качество технической части чаще всего определяет успех экспертизы. Когда клиент приходит с одним только кодом, работа обычно строится так:

  • Аудит кодовой базы. Изучение архитектуры, стека технологий, сторонних библиотек и их лицензий. Компоненты под copyleft-лицензиями (GPL, AGPL и аналогичные) могут стать основанием для отказа, если не подтверждено соблюдение условий лицензии.
  • Анализ истории разработки. Экспертиза требует подтверждения, что продукт создан силами правообладателя. Для этого анализируется журнал системы контроля версий (Git), коммиты сверяются с авторством сотрудников заказчика.
  • Составление технического описания и функциональных характеристик на основе фактического кода: архитектура, поддерживаемые операционные системы и СУБД.
  • Подготовка перечня используемых компонентов с указанием версий и типов лицензий.
  • Проверка совместимости с доверенными российскими операционными системами (для прикладного ПО — минимум с двумя ОС из реестра) с подтверждающими документами.
  • Формирование пакета для загрузки в реестр: инструкция по установке и активации ПО.

Любая недостающая деталь — неподтверждённое авторство коммита, проблемная лицензия компонента — может привести к отказу или затянуть экспертизу на месяцы.

Часто задаваемые вопросы

Что делать, если у продукта нет документации, а нужно попасть в реестр Минцифры?

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

Какой самый частый повод для отказа при подаче в реестр?

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

Сколько длится экспертиза заявки в реестре Минцифры?

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

Можно ли разработать документацию без раскрытия всей бизнес-логики продукта?

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

Сайт использует файлы cookie
Подробнее