`CODEBASE_INVENTORY.md` — карта для розробника

README пояснює призначення проєкту та базовий запуск для читача. `CODEBASE_INVENTORY.md` має іншу роль: швидко показати внутрішню організацію, точки входу, команди, тести, ризикові зони та невивчені місця.

Inventory не повинен бути копією коду. Його цінність — у компактній навігації з доказами.

Рекомендована структура inventory
# CODEBASE_INVENTORY.md

## Стек і технології
## Основні частини системи
## Точки входу
## Запуск і перевірки
## Залежності між модулями
## Основні runtime-потоки
## Зони підвищеного ризику
## Відкриті запитання

Що зафіксувати в карті

  • мови, фреймворки та базу даних;
  • великі каталоги та їхню відповідальність;
  • HTTP-контролери, frontend entry points і фонові задачі;
  • команди запуску, збірки та тестування;
  • розташування тестів і конфігурацій;
  • ризикові місця та питання без підтвердження.

Пишіть про відповідальність, не про кожен метод

Слабкий описКорисний опис
orders/ містить 37 файлівorders/ відповідає за кошик і життєвий цикл замовлення
Є клас PaymentServicepayments/ обробляє оплату та повернення; повторне списання — ризикова зона
Є application.ymlКонфігурація визначає профілі, пороги або зовнішні адреси — потрібна перевірка використання

Чернетка, перевірка, редагування

  1. Попросіть Claude створити коротку чернетку за фіксованими розділами.
  2. Відкрийте згадані файли й перевірте наявність тверджень.
  3. Запустіть ключові команди та звірте результати.
  4. Позначте непідтверджені висновки.
  5. Скоротіть зайві подробиці й залиште корисні посилання.
  6. Оновлюйте inventory після суттєвих змін у проєкті.

Зони підвищеного ризику

Окремо виділіть ділянки, де помилка має високу ціну: платежі та повернення, міграції схеми, авторизацію, зовнішні інтеграції або код із неповним тестовим покриттям. Так inventory допомагає планувати наступне дослідження, а не лише орієнтуватися в папках.

Канонічне джерело уроку · JavaRush

Відкрити матеріал JavaRush