Kirjuta agendile lähteülesanne

Kirjelda muudatust, mida ülevaataja saab hinnata

„Lisa klientide eksport“ jätab mitu otsust lahtiseks. Kes saab kirjeid eksportida? Millised kirjed ja väljad kaasatakse? Mis juhtub, kui päring ebaõnnestub? Agent saab need lüngad täita usutavate valikutega. Need valikud võivad ettevõtte jaoks siiski valed olla.

Alusta kasutajast ja probleemist. Seejärel kirjelda nõutavat käitumist. Lisa tõendid, mis näitavad, kas tulemus on vastuvõetav.

Lähteülesanne peaks vähendama ebakindlust, määramata ette iga sisemist teostusvalikut. Määra nõutav andmepiir. Lase teostusel kasutada koodihoidla olemasolevaid lahendusmustreid, kui nende muutmiseks pole põhjust.

Kasuta konkreetset näidet

Järgmine lähteülesanne on mõeldud väljamõeldud klienditoerakendusele. See on õppenäide, mitte täielik tootmiskeskkonna spetsifikatsioon.

Tulemus: Klienditoe haldur saab kliendiloendi alla laadida.
Kasutaja: Praeguse organisatsiooni haldur.
Andmed: Ainult selle organisatsiooni aktiivsed kliendid.
Väljad: Kliendi ID, ettevõtte nimi ja konto olek.
Vorming: UTF-8 CSV koos päisereaga.
Keelatud päring: Tagasta olemasolev autoriseerimisviga.
Tühi tulemus: Tagasta korrektne CSV, milles on ainult päis.
Ulatus: Kasuta olemasolevat ekspordimarsruuti ja auditimustrit.
Välistatud: Uusi rolle, sõltuvusi ega juurutust ei lisata.
Tõendid: Lubatud, keelatud, tühjade ja organisatsioonidevaheliste päringute testid.

See lähteülesanne määrab kasuliku käitumise ja piirid. See toob esile ka lisaküsimusi. Kas süsteem peaks piirama ekspordi suurust? Kas väli võib sisaldada arvutustabeli valemit? Kellel on juurdepääs auditikirjele? Lahenda oluliste tagajärgedega küsimused enne teostust. Ära käsitle näidet universaalse kontrollnimekirjana.

Erista nõuded eeldustest

Nõue kirjeldab käitumist, millele muudatus peab vastama. Eeldus on asjaolu, mida sa pole veel kontrollinud. Hoia need lahus.

Näiteks „Kasuta olemasolevat auditimustrit“ eeldab sobiva mustri olemasolu. Palu agendil see leida. Kui koodihoidlas seda pole, peab agent puuduvast sõltuvusest teatama enne uue auditisüsteemi väljamõtlemist.

Piirang võib olla ka soovitud tulemusega vastuolus. Olemasolev marsruut võibki olla kavandatud tagastama kõiki organisatsioone. Agent peab vastuolu näitama ja pakkuma piiratud parandust. Ta ei tohi märkamatult andmepiiri eemaldada ega laiendada ülesannet kogu arhitektuuri ümberkirjutamiseks.

Nõua töö lõpetamisel tõendeid

Palu üleandmise kokkuvõtet, mis selgitab lõplikku käitumist, muutunud ulatust ja tehtud kontrolle. Nõua täpseid käske ja tulemusi seal, kus need on olulised. Erista edukas kontroll kontrollist, mida ei saanud käivitada.

Pull request peab säilitama muudatuse põhjuse. Hilisem hooldaja võib näha koodi ilma algse vestluseta. Lisa piisavalt tausta, et selgitada, miks eksport teatud väljad välja jätab ja kuidas juurdepääsu piiratakse.

Google’i muudatuste kirjeldamise juhend on selle kirjelduse jaoks kasulik allikas. Kirjeldus peaks selgitama muudatust ja selle eesmärki. Pärast ülevaatusel tehtud parandusi vii kirjeldus lõpliku teostusega vastavusse.

Hoia lähteülesanne proportsionaalne

Väikese tekstiparanduse jaoks piisab lühikesest lähteülesandest. Andmete eksport vajab rohkem üksikasju, sest selle tõrked võivad teavet avaldada. Uus maksetöövoog vajab veel rohkem analüüsi ja ülevaatust.

Ära mõõda lähteülesande kvaliteeti pikkusega. Küsi, kas pädev ülevaataja suudaks õiget tulemust valest eristada. Kui kaks mõistlikku teostust käsitleksid oluliste tagajärgedega käitumist erinevalt, täpsusta kõigepealt seda käitumist.