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