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