IT Тюмень
IT Тюмень
@itnews_tyumen

Документация, которую читают

Плохая документация пересказывает код словами. Она устаревает за месяц и начинает врать, а врущая хуже отсутствующей: по ней принимают неверные решения.

Что писать стоит. Как запустить проект с нуля на чистой машине. Почему приняты те или иные решения — код показывает «как», но не «почему». Что мы обещаем соседним командам и в каком формате.

Что не стоит: описание каждой функции и пошаговые инструкции по интерфейсу, который меняется ежемесячно.

В отраслевых системах, живущих десятилетиями, документация особенно ценна: через пять лет людей, помнящих причины решений, в команде уже не будет.

И правило: документация живёт рядом с кодом и правится тем же изменением.

IT Тюмень — t.me/itnews_tyumen
Этот пост опубликован в Telegram-канале IT Тюмень (@itnews_tyumen). Все его публикации — на странице канала.
Открыть в Telegram

Свежее в разделе «Сервисы и инфраструктура»

Все каналы раздела →

реклама в сети

Готовы запустить рекламу через сеть public.tg?

Новый оффер, продукт, GEO, кейс, событие или партнёрский запуск — соберём маршрут под задачу и отдадим медиаплан.

Telegram для медиаплана: @AFFtop_connect. Быстрый тест: $20 за канал, $1000 за пакет по сети.