Приходишь на проект. В чатах пара десятков незнакомых имён, Иван и Ivan — это разные люди. В конфлюенсе 100 страниц, половина из которых
Черновик с датой редактирования до нашей эры. В сваггере зоопарк эндпойнтов без описаний, и единственный человек, который "всё знает", занят срочной задачей и просил не беспокоить.Сталкивались с подобным?
На одном из первых проектов у меня был огромный монолит, который пилили уже лет 10. Сваггера и документации у него не было 💻
По моим наблюдениям у каждого свой способ, с чего начать.
❤️ Кто-то первым делом ныряет в сваггер и как следует разбирается, что там уже есть в API.
🧡 Кто-то сразу подключает софт-скиллы и устраивает мини-интервью всем участникам команды, до которых удастся дотянуться.
💚 Кто-то сначала штудирует все имеющиеся доки в Confluence.
💜 Кто-то вообще не парится: “Мне дали таску — я делаю, в остальное не лезу”.
А я начинаю с базы данных.
Когда разбираюсь со структурой БД, в голове складывается картинка. Какие сущности основные для этого сервиса, как они связаны, какие данные содержат. А дальше и код, и API, и разговоры с командой становятся в разы понятнее.
Потому что я видела:
🥹 документацию, которая расходилась с фактическим состоянием дел
🐱 документацию, которая отставала от релизов на полгода
🥹 проекты без документации
🐱 REST API, в котором часть эндпойнтов задепрекейтили и заменили на новые, но никаких пометок об этом не было, как говорится “кто знает — тот знает” 👍
Поэтому для меня база — это самая наглядная часть проекта. Если, конечно, в ней понятные названия таблиц и полей. База не расходится с проектом, она не заброшена пятью релизами назад из-за срочных задач.
Видела ситуацию, когда DBA ориентировался в проекте лучше аналитиков и разработчиков, потому что все ключевые процессы продукта были завязаны на БД. Без хранимок и триггеров.
Лучше базы может быть только QA, который тоже шарит в базе 😃 Эти ребята по уровню погруженности в продукт обычно всех за пояс заткнут.
Поэтому я стараюсь сначала вникнуть в БД, а дальше смотрю код, читаю доки, задаю вопросы.
А вы сталкивались с сюрпризами в документации?