Skrifaðu verklýsingu fyrir gervigreindaragent

Lýstu breytingu sem yfirferðaraðili getur metið

„Bæta við útflutningi viðskiptavinagagna“ skilur eftir nokkrar óútkljáðar ákvarðanir. Hver má flytja út færslur? Hvaða færslur og reitir eru með? Hvað gerist þegar beiðni mistekst? Gervigreindaragent getur fyllt í eyðurnar með trúverðugum ákvörðunum. Þær geta samt verið rangar fyrir fyrirtækið.

Byrjaðu á notandanum og vandanum. Lýstu síðan nauðsynlegri hegðun. Tilgreindu gögnin sem sýna hvort niðurstaðan sé ásættanleg.

Verklýsing ætti að draga úr óvissu án þess að ákvarða hvert atriði innri hönnunar. Tilgreindu nauðsynleg gagnamörk. Láttu útfærsluna nota núverandi mynstur kóðasafnsins nema ástæða sé til að breyta þeim.

Notaðu áþreifanlegt dæmi

Eftirfarandi verklýsing er fyrir ímyndað þjónustuforrit. Þetta er kennsludæmi, ekki fullbúin forskrift fyrir rekstur.

Niðurstaða: Stjórnandi þjónustuvers getur sótt lista yfir viðskiptavini.
Aðili: Stjórnandi í núverandi fyrirtæki.
Gögn: Aðeins virkir viðskiptavinir þess fyrirtækis.
Reitir: Auðkenni viðskiptavinar, heiti fyrirtækis og staða reiknings.
Snið: UTF-8 CSV með hauslínu.
Höfnuð beiðni: Svara með fyrirliggjandi villu um aðgangsheimild.
Tóm niðurstaða: Skila gildri CSV-skrá með aðeins hauslínu.
Umfang: Nota núverandi útflutningsleið og mynstur fyrir rekjanleikaskráningu.
Undanskilið: Engin ný hlutverk, engar nýjar hugbúnaðareiningar sem forritið byggir á og engin uppsetning.
Staðfesting: Próf fyrir leyfilegar, bannaðar og tómar beiðnir og beiðnir yfir fyrirtækjamörk.

Þessi verklýsing skilgreinir gagnlega hegðun og mörk. Hún sýnir líka frekari spurningar. Ætti kerfið að takmarka stærð útflutnings? Getur reitur innihaldið formúlu fyrir töflureikni? Hver getur nálgast rekjanleikaskrána? Leystu úr spurningum sem hafa verulegar afleiðingar áður en útfærsla hefst. Ekki líta á dæmið sem algildan gátlista.

Greindu kröfur frá forsendum

Krafa segir til um hegðun sem breytingin verður að uppfylla. Forsenda er staðreynd sem þú hefur ekki enn sannreynt. Haltu þessu aðskildu.

Til dæmis gerir „nota núverandi mynstur fyrir rekjanleikaskráningu“ ráð fyrir að viðeigandi mynstur sé til. Biddu gervigreindaragentinn að finna það. Ef ekkert slíkt er í kóðasafninu ætti hann að greina frá skorti á þessari forsendu áður en hann býr til nýtt skráningarkerfi.

Takmörkun getur líka stangast á við niðurstöðuna. Fyrirliggjandi leið gæti verið hönnuð til að skila gögnum allra fyrirtækja. Gervigreindaragentinn ætti að sýna áreksturinn og leggja til takmarkaða leiðréttingu. Hann ætti ekki að fjarlægja gagnamörkin án skýringa eða stækka verkefnið í endurskrifun högunar.

Láttu staðfestingargögn fylgja verklokum

Óskaðu eftir samantekt sem útskýrir endanlega hegðun, breytt umfang og framkvæmdar athuganir. Krefstu nákvæmra skipana og niðurstaðna þar sem það skiptir máli. Greindu á milli athugunar sem stóðst og athugunar sem ekki var hægt að keyra.

Pull request ætti að varðveita ástæðu breytingarinnar. Síðari viðhaldsaðili gæti séð kóðann án upprunalega samtalsins. Láttu fylgja nægilegt samhengi til að útskýra hvers vegna útflutningurinn útilokar ákveðna reiti og hvernig aðgangsstýringu er framfylgt.

Leiðbeiningar Google um breytingalýsingar eru gagnlegt viðmið fyrir þessa skráningu. Lýsingin ætti að útskýra breytinguna og tilgang hennar. Haltu henni í samræmi við endanlega útfærslu eftir breytingar úr yfirferð.

Hafðu verklýsinguna í réttu hlutfalli við verkefnið

Lítil textaleiðrétting getur haft stutta verklýsingu. Gagnaútflutningur þarf meiri smáatriði því bilanir geta afhjúpað upplýsingar. Nýtt greiðsluferli þarf enn meiri greiningu og yfirferð.

Ekki mæla gæði verklýsingar út frá lengd hennar. Spurðu hvort hæfur yfirferðaraðili gæti greint rétta niðurstöðu frá rangri. Ef tvær skynsamlegar útfærslur myndu haga sér ólíkt á mikilvægan hátt skaltu skýra þá hegðun fyrst.