Napišite opis naloge za agenta

Opišite spremembo, ki jo pregledovalec lahko oceni

»Dodajte izvoz podatkov strank« pušča odprtih več odločitev. Kdo lahko izvozi zapise? Kateri zapisi in polja so vključeni? Kaj se zgodi, če zahteva ne uspe? Agent lahko te vrzeli zapolni z verjetnimi odločitvami. Te so lahko za poslovanje še vedno napačne.

Začnite z uporabnikom in težavo. Nato opišite zahtevano delovanje. Vključite dokazila, ki bodo pokazala, ali je rezultat sprejemljiv.

Opis naj zmanjša negotovost, ne da bi določil vsako odločitev o notranji zasnovi. Določite zahtevano mejo podatkov. Izvedba naj uporablja obstoječe vzorce repozitorija, razen če obstaja razlog za njihovo spremembo.

Uporabite konkreten primer

Naslednji opis je namenjen izmišljeni aplikaciji za podporo. Je učni primer, ne popolna specifikacija za produkcijo.

Rezultat: Vodja podpore lahko prenese seznam strank.
Vloga: Vodja v trenutni organizaciji.
Podatki: Samo aktivne stranke te organizacije.
Polja: ID stranke, ime podjetja in stanje računa.
Oblika: CSV v kodiranju UTF-8 z vrstico glave.
Zavrnjena zahteva: Vrnite obstoječo napako avtorizacije.
Prazen rezultat: Vrnite veljaven CSV samo z glavo.
Obseg: Uporabite obstoječo pot izvoza in vzorec revizijskega beleženja.
Izključeno: Brez novih vlog, odvisnosti ali namestitve.
Dokazila: Testi dovoljenih, zavrnjenih, praznih zahtev in zahtev za drugo organizacijo.

Ta opis določa uporabno delovanje in omejitve. Odkrije tudi dodatna vprašanja. Ali mora sistem omejiti velikost izvoza? Ali lahko polje vsebuje formulo preglednice? Kdo sme dostopati do revizijskega zapisa? Pomembna vprašanja razrešite pred izvedbo. Primera ne obravnavajte kot splošnega kontrolnega seznama.

Ločite zahteve od predpostavk

Zahteva določa delovanje, ki ga mora sprememba zagotoviti. Predpostavka je dejstvo, ki ga še niste preverili. Ločite ju.

Na primer: »Uporabite obstoječi vzorec revizijskega beleženja« predpostavlja, da ustrezen vzorec obstaja. Agent naj ga poišče. Če ga v repozitoriju ni, mora agent opozoriti na manjkajoči predpogoj, preden si izmisli nov revizijski sistem.

Omejitev je lahko tudi v nasprotju z rezultatom. Obstoječa pot lahko po svoji zasnovi vrača vse organizacije. Agent naj pokaže neskladje in predlaga omejen popravek. Ne sme neopazno odstraniti meje podatkov ali razširiti naloge v ponovno pisanje arhitekture.

V dokončanje vključite dokazila

Zahtevajte povzetek opravljenega dela, ki pojasni končno delovanje, spremenjeni obseg in izvedena preverjanja. Kjer je to pomembno, zahtevajte natančne ukaze in rezultate. Ločite uspešno preverjanje od preverjanja, ki ga ni bilo mogoče izvesti.

Pull request naj ohrani razlog za spremembo. Poznejši vzdrževalec lahko vidi kodo brez prvotnega pogovora. Vključite dovolj konteksta, da pojasnite, zakaj izvoz izključuje določena polja in kako sistem uveljavlja nadzor dostopa.

Googlove smernice za opise sprememb so uporabna podlaga za ta zapis. Opis naj pojasni spremembo in njen namen. Po spremembah, ki izhajajo iz pregleda, zapis uskladite s končno izvedbo.

Obseg opisa prilagodite nalogi

Majhen besedilni popravek lahko ima kratek opis. Izvoz podatkov potrebuje več podrobnosti, ker lahko napake razkrijejo informacije. Nov plačilni delovni tok potrebuje še več analize in pregleda.

Kakovosti opisa ne merite z dolžino. Vprašajte se, ali bi usposobljen pregledovalec lahko ločil pravilen rezultat od napačnega. Če bi se razumni izvedbi razlikovali pri delovanju s pomembnimi posledicami, najprej pojasnite to delovanje.