Документация: тот минимум, который окупается
Полной документации не будет никогда, но несколько страниц экономят команде недели.
Как поднять проект локально — со всеми версиями и граблями.
Карта системы на одном экране: из чего состоит и как связано.
Причины решений: не что выбрали, а почему и что рассматривали как альтернативу. Единственное, что нельзя восстановить по коду.
Что делать при аварии: куда смотреть, кого звать, какие есть рычаги.
Остальное — по обстоятельствам.
И правьте документацию сразу, как сами на ней споткнулись: через год такая страница будет точнее любой, написанной специально и один раз. Для распределённых команд это вообще главный источник ответов, когда спросить некого.
IT Иркутск — t.me/irkutsk_it
IT Иркутск
@irkutsk_it
Документация: тот минимум, который окупается
Этот пост опубликован в Telegram-канале IT Иркутск. Подписаться можно по ссылке: @irkutsk_it.