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