Документация: минимум, который стоит держать

Документация: минимум, который стоит держать

Полной документации не будет никогда, и это нормально. Но несколько страниц экономят команде недели.

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

Карта системы на одном экране: из чего состоит и как связано.

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

Что делать при аварии: куда смотреть, кого звать, какие есть рычаги.

Остальное — по обстоятельствам.

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

IT Ярославль — t.me/yaroslavl_it