Issue Intake Note перетворює тикет на вхід для дослідження
Issue Intake Note — короткий проміжний документ між сирим тикетом і технічним розслідуванням. Його мета — не описати всю архітектуру, а зробити проблему зрозумілою без постійного повернення до issue.
Нотатка має показувати межі знань. Незаповнене питання або явно позначене припущення — корисніший результат, ніж упевнена, але непідтверджена причина.
| Поле | Що фіксувати |
|---|---|
| Проблема | Що ламається або чого бракує |
| Вплив | Хто стикається з проблемою та які наслідки |
| Підтвердження | Кроки відтворення, логи, скриншоти, stack trace |
| Вимоги | Яку спостережувану поведінку потрібно отримати |
| Припущення | Правдоподібні, але ще не доведені твердження |
| Відкриті питання | Що потрібно уточнити до планування |
| Поза межами | Що навмисно не входить до цієї задачі |
| Ризики | Які контракти, інтеграції або сценарії можна зачепити |
Факт, причина, вимога та пропозиція — різні речі
- Симптом — те, що можна спостерігати, наприклад серверна помилка на конкретному input.
- Причина — висновок, підтверджений дослідженням; згаданий у тикеті файл спочатку є лише гіпотезою.
- Вимога — потрібний результат системи, а не назва класу чи методу для зміни.
- Припущення — твердження, яке потребує перевірки, навіть якщо воно здається очевидним.
- Пропозиція автора — корисна стартова ідея, але не обовʼязкове технічне рішення.
Приклад intake для checkout
У цьому шаблоні гіпотеза про total calculation не видається за доведену причину. Відкритий контрактне питання також не закривається вигаданим статусом: його потрібно перевірити в коді, тестах або вимогах.
Problem: empty items list causes a server error
Impact: customer cannot complete checkout
Evidence: reproducible request and service-layer trace
Requirement: handle the state predictably without a server crash
Hypothesis: total calculation reads an absent first item
Open question: expected API status and error body
Out of scope: checkout redesign and non-empty orders
Risk: clients may depend on the current error format Підготовка intake до plan mode
- Прочитайте issue, коментарі, labels і вкладення.
- Витягніть спостережувані факти без технічних висновків.
- Запишіть вплив і кроки відтворення.
- Відокремте вимоги, припущення та запропонований у тикеті фікс.
- Додайте non-goals, відкриті питання та ризики.
- Перевірте, що наступний інженер зрозуміє проблему без усного пояснення.
Перевірка готовності нотатки
- Проблема описана через спостережувану поведінку.
- Користувацький або системний вплив зрозумілий.
- Докази не змішані з припущеннями.
- Межі задачі та основні ризики позначені.
- Невідомі питання названі прямо.
- Є зрозумілий наступний крок: read-only investigation.
Канонічне джерело уроку · JavaRush
Відкрити матеріал JavaRush