Napište zadání pro agenta

Popište změnu, kterou lze posoudit

„Přidat export zákazníků“ ponechává několik otevřených rozhodnutí. Kdo smí záznamy exportovat? Které záznamy a pole mají být zahrnuty? Co se stane, když požadavek selže? Agent může mezery doplnit věrohodnými volbami. Pro firmu však mohou být nesprávné.

Začněte uživatelem a problémem. Potom popište požadované chování. Zahrňte důkazy, které ukážou, zda je výsledek přijatelný.

Zadání má omezit nejistotu, aniž určí každou vnitřní konstrukční volbu. Stanovte požadovanou hranici dat. Pokud není důvod ke změně, nechte implementaci použít existující vzory repozitáře.

Použijte konkrétní příklad

Následující zadání se týká fiktivní aplikace zákaznické podpory. Jde o výukový příklad, nikoli úplnou produkční specifikaci.

Výsledek: Vedoucí podpory může stáhnout seznam zákazníků.
Uživatel: Manažer v aktuální organizaci.
Data: Pouze aktivní zákazníci této organizace.
Pole: ID zákazníka, název firmy a stav účtu.
Formát: UTF-8 CSV s řádkem záhlaví.
Zamítnutý požadavek: Vrátit existující autorizační chybu.
Prázdný výsledek: Vrátit platné CSV pouze se záhlavím.
Rozsah: Použít existující cestu exportu a vzor auditního záznamu.
Vyloučeno: Žádné nové role, závislosti ani nasazení.
Důkazy: Testy povolených, zamítnutých, prázdných požadavků a požadavků na jinou organizaci.

Toto zadání vymezuje užitečné chování a hranice. Odhaluje také další otázky. Má systém omezovat velikost exportu? Může pole obsahovat vzorec tabulkového procesoru? Kdo má přístup k auditnímu záznamu? Důležité otázky vyřešte před implementací. Nepovažujte příklad za univerzální kontrolní seznam.

Oddělte požadavky od předpokladů

Požadavek určuje chování, které změna musí splnit. Předpoklad je informace, kterou jste ještě neověřili. Udržujte je oddělené.

Například „Použít existující vzor auditního záznamu“ předpokládá, že vhodný vzor existuje. Požádejte agenta, aby jej našel. Pokud v repozitáři není, má agent ohlásit chybějící závislost dříve, než vymyslí nový auditní systém.

Omezení může být také v rozporu s výsledkem. Existující cesta může záměrně vracet všechny organizace. Agent má rozpor ukázat a navrhnout omezenou opravu. Nesmí mlčky odstranit hranici dat ani rozšířit úkol na přepis architektury.

Zahrňte důkazy do dokončení

Vyžádejte si shrnutí dodávky, které vysvětlí výsledné chování, změny rozsahu a provedené kontroly. Tam, kde na tom záleží, požadujte přesné příkazy a výsledky. Odlište úspěšnou kontrolu od kontroly, kterou nebylo možné spustit.

Pull request má zachovat důvod změny. Pozdější správce může vidět kód bez původní konverzace. Doplňte dostatek kontextu k vysvětlení, proč export vynechává určitá pole a jak se vynucuje přístup.

Pokyny Googlu pro popis změn jsou užitečnou referencí. Popis má vysvětlovat změnu a její účel. Po úpravách z kontroly jej udržujte v souladu s konečnou implementací.

Přizpůsobte zadání rozsahu

Drobná oprava textu může mít krátké zadání. Export dat potřebuje více podrobností, protože jeho selhání může odhalit informace. Nový platební postup vyžaduje ještě důkladnější analýzu a kontrolu.

Kvalitu zadání neměřte délkou. Ptejte se, zda by kompetentní kontrolující dokázal odlišit správný výsledek od nesprávného. Pokud by se dvě rozumné implementace lišily v důležitém chování, nejdříve je vyjasněte.