IT Тольятти
IT Тольятти
@it_tolyatti

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

Её не пишут не из лени, а потому что непонятно, для кого: пишешь долго, читателя не видно.

Смените цель: не «описание системы», а ответы на вопросы, которые уже задавали. Спросил новичок, как запустить проект, — записали. Второй раз объясняете, почему здесь два похожих справочника, — записали. Через полгода получится документ, состоящий только из нужного.

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

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

Побочный эффект: человек, к которому приходят за знаниями, потому что он их однажды записал, получает влияние без всякой должности.

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

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

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

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

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

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

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