Пояснительная бригада: если нужна документация, напиши её сам

Пояснительная бригада: если нужна документация, напиши её сам

Поясняет редакция «Кода»:

На картинке — ситуация, в которой разработчик просит документацию к старому проекту, которому уже пять лет. К нему выходит сеньор — Альбус Персиваль Вульфрик Брайан Дамблдор, — и уже по его виду понятно, что лёгких путей тут не будет. И скорее всего, документацию этому программисту придётся писать самому.

Грустная ирония тут в том, что чаще всего в легаси-проектах (а пять лет в ИТ — это огромный срок), даже если они до сих пор работают, нет документации. Причины могут быть разные:

  • его сделали быстро, запустили, всё работает, к чему лишняя морока с бумагами?
  • проект заброшен, но по каким-то причинам его захотели реанимировать;
  • все артефакты по проекту где-то лежат, но никто не знает где;
  • в компании вообще из нынешних сотрудников никто не работал с этим проектом и не знает, откуда он вообще появился изначально;
  • фаза Луны виновата.

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

В смысле, писать документацию к проекту.

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

Получите ИТ-профессию
В «Яндекс Практикуме» можно стать разработчиком, тестировщиком, аналитиком и менеджером цифровых продуктов. Первая часть обучения всегда бесплатная, чтобы попробовать и найти то, что вам по душе. Дальше — программы трудоустройства.
Вам может быть интересно
[anycomment]
Exit mobile version