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