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