Англійська для написання ефективних квитків Jira
Написання квитків Jira, які виконують дії: чіткі заголовки, формат історії користувача, кроки відтворення, критерії прийняття і англійська фраза, яка усуває неоднозначність.
Тикет Jira — це маленький контракт: він говорить комусь, що слід створити і як ви дізнаєтеся, що це зроблено. Погано написаний квиток створює рядок пояснюючих коментарів, блокує відповідача і марнує час всіх. Зрозумілий англійською тут знижує час. У цьому підручнику показано, як написати запиту, за яким люди можуть діяти без запитів.
Починається з імені
Заголовок читається в списку з п’ятдесяти інших. Сделай его конкретным и сканируемым.
| Weak title | Strong title |
|---|---|
| ”Login broken" | "Login fails with 500 error when email contains a plus sign" |
| "Improve performance" | "Reduce dashboard load time from 4s to under 1s" |
| "Add feature" | "Add CSV export to the reports page” |
Хороший заголовок зазвичай містить дію і тему: * « Додати… » *, * « Виправити… » *, * « Розслідувати… » *.
Формат User-Story
Для роботи з функціональними можливостями класичний формат дозволяє зосередитись на значенні:
- « Як фінансовий менеджер, я хочу експортувати звіти у форматі CSV, щоб я міг проаналізувати їх у Excel. » *
Три частини відповідають на питання хто, що і чому. «Чому» є найбільш пропущеним і найкориснішим — це дозволяє розробнику приймати розумні рішення, коли деталі не ясні.
Шаблони фраз:
- “Як [роля], я хочу [здатність], щоб [вигода]”
- «Це потрібно, тому що…»
- «Цель — досягти…»
Запис кроків відтворення для помилок
Для запиту на помилку, чітко відокремте три речі: кроки, очікуваний результат, фактичний результат.
Кроки для відтворення:
- Європа Ввійти у систему як звичайний користувач. 2-й. Перейдіть до пункту меню Параметри → Облік. 3-й. Натисніть « Завантажити рахунок ».
- Нет, не надо ** Очікувалося: ** Звантаження рахунка у форматі PDF. ** Фактична: ** На сторінці показано порожній екран і записано помилку 500.
Пронумеровані кроки вилучають неоднозначність. Використовуйте теперішній час і наказовий час: * « Натиснути » *, * « Ввести » *, * « Перейти до » * — а не * « Я натиснув » *.
Критерії прийняття
Критерії прийняття визначають « зроблено ». Звичайним, зрозумілим для читання форматом є ** Given / When / Then **:
- ”** Якщо ** я є адміністратором, який увійшов до системи, ** коли ** я натискаю кнопку « Експортувати », ** тоді ** буде звантажено файл CSV, у якому містяться всі записи з поточного перегляду.” *
Або простой контрольний список:
- На сторінці звітів з’ явиться кнопка експортування.
- Файл містить всі видимі стовпчики.
- При експортуванні великих файлів (> 10 000 рядків) не настає перевищення часу очікування.
Без критеріїв прийняття, «зроблено» стає питанням думки — і ця думка буде відрізнятися між вами і розробником.
Фрази, що виключають неоднозначність
| Vague | Precise |
|---|---|
| ”It should be fast." | "The response should return in under 500ms at p95." |
| "Sometimes it breaks." | "It fails roughly 1 in 5 times on Safari." |
| "Make it look better." | "Match the design in the linked Figma file." |
| "Handle errors." | "Show a toast message ‘Upload failed, please retry’ on a 4xx response.” |
Числа, умови і посилання є ворогами неоднозначності.
Написання корисних коментарів
Під час оновлення квитка, напишіть так, щоб майбутні читачі розуміли його без контексту:
- “Оновлення: Я відтворив це на стажування. Це відбувається лише у разі, якщо локаль користувача встановлено на німецьку — схоже, це проблема з аналізом дати. Перепризначення до команди платформи.”*
Уникайте однослівних коментарів, таких як “зроблено” — скажіть що зроблено і що буде далі.
Оцінка і блокування флагів
“Це заблоковано TICKET-482 — ми не можемо запустити доки не існує кінцева точка API.” “Я б оцінив це приблизно в два дні, але є непевність навколо сторонньої інтеграції.”
Використовуйте * « заблоковано » * і * « блоки » * послідовно, щоб залежності були видимими на дошці.
Необхідно уникати помилок
- Введення розв’ язку у заголовок, якщо ви маєте намір описати проблему.
- Об’ єднання трьох не пов’ язаних між собою питань у одну заявку — розділити їх.
- Оставляя “почему” вне, вынуждая разработчиков догадаться намерение.
- Використання нечітких прикметників (“краще”, “швидше”, “чистіше”) без мети.
Перед початком перевірки необхідно перевірити ключ
- Заголовок говорить незнайомцю, що це за книга в одній рядку?
- Чи пронумеровані та відтворювані кроки відтворення?
- Чи можна перевірити критерії прийняття?
- “Чому” сказано?
- Чи включені блокувальники і посилання?
Відмінний квиток Jira — це акт поваги до часу ваших колег. Особливі назви, формат історії користувача, пронумеровані кроки репродукції і перевіряються критерії прийняття перетворюють нечіткий запит на щось дійсне. Написавши квитки таким чином, ви помітите, що гілки коментарів зменшуються, пересилання туди- назад зникає, а робота просто виконується.
Національна мова: мова, що використовується для спілкування між ненаціональними групами
Написання ефективного квитка Jira не просто про позначення квадратиків; це про те, щоб ваш запит був ідеально зрозумілий всім залученим - від розробника, призначеного для виправлення проблеми, до власника продукту, який визначає пріоритети роботи. Для розробників, чия перша мова не є англійською, це може бути особливо складним. Складність фразування, поширені ідіоми, і навіть здавалося б прості структури речень можуть створити плутанину. Давайте розглянемо деякі конкретні області, де носії мови, які не є рідними, часто стикаються з труднощами, зосереджуючись на створенні впевненості і ясності у вашому спілкуванні.
Одна з ключових областей - активний голос проти пасивного голосу. Пасивний голос не є по суті помилкою, але він може затемнити відповідальність. Замість того, щоб сказати « Про ваду повідомив користувач », що звучить трохи неоднозначно, скористайтеся фразою « Користувач повідомив про ваду ». Аналогічно, коли ви описуєте, що потрібно зробити, активний голос робить ваші запити більш прямими і дійсними. Розглянемо це повідомлення Slack: « Чи може хтось розслідувати, чому дані не оновлюється?» проти « Запрошується проведення розслідування з метою встановлення причини відсутності оновлення даних ». Останнє звучить менш терміново і менш чітко визначає відповідальність. Іншою поширеною пасткою є надмірна залежність від надто формальної мови. Для квитків Jira не потрібна шекспірівська проза; важлива чітка, коротка формулювання.
Крім того, зверніть увагу на * умовне формулювання *. Фрази типу «потрібен» або «можна поліпшити» можуть ввести невизначеність, що сповільнює процес. Замість « Звіт слід оновити з більшою кількістю відомостей », спробуйте « Будь ласка, оновіть звіт з більшою кількістю відомостей ». Останнє звучить більш вимогливо і вказує на ясне очікування. Аналогічно, уникайте нечітких термінів, таких як «незначна проблема». Коли це можливо, кількісно оцініть вплив – наприклад, «Це спричиняє 10% зниження залученості користувачів». Ці невеликі зміни можуть значно поліпшити розуміння і зменшити обмін інформацією. Пам’ ятайте, що ваша мета — вилучити неоднозначність; точність — це ключ.
І, нарешті, не вагайтеся просити про пояснення. Якщо ви не впевнені щодо терміну або фрази, використовуваних у квитку, ввічливо запитайте про пояснення. Просте повідомлення на зразок « Чи можете ви пояснити, що означає « крайній випадок » у цьому контексті? » демонструє вашу прихильність до розуміння і забезпечує, що всі знаходяться на одній сторінці. Створення культури відкритого спілкування приносить користь всім - включаючи носіїв рідної мови!