Mit kezel még a dokumentumon kívül?
A dokumentum csupán az egyik módja egy döntés rögzítésének. Azt is tudni kell, mely pontokban született megállapodás, melyek még javaslatok, ki válaszol a kérdésekre, és mi változik egy pont módosításakor. Így elkerülhető, hogy ugyanazt a kérést eltérően értelmezve dolgozzanak rajta.
Ugyanez a megközelítés segíthet az alkalmazásfejlesztésben, a belső eszközöknél, a termékfeltételekben és a működési szabályokban. Ne próbáljon mindent egyszerre dokumentálni; kezdjen egyetlen funkcióval vagy munkafolyamattal.
Kapcsolja össze a célt, a követelményt, a specifikációt és az elfogadási feltételeket
A csapatok eltérően használják ezeket a fogalmakat. Ebben a példában a követelmény egy szükséges eredményt vagy korlátot ír le, a specifikáció a megállapodás szerinti működést rögzíti, az elfogadási feltételek pedig azt, hogyan ellenőrizhető. Egyeztesse a jelentésüket a munkatársakkal.
Cél: a kézi adatátírás csökkentése
A havi jelentéskészítés jelenleg a bejegyzések kézi másolásával jár. Az exportálás célja ennek a munkának a megkönnyítése.
Követelmény: a jelentéshez szükséges rekordok exportálása
Egy munkatársnak exportálnia kell a kiválasztott hónap nyilvántartásait a számára engedélyezett hozzáférési körön belül.
Specifikáció: határozza meg a fájlt és annak működését
Állapodjatok meg az oszlopokban, a sorrendben, a szövegkódolásban, a dátumformátumban, az üres eredmények kezelésében és a hibákban. Ezek csak a példa kedvéért választott beállítások, nem általános alapértelmezések.
Elfogadási kritériumok: legyen ellenőrizhető az eredmény
Készítsen elő ismert dátumú és jogosultságú rekordokat, végezze el az exportálást, és hasonlítsa össze az eredményt a megállapodás szerinti kimenettel.
Minden elemhez egy ellenőrizhető gondolatot írjon
Az olyan megfogalmazás, mint „Legyen kényelmes az exportálás”, fontos döntéseket hagy nyitva. Különítse el az időszak kiválasztását, a kimeneti mezők megadását, a találat nélküli esetek kezelését és a hozzáférés ellenőrzését, ha ezek egymástól függetlenül módosíthatók vagy ellenőrizhetők.
A „gyors” vagy „könnyű” szavak helyett használjon konkrét feltételeket. Ha fontos a célként kitűzött válaszidő, a szám mellett rögzítse a terhelést, a környezetet és a mérési módszert is. A még el nem döntött értékeket láthatóan jelölje eldöntetlenként.
Előtte: „CSV-export engedélyezése.”
Utána: „Exportálja a kiválasztott hónapot az egyeztetett oszlopokkal és rendezési sorrendben. Az üres eredményeket és a hozzáférés-ellenőrzéseket külön pontokban határozza meg.”
Az átfogalmazott szöveg megnevezi azokat a döntéseket, amelyekről meg kell állapodni, és megkönnyíti a munka kiosztását és ellenőrzését. A megvalósítás előtt még szükség van a mezők pontos meghatározására.
Néhány mező az induláshoz
Azonosító, cím és leírás
Adj minden elemnek állandó azonosítót, például REQ-001-et. Rögzítsd a tárgyat, a feltételt és a várt eredményt. Az állandó azonosítóval a cím megváltozása után is hivatkozni lehet az elemre.
Ok és forrás
Rögzítse, milyen problémát old meg az adott elem, és honnan származik, például beszélgetésből, kérésből vagy alátámasztó dokumentumból.
Prioritás és hatókör
Különítse el az ehhez a kiadáshoz szükséges elemeket azoktól, amelyek várhatnak. Indokolja meg a prioritásokat; ne legyen minden a legmagasabb prioritású.
Felelős és a döntés állapota
Jegyezd fel, ki tisztázza az elemet, és hogy vázlat, felülvizsgálat alatt áll vagy már elfogadott. A megvalósítás felelőse és a jóváhagyó külön személy lehet.
Elfogadási kritériumok és kapcsolódó információk
Kapcsold az elemet a vonatkozó specifikációkhoz, tervekhez, feladatokhoz és ellenőrzési nyilvántartásokhoz. A követelmény változásakor frissítsd ezeket a hivatkozásokat.
Példa: három követelmény a havi CSV-exporthoz
Az alábbi példa csak szemléltetésre szolgál. A mezőnevekről és a működésről a készülő termékhez igazodva kell megállapodni; a példa nem az összes exportfunkció teljes specifikációja.
REQ-001: a kiválasztott hónap rekordjai
Példa specifikációra: a megállapodás szerinti üzleti időzónában meghatározott hónapot használja, és exportálja az azonosítót, a rögzítés dátumát és a címet UTF-8 formátumban, dátum, majd azonosító szerint rendezve. Elfogadási példa: három megfelelő rekord esetén egy fejlécsor és pontosan három adatsor keletkezzen, más hónapok rekordjai nélkül.
REQ-002: nincs egyező rekord
Példa specifikációra: az egyeztetett fejlécsort akkor is exportálni kell, ha egyetlen rekord sem felel meg. Elfogadási példa: az üres tesztadatkészlet olyan fájlt hoz létre, amely csak a fejlécet tartalmazza, adatsorok nélkül. Ha fájl helyett üzenetet szeretnének, állapodjanak meg ebben az eltérő működésben, és dokumentálják.
REQ-003: az exportálás előtt ellenőrzik a hozzáférést
Példa specifikációra: az exportálási jogosultság nélküli felhasználók nem hozhatják létre a fájlt, és az engedélyezett körön kívüli rekordok nem kerülhetnek bele. Az elfogadási példák terjedjenek ki egy exportálási jogosultság nélküli és egy korlátozott rekordhozzáférésű felhasználóra.
Használjon hierarchiát az egyes döntések megőrzésével
Csoportosítsa az elemeket cél vagy funkció szerint, majd a részletes feltételeket helyezze a megfelelő csoport alá. Például: Jelentéskészítés → Havi CSV-export → Célrekordok / Fájlformátum / Üres eredmények / Hozzáférés. A háttérinformációkat és a nyitott kérdéseket külön jegyzetekben rögzítse, ne egy hosszú követelménybe keverje.
Ha egy feltétel több funkciót érint, tartson fenn egyértelmű hivatkozást az elfogadott verzióra, ahelyett hogy az egyes szakaszokba eltérő verziókat másolna. Módosítás előtt ellenőrizze, mely további specifikációk és ellenőrzési tételek függnek tőle.
Különítse el a megállapodást, a megvalósítást és az ellenőrzést
Az „Egyeztetve” azt jelenti, hogy a tartalmat elfogadták a tervezett hatókörre. Ez nem jelenti a funkció megvalósítását. A „Megvalósítva” sem igazolja, hogy a megállapodás szerinti elfogadási feltételek teljesültek, vagy hogy a funkciót kiadták. Ezeket a különbségeket egyszerű állapotlista használatakor is tedd egyértelművé.
Vizsgálja meg a szokásos esetet, az üres vagy hiányzó bemenetet, a jogosultságokat és szükség esetén a külső hibákat. Döntse el, milyen bizonyítékokat őrizzenek meg, ki ellenőrzi őket, és ki zárhat le egy megválaszolatlan kérdést.
Rögzítse a változtatást és annak hatását, mielőtt elfogadottnak tekintené
Az új kérés addig javaslat marad, amíg a felelősök meg nem állapodnak a kezeléséről. Rögzítse a módosítás okát, az érintett azonosítókat, valamint a munkára, dátumokra, specifikációkra és ellenőrzésre gyakorolt hatást. Gondolja át azt is, hogy a változás érinti-e a funkciót már használó rekordokat vagy felhasználókat.
A döntés után frissítse az aktuális specifikációt, és értesítse az érintetteket. Őrizze meg a korábban elfogadott verziót vagy egy változásjegyzetet, ha később el kell magyaráznia, mi változott. Ne feltételezze, hogy az eszköz minden jóváhagyást és módosítást automatikusan rögzít.
Válasszon egy helyet, amelyet naprakészen tud tartani
Egy kisebb listához elegendő lehet egy megosztott dokumentum vagy táblázat. Ha a megbeszélés, a megvalósítás és az ellenőrzés több eszköz között oszlik meg, válasszon egy fő hivatkozási helyet, és onnan linkelje a kapcsolódó anyagokat. A lényeg, hogy mindenki azonosítani tudja az aktuálisan elfogadott tartalmat.
Készítsen vázlatot AI-val, majd erősítse meg a döntéseket
Az AI segíthet a lehetséges követelmények felsorolásában, a vázlat rendszerezésében és a hiányzó kérdések felvetésében. A promptban különítse el az igazolt tényeket a feltételezésektől, és kérje, hogy az el nem döntött értékek kérdésként maradjanak meg. Tekintse át az eredményt azokkal, akik ismerik a tervezett felhasználást.
A ReqSpec AI alkalmazásban hierarchikusan rendezheted a követelményeket és specifikációkat, az AI pedig segíthet létrehozásukban, szerkesztésükben és ellenőrzésükben. Tegyél fel célzott kérdést, például: „Mely üres eredményre vonatkozó feltételek nincsenek még meghatározva?” A válaszokat a rögzített tartalom alapján ellenőrizendő javaslatként kezeld, ne a jóváhagyás vagy a teljesség bizonyítékaként.
Kezdjen egy funkcióval és egy felülvizsgálattal
Válasszon egy funkciót, sorolja fel a szükséges eredményeket, adjon azonosítókat az elemekhez, és egészítse ki őket elfogadási feltételekkel és nyitott kérdésekkel. Egyszer tekintse át egy érintett személlyel, majd rögzítse a döntéseket és a következő felelőst. Egy kicsi, karbantartott gyűjtemény hasznosabb, mint egy nagy dokumentum, amelyet senki sem frissít.
Rendszerezze a követelményeket és specifikációkat a ReqSpec AI segítségével
A ReqSpec AI egyszerű módot kínál a követelmények és specifikációk rendezésére mobilon és a weben. Ismerje meg a funkciókat az alkalmazás oldalán.