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