Як написати технічне завдання для розробки (шаблон)

Більшість проєктів, що йдуть не так, ламаються не в коді. Вони ламаються в першому листі, коли «простий експорт у бухгалтерію» означав одне для того, хто писав, і зовсім інше для того, хто читав. Через шість тижнів праві обидва, і обидва незадоволені.

Щоб цього уникнути, не потрібна специфікація на сорок сторінок. Потрібні три короткі розділи, записані до того, як хтось напише перший рядок коду.

1. Що у вас є зараз

Опишіть вихідну точку такою, якою вона є сьогодні, а не якою має бути.

Системи, про які йдеться. «Інтернет-магазин на PHP 7.4, власний код. Бухгалтерія в Xero. Залишки — у таблиці, яку склад оновлює щовечора.»
Хто ними користується і наскільки активно. «Троє людей в офісі, близько 40 замовлень на день, у грудні вдвічі більше.»
Що болить. «Хтось вручну переносить кожне замовлення в Xero. Це година щодня, а помилки знаходяться наприкінці місяця.»

Знімки екрана допомагають. Так само як і нудні цифри: скільки товарів, скільки замовлень, скільки років серверу. Розробник, який знає, що на сервері PHP 7.4, не запропонує рішення під PHP 8.4, не попередивши вас.

2. Що це має робити

Тепер опишіть результат через те, що люди бачитимуть і робитимуть, а не через те, як це має бути побудовано.

Коли замовлення в магазині оплачене, рахунок з тими самими позиціями, цінами й ПДВ з’являється в Xero протягом п’яти хвилин. Якщо його не вдалося створити, офіс отримує лист з номером замовлення і причиною.

Це добре завдання. Зверніть увагу, чого в ньому немає: ні слова про API, черги, cron чи фреймворки. Це робота розробника. Ваша — бути точним щодо результату:

Назвіть граничні випадки, які ви вже знаєте. Повернення коштів. Замовлення, оплачені двома частинами. Клієнти з-поза ЄС. Товар, видалений після замовлення.
Скажіть, що не входить у завдання. «Синхронізація залишків не входить у це завдання.» «Не входить» — найкорисніша фраза в будь-якому завданні: саме на ній закінчується більшість суперечок, ще не почавшись.
Скажіть, що не має змінитися. «Оформлення замовлення має виглядати точно так само, як зараз.»

3. Як ви це перевірите

Цей розділ зазвичай пропускають, і саме він найважливіший. Запишіть до початку роботи, як ви вирішите, що її виконано.

«Робимо десять тестових замовлень, серед них одне повернення й одне замовлення зі Швейцарії. Усі десять правильно з’являються в Xero.»
«Вимикаємо зв’язок з Xero на годину. Офіс отримує по одному листу на кожне невдале замовлення, і після відновлення нічого не втрачено.»
«Людина, яка зараз переносить замовлення, тиждень цього не робить, і нічого не ламається.»

Це критерії приймання. Вони перетворюють «здається, працює» на «працює, і ось як ми це знаємо». А ще вони роблять ціну зрозумілішою: розробник, який бачить фініш, може сказати, скільки коштує дорога.

Чотири фрази, від яких починаються проблеми

«Як Amazon, тільки простіше.» Простіше в чому? Скажіть, які саме частини ви маєте на увазі.
«Має працювати швидко.» Наскільки швидко і де виміряно? «Сторінка товару завантажується на телефоні менш ніж за дві секунди» — це можна перевірити.
«Стандартні функції.» Стандартних функцій не буває. Перелічіть їх.
«Побачимо — зрозуміємо.» Зрозумієте, але лише після того, як заплатите за версії, що вам не сподобалися. Якщо ви справді ще не знаєте, так і скажіть і почніть з невеликого платного дослідження.

Коли не виходить написати самому

Іноді чесна відповідь на «що це має робити?» звучить як «ми ще не впевнені». Це нормально і трапляється часто. Тоді першою частиною роботи стає саме завдання: короткий етап дослідження, який закінчується трьома записаними розділами й ціною за решту. Він коштує небагато, і це найдешевша частина проєкту, яку варто зробити правильно.

Шаблон

Що є зараз
- Системи:
- Користувачі й обсяги:
- Що болить:

Що це має робити
- Результат, як його бачитимуть люди:
- Відомі граничні випадки:
- Не входить у завдання:
- Не має змінитися:

Як ми це перевіримо
- Тест 1:
- Тест 2:
- Готово, коли:

Скопіюйте його, заповніть і надішліть нам або будь-якому розробнику. Ви отримаєте кращу відповідь і кращу ціну від усіх.

Наша форма запиту питає про перші два розділи у двох питаннях. Почніть звідти.