Галоўнае

Пішыце патрабаванні праз назіраныя паводзіны: хто, пры якіх умовах і што атрымлівае ў выніку. Дадавайце негатыўныя сцэнарыі, Definition of Done, доказы запуску і асобныя правілы для гарантыі, падтрымкі і развіцця.

Дрэннае ТЗ бывае і на дзве старонкі, і на дзвесце. Аб'ём не вырашае галоўнай праблемы: заказчык апісвае жаданую функцыю, падрадчык дабудоўвае дзясяткі рашэнняў у галаве, а разыходжанне выяўляецца на прыёмцы.

Добрае ТЗ не спрабуе прадказаць кожную кнопку на год наперад. Яно фіксуе мэту, межы, правяральныя паводзіны і правілы змены.

Пачніце з выніку, а не тэхналогіі

Замест «распрацаваць сістэму з мікрасэрвіснай архітэктурай і AI»:

Менеджар апрацоўвае ўваходную заяўку з формы і Telegram у адной чарзе, не стварае дублікат пры паўторнай адпраўцы і бачыць крыніцу звароту. Кіраўнік вымярае час да першага адказу.

Тут зразумелыя карыстальнік, працэс, абарона ад памылкі і метрыка. Архітэктура з'явіцца пасля аналізу нагрузкі, інтэграцый і каманды.

Мінімальная структура працоўнага ТЗ

1. Кантэкст і мэта

Як працэс працуе цяпер, што не задавальняе, хто ўладальнік, які baseline і які вынік патрэбны.

2. Scope і out of scope

Што ўваходзіць у першую пастаўку і чаго там свядома няма. Out of scope абараняе абодва бакі лепш за фразу «і іншыя функцыі пры неабходнасці».

3. Карыстальнікі і ролі

Не проста «адміністратар» і «карыстальнік», а дазволеныя рэсурсы і дзеянні. Для кожнага сцэнарыя ўкажыце, ад чыйго імя ён выконваецца.

4. Сцэнарыі

Трыгер, перадумовы, асноўны паток, выключэнні, выніковы стан. GOV.UK прапануе user story як кароткую фармулёўку патрэбы карыстальніка, але сама story не замяняе acceptance criteria.

5. Даныя

Крыніца, уладальнік, фармат, якасць, тэрміны захоўвання, міграцыя, выдаленне і правы. Для AI — якія даныя дазволена перадаваць мадэлі і выкарыстоўваць у eval.

6. Інтэграцыі

API, версія, sandbox, ліміты, аўтэнтыфікацыя, timeout, retry, idempotency і паводзіны пры недаступнасці.

7. Нефункцыянальныя патрабаванні

Даступнасць, latency, аб'ём, бяспека, accessibility, аўдыт, backup, RTO/RPO, падтрымліваемыя браўзеры і прылады.

8. Прыёмка і эксплуатацыя

Тэставыя даныя, асяроддзе, адказныя, доказы, Definition of Done, навучанне, дакументацыя, гарантыя і SLA.

ISO/IEC/IEEE 29148 апісвае працэсы і змест requirements engineering. Не абавязкова ператвараць невялікі праект у цяжкую працэдуру, але карысны базавы прынцып стандарту: патрабаванне павінна быць адназначным, неабходным, ажыццяўляльным, правяральным і адсочвальным.

Як пісаць acceptance criteria

Крытэрый павінен даваць назіраны pass/fail.

Дрэнна:

Сістэма хутка адпраўляе апавяшчэнне і карэктна апрацоўвае памылкі.

Лепш:

Пасля стварэння заяўкі з валіднымі данымі сістэма на працягу 60 секунд стварае адно апавяшчэнне менеджару. Паўтор запыту з тым жа submission_id не стварае другой заяўкі. Калі сэрвіс апавяшчэнняў недаступны, заяўка захоўваецца, задача адпраўкі застаецца ў чарзе, а памылка бачная ў маніторынгу без персанальных даных.

У добрым крытэрыі ёсць умова, дзеянне, вымерны вынік і паводзіны пры збоі. Указаныя 60 секунд і захаванне ў чарзе — прыклад патрабаванняў для ўзгаднення, а не апісанне кожнага праекта CENTURY.

Не забудзьцеся пра негатыўныя крытэрыі

Функцыя лічыцца гатовай не толькі калі дазволенае дзеянне працуе, але і калі забароненае не працуе.

  • Карыстальнік ролі A не бачыць запісаў ролі B.
  • Файл забароненага тыпу не трапляе ў працоўнае сховішча.
  • Паўтор плацежнага callback не змяняе баланс двойчы.
  • Агент не адпраўляе ліст без пацвярджэння.
  • RAG не выкарыстоўвае дакумент пасля адклікання права.
  • Памылка API не раскрывае stack trace і сакрэт.

Definition of Done шырэйшае за acceptance criteria

Acceptance criteria адносяцца да канкрэтнай функцыі. Definition of Done — агульны gate для любога элемента: review, тэсты, дакументацыя, security checks, deployability, monitoring і адсутнасць вядомых крытычных дэфектаў.

У DoD можна ўключыць:

  • код прайшоў review і знаходзіцца ў рэпазіторыі заказчыка або ўзгодненым контуры;
  • аўтаматычныя праверкі прайшлі;
  • міграцыя і rollback пратэставаныя;
  • новыя логі не змяшчаюць сакрэтаў;
  • dashboards і alerts створаныя;
  • інструкцыя падтрымкі абноўленая;
  • функцыя правераная ва ўзгодненым асяроддзі;
  • вынік паказаны ўладальніку працэсу.

Важна раздзяляць доказы: лакальныя тэсты, CI, staging, deployment і live-праверка — розныя этапы. Адзін не падмяняе іншы.

Як прымаць AI-функцыю

Фраза «адказ павінен быць дакладным» не правяраецца. Патрэбны versioned eval-набор:

  • рэальныя тыпы задач;
  • чаканыя крыніцы;
  • дапушчальная адмова;
  • забароненыя tool calls;
  • ролі карыстальнікаў;
  • rubrics якасці;
  • бюджэты latency і кошту.

Агульны score не павінен кампенсаваць уцечку праз парушэнне права або крытычнае дзеянне. Такія памылкі — асобны blocker.

Змены — частка ТЗ

Патрабаванні зменяцца. Зафіксуйце працэс:

  1. хто прапануе змену;
  2. як ацэньваецца ўплыў на тэрмін, цану і рызыкі;
  3. хто прымае рашэнне;
  4. якая версія патрабаванняў становіцца актыўнай;
  5. што адбываецца з ужо выкананай працай.

Гэта карысней за абяцанне «працуем гнутка», якое кожны бок разумее па-свойму.

Гарантыя, падтрымка і развіццё

Раздзяліце тры паняцці да падпісання акта.

Гарантыя: выпраўленне паводзін, якія не адпавядаюць зацверджаным патрабаванням і крытэрыям.

Падтрымка: рэакцыя на інцыдэнты, маніторынг, аднаўленне і ўзгодненыя аперацыйныя работы паводле SLA.

Развіццё: новыя сцэнарыі і змена патрабаванняў.

У SLA ўкажыце гадзіны, каналы, узроўні крытычнасці, час рэакцыі/аднаўлення, выключэнні, эскалацыю і справаздачнасць. Не абяцайце 24/7, калі дзяжурнай каманды няма.

Пакет прыёмкі

Да фіналу этапу заказчык атрымлівае не толькі інтэрфейс:

  • спасылку на версію патрабаванняў;
  • release notes;
  • вынікі acceptance і security checks;
  • вядомыя абмежаванні;
  • інструкцыі запуску і rollback;
  • схему даных і інтэграцый;
  • доступы, перададзеныя ўзгодненым уладальнікам;
  • monitoring/support runbook;
  • экспарт або міграцыйны пакет, калі ён уваходзіць у этап.

Юрыдычныя фармулёўкі аб інтэлектуальных правах, канфідэнцыяльнасці, персанальных даных і афармленні актаў павінны быць узгодненыя ў дагаворы з улікам актуальнага беларускага права. Гэты артыкул апісвае інжынерную прыёмку і не замяняе юрыдычную праверку.

Апошняя праверка перад стартам

Дайце ТЗ чалавеку, які не ўдзельнічаў у сустрэчах, і папрасіце адказаць:

  • які бізнес-вынік патрэбны;
  • што дакладна ўваходзіць і не ўваходзіць;
  • як паводзяць сябе тры галоўныя сцэнарыі і памылкі;
  • якія даныя і сістэмы ўдзельнічаюць;
  • што будзе паказана на прыёмцы;
  • хто падтрымлівае прадукт пасля запуску.

Калі адказы даводзіцца аднаўляць з перапіскі, ТЗ яшчэ не гатовае. Выправіць гэта да распрацоўкі танней, чым у апошні тыдзень праекта.

Параўнанне

Што павінна быць у ТЗ

РаздзелПравяральнае пытанне
Мэта і scopeЯкі працэс змяняем і чаго няма ў першай версіі?
Ролі і даныяХто што бачыць, змяняе, захоўвае і выдаляе?
ІнтэграцыіШто пры timeout, паўторы, недаступнасці і міграцыі?
ПрыёмкаЯкі pass/fail вынік пакажам уладальніку?

Што праверыць

Крытэрыі гатоўнасці

  1. Асноўныя і негатыўныя сцэнарыі маюць pass/fail крытэрыі.
  2. Правы, паўторы, памылкі і recovery правераныя.
  3. CI, security checks, міграцыя і rollback даюць доказ.
  4. Дакументацыя падтрымкі, маніторынг і доступы перададзеныя.
  5. Гарантыя, SLA і развіццё раздзеленыя ў дамоўленасцях.

Як мы падыходзім да задачы

CENTURY раздзяляе лакальныя тэсты, CI, staging, deploy і live-праверку: гэта розныя доказы гатоўнасці. Той жа прынцып ляжыць у аснове ТЗ — вынік этапу павінен быць назіраным і ўзнаўляльным.

Крыніцы і спасылкі