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