Напішыце заданне для агента

Апішыце змену, якую рэцэнзент можа ацаніць

«Дадаць экспарт даных кліентаў» пакідае некалькі рашэнняў адкрытымі. Хто можа экспартаваць запісы? Якія запісы і палі ўключаны? Што адбываецца пры няўдалым запыце? Агент можа запоўніць гэтыя прабелы праўдападобнымі рашэннямі. Яны ўсё роўна могуць быць няправільнымі для бізнесу.

Пачніце з карыстальніка і праблемы. Затым апішыце патрэбныя паводзіны. Уключыце доказы, якія пакажуць, ці прымальны вынік.

Заданне павінна памяншаць нявызначанасць, не фіксуючы кожны выбар унутранай канструкцыі. Укажыце неабходную мяжу даных. Няхай рэалізацыя выкарыстоўвае наяўныя падыходы рэпазіторыя, калі няма прычыны іх змяняць.

Выкарыстоўвайце канкрэтны прыклад

Наступнае заданне прызначана для выдуманай праграмы падтрымкі. Гэта навучальны прыклад, а не поўная спецыфікацыя для production.

Вынік: Кіраўнік службы падтрымкі можа спампаваць спіс кліентаў.
Выканаўца: Кіраўнік у бягучай арганізацыі.
Даныя: Толькі актыўныя кліенты гэтай арганізацыі.
Палі: ID кліента, назва кампаніі і стан уліковага запісу.
Фармат: UTF-8 CSV з радком загалоўкаў.
Забаронены запыт: Вярнуць наяўную памылку аўтарызацыі.
Пусты вынік: Вярнуць карэктны CSV толькі з загалоўкам.
Абсяг: Выкарыстаць наяўны маршрут экспарту і падыход да аўдыту.
Выключана: Без новых роляў, залежнасцей або разгортвання.
Доказы: Тэсты для дазволеных, забароненых, пустых запытаў і запытаў да іншай арганізацыі.

Гэтае заданне вызначае карысныя паводзіны і межы. Яно таксама выяўляе далейшыя пытанні. Ці павінна сістэма абмяжоўваць памер экспарту? Ці можа поле змяшчаць формулу электроннай табліцы? Хто можа атрымаць доступ да аўдытнага запісу? Вырашыце пытанні з істотнымі наступствамі перад рэалізацыяй. Не лічыце гэты прыклад універсальным кантрольным спісам.

Аддзяляйце патрабаванні ад дапушчэнняў

Патрабаванне вызначае паводзіны, якім павінна адпавядаць змена. Дапушчэнне — факт, які вы яшчэ не праверылі. Трымайце іх асобна.

Напрыклад, «выкарыстаць наяўны падыход да аўдыту» дапускае, што адпаведны падыход існуе. Папрасіце агента знайсці яго. Калі ў рэпазіторыі яго няма, агент павінен паведаміць пра адсутную перадумову перад стварэннем новай сістэмы аўдыту.

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

Уключайце доказы ва ўмову завяршэння

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

Pull request павінен захоўваць прычыну змены. Будучы спецыяліст па суправаджэнні можа ўбачыць код без першапачатковай размовы. Дадайце дастаткова кантэксту, каб растлумачыць, чаму экспарт выключае пэўныя палі і як забяспечваюцца правілы доступу.

Рэкамендацыі Google па апісанні змен карысныя для такога запісу. Апісанне павінна тлумачыць змену і яе мэту. Пасля выпраўленняў падчас праверкі прыводзьце запіс у адпаведнасць з канчатковай рэалізацыяй.

Суадносьце падрабязнасць задання з задачай

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

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