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