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