Napíšte zadanie pre agenta

Opíšte zmenu, ktorú možno posúdiť

„Pridať export zákazníkov“ necháva viacero rozhodnutí otvorených. Kto môže exportovať záznamy? Ktoré záznamy a polia sa zahrnú? Čo sa stane pri zlyhaní požiadavky? Agent môže tieto medzery vyplniť vierohodnými voľbami. Pre podnikanie však stále môžu byť nesprávne.

Začnite používateľom a problémom. Potom opíšte požadované správanie. Zahrňte dôkazy, ktoré ukážu, či je výsledok prijateľný.

Zadanie má znižovať neistotu bez určenia každého vnútorného návrhového rozhodnutia. Uveďte požadovanú hranicu údajov. Nechajte implementáciu používať existujúce vzory repozitára, pokiaľ nie je dôvod ich meniť.

Použite konkrétny príklad

Nasledujúce zadanie je pre fiktívnu aplikáciu podpory. Je to vzdelávací príklad, nie úplná produkčná špecifikácia.

Výsledok: Manažér podpory si môže stiahnuť zoznam zákazníkov.
Používateľ: Manažér v aktuálnej organizácii.
Údaje: Iba aktívni zákazníci tejto organizácie.
Polia: ID zákazníka, názov spoločnosti a stav účtu.
Formát: UTF-8 CSV s riadkom hlavičky.
Zamietnutá požiadavka: Vrátiť existujúcu autorizačnú chybu.
Prázdny výsledok: Vrátiť platný CSV iba s hlavičkou.
Rozsah: Použiť existujúcu route exportu a vzor auditu.
Vylúčené: Žiadne nové roly, závislosti ani nasadenie.
Dôkazy: Testy povolených, zamietnutých, prázdnych a medziorganizačných požiadaviek.

Toto zadanie určuje užitočné správanie a hranice. Zároveň odhaľuje ďalšie otázky. Má systém obmedzovať veľkosť exportu? Môže pole obsahovať vzorec tabuľkového procesora? Kto má prístup k auditnému záznamu? Otázky so závažnými dôsledkami vyriešte pred implementáciou. Príklad nepovažujte za univerzálny kontrolný zoznam.

Oddeľte požiadavky od predpokladov

Požiadavka určuje správanie, ktoré zmena musí spĺňať. Predpoklad je fakt, ktorý ste ešte neoverili. Udržiavajte ich oddelené.

Napríklad „Použite existujúci vzor auditu“ predpokladá, že vhodný vzor existuje. Požiadajte agenta, aby ho našiel. Ak v repozitári nie je, agent má nahlásiť chýbajúcu závislosť skôr, než vymyslí nový auditný systém.

Obmedzenie môže byť aj v rozpore s výsledkom. Existujúca route môže zámerne vracať všetky organizácie. Agent má ukázať rozpor a navrhnúť obmedzenú opravu. Nemá potichu odstrániť hranicu údajov ani rozšíriť úlohu na prepis architektúry.

Zahrňte dôkazy do dokončenia

Vyžiadajte si súhrn dodania, ktorý vysvetlí konečné správanie, zmenený rozsah a vykonané kontroly. Tam, kde je to dôležité, požadujte presné príkazy a výsledky. Rozlišujte kontrolu, ktorá uspela, od kontroly, ktorú nebolo možné spustiť.

Pull request má zachovať dôvod zmeny. Budúci správca môže vidieť kód bez pôvodnej konverzácie. Zahrňte dostatok kontextu na vysvetlenie, prečo export vylučuje konkrétne polia a ako sa vynucuje prístup.

Pokyny Googlu na opis zmien sú užitočnou referenciou pre tento záznam. Opis má vysvetliť zmenu a jej účel. Po úpravách z kontroly udržiavajte záznam v súlade s konečnou implementáciou.

Prispôsobte zadanie rozsahu

Malá oprava textu môže mať krátke zadanie. Export údajov potrebuje viac detailov, pretože jeho zlyhania môžu odhaliť informácie. Nový platobný proces potrebuje ešte viac analýzy a kontroly.

Kvalitu zadania nemerajte dĺžkou. Pýtajte sa, či by kompetentná kontrolujúca osoba dokázala odlíšiť správny výsledok od nesprávneho. Ak by sa dve rozumné implementácie líšili v správaní so závažnými dôsledkami, najprv toto správanie objasnite.