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