Вы пришли на новый проект и что же первым вам выдадут заботливые коллеги для начала погружения? Правильно, несколько документов со словами «Вот, почитай, что не понятно потом спрашивай.». И тут по вашей спине должен пробежать холодок, потому что вы вспомнили как читали такой документ, перечитывая разделы снова и снова успокаивая себя, что дальше будет понятнее, но увы.
Некоторые из вас скажут, что это нормально, и не нужно чувствовать себя никчемным, потому что не поняли документ с первого раза, и для погружения нужно больше времени и документов. И вы будете правы, но я хочу остановиться на документации и почему она так важна для становления специалиста.
Я пришел на свой первый проект и только спустя несколько лет я понял как мне тогда повезло. Отличительной чертой проекта было то, что все процессы были заботливо описаны аналитиками в документации, разработчиками в системе, тестировщиками прописаны все возможные сценарии.
Последующие проекты оказались самыми типичными в отношении к документации. В лучшем случае описано только первое ТЗ по первому MVP, так что по сути потомкам не оставили никаких артефактов.
Подобное не понимание важности документации приводит к некоторым очевидным и не очень последствиям:
Никогда не знаешь ASIS.
Увеличенные трудозатраты на задачи.
Приходится выделять больше времени на поиски информации и тех кто знает и главное готов рассказать то что нигде не описано.«Наша песня хороша начинай сначала»
Выше необходимость снова изучать один и тот же процесс. Высока вероятность что либо ты в прошлый раз не все узнал или за это время кто-то доработал процесс и ты снова не в курсе изменений.Цена ошибки высока.
Некоторые критически важные условия выявляются только на поздних этапах реализации. Что означает высокую стоимость ошибки. И вы никогда не сможете предугадать сколько будет ошибок случившихся, только потому, что о них нигде не было и слова, а люди не могу знать всего.
На выходе мы получаем проект, с частыми багами, выявленными на более поздних этапах, сотрудниками, которые никогда до конца не уверены что предусмотрели все условия поведения системы. И самое печально быстрое выгорание и усталость от такой работы, когда ни в чем нельзя быть уверенным.
В ином случае, когда на проекте присутствует культура ведения документации, то наблюдаются самые неожиданные плюсы:
Есть понимание ASIS
Самостоятельность.
Со временем погружения в проект необходимость консультироваться с коллегами снижается.Рост компетенций
Все больше времени отводится на обсуждение решения интересных задач.Команда с вам надолго.
Наличие качественной документации может стать важной причиной для сотрудника не покидать проект. Ведь в большом и страшном мире он может оказаться на совсем другом проекте и захочет вернуться к вам обратно.Заменяемость.
Знания не распределены по людям и их уход с проекта будет не так чувствителен.
На таком проекте куда проще найти информацию ASIS и реализовывать TODO с меньшими рисками пропустить важную особенность системы. Доступна информация по новым доработкам системы, которые могли внести за то время пока вы не работали с той или иной частью функционала.
Путь пренебрежения к документации начинается со слов «Потом опишем, сейчас не до этого» только вот это "потом" не приходит и все начинает заваливаться. Или так «Да кому нужна эта документация, мы и так тратим много времени на ее описание». Только вот потом будет куда сложнее выделить достаточно ресурсов для актуализации процессов проекта.
Не забывайте о важности документации и не ленитесь ее писать, когда вы нашли что-то не описанное. Поверьте, это окупается и в личном росте и проектной, а значит командной работе.
