Документация в распределённой команде — не бюрократия, а способ работать

Документация в распределённой команде — не бюрократия, а способ работать

Когда все сидят в одной комнате, недостаток документации компенсируется разговорами. Когда команда разбросана, каждая незаписанная договорённость превращается в переписку на два дня.

Что писать в первую очередь. Как запустить проект у себя. Как выкатить изменение. Что делать при типичных сбоях. Кто за что отвечает. Почему приняли ключевые решения — именно этот пункт спасает от бесконечного возвращения к спорам, которые уже закрывали.

Как писать, чтобы читали. Коротко. Ответами на реальные вопросы, а не общим описанием. Рядом с кодом, а не в отдельной вселенной, куда никто не заглядывает. С датой и автором, чтобы было понятно, насколько это устарело.

Простое правило: если вы объяснили что-то дважды в переписке — на третий раз запишите и дайте ссылку. Через полгода у вас соберётся документ, состоящий только из нужного.

И заметьте побочный эффект: в распределённой команде человек, который пишет понятные тексты, становится заметным и влиятельным быстрее остальных.

IT Сочи — t.me/itnews_sochi