Больше в моем канале - https://t.me/north_spb_metric

Несколько холливарный вопрос, но прям хочется его обсудить. Итак, делать ли документацию на дашборды или нет? Я слышал много разных мнений, в том числе и от уважаемых экспертов, которые говорили “да зачем, все равно документацию никто не читает”. Возможно и не читает, но уж поверьте, не никто.

Ситуация 1 - вы вышли на новую работу, есть, ну допустим 3 дашборда, которыми активно пользуются и вы теперь за них ответственные. И вдруг дашборды начинает показывать другую информацию, отличную от той, которая была ранее. Что будете делать? 1. Ищем документацию 2. Если ее нет, ищем ответственного аналитика 3. Если его нет, делаем реверс инжиниринг 4. Вы великолепны Сколько это займет времени? Без понятия, в зависимости от сложности ошибки, может и на пару недель время растянется, при этом данные все это время будут неверные. А вот была бы документация, она бы сократила время. Конечно, невозможно все описать в ней, но ХОТЯ БЫ АВТОРА ДАШБОРДА ТО МОЖНО УКАЗАТЬ, так можно сразу понять к кому идти (или к кому не идти)

Ситуация 2 - вы вышли на работу, но теперь вы продакт. Открываете дашборд по своему продукту и ничего не понимаете. Ну, вернее понимаете, но где гарантии, что ваше понимание верное? Что будете делать? Лично для меня алгоритм похожий, разве что на 3 пункте я бы сказал “у меня лапки, нужна встреча для объяснения дашборда”. Может ли документация решить ситуацию? На какое-то количество процентов разумеется.

Ситуация 3 - вы аналитик, сделали дашборд. И думаете, надо ли делать документацию. Понятно, что финальное решение зависит от опыта/процессов/загруженности. Но лично я бы сделал, по нескольким причинами: 1. Оформление документации позволяет еще раз вам проверить дашборд на логичность и адекватность 2. Это снижает количество встреч, которые будут ставить вам для разговора о дашборде. Потому что при грамотной документации 80% вопросов отпадают сразу. А на остальные 20% документация не ответит)) 3. Это упрощает онбординг новичков, ну правда же. Зашел, посмотрел описание, почитал, осознал и пошел работать. 4. Если дашборд перейдет в ответственность другому человеку, ему опять же будет проще с ним разобраться.

Давайте проясним, я не говорю, что нужно описывать все подчистую (хотя по мне основные 2-3 дашборда должны быть описаны на 100%). Я сам в свое время не понимал, зачем нужна документация (и такое было, да). Плюс, сейчас есть AI, процесс создания документации сокращается, нужно лишь быть аккуратным. А если дашборд сложный, то документация мастхев, иначе зачем вы делаете то, чем другие не могут воспользоваться?

Производители техники, машин, самолетов ведь делают документацию, верно? Понятно, что не все их читают, понятно что не всякая документация отвечает на 100% вопросов, но если вы хоть раз читали документацию, то понимаете о чем я))

Так что по-братски, не забывайте про документацию, хотя бы краткую