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