Vad hanterar du utöver dokumentet?
Ett dokument är bara ett sätt att dokumentera ett beslut. Du behöver också veta vilka punkter som är överenskomna, vilka som fortfarande är förslag, vem som ska besvara frågor och vad som förändras när en punkt revideras. Det hjälper till att undvika att man arbetar utifrån olika tolkningar av samma begäran.
Samma tillvägagångssätt kan hjälpa vid apputveckling, interna verktyg, produktvillkor och driftsregler. Börja med en funktion eller ett arbetsflöde i stället för att försöka dokumentera allt på en gång.
Koppla samman mål, krav, specifikation och acceptanskriterier
Team använder dessa termer på olika sätt. I det här exemplet beskriver ett krav ett önskat resultat eller en begränsning, en specifikation dokumenterar det överenskomna beteendet och acceptanskriterierna förklarar hur det ska kontrolleras. Kom överens om dessa betydelser med dem du samarbetar med.
Mål: minska manuell transkribering
Den månatliga rapporteringen innebär i dag att uppgifter kopieras för hand. Syftet med exportfunktionen är att förenkla det arbetet.
Krav: exportera de poster som behövs för rapporten
En medarbetare behöver exportera poster för en vald månad, inom ramen för sin behörighet.
Specifikation: definiera filen och dess beteende
Kom överens om kolumner, ordning, teckenkodning, datumformat, hantering av tomma resultat och fel. Det här är val för just detta exempel, inte universella standardinställningar.
Acceptanskriterier: gör resultatet kontrollerbart
Förbered poster med kända datum och behörigheter, genomför exporten och jämför resultatet med det överenskomna.
Skriv en kontrollerbar idé per punkt
En formulering som ”Gör exporten smidig” lämnar viktiga val öppna. Dela upp val av tidsperiod, val av exportfält, hantering av uteblivna träffar och kontroll av åtkomst när dessa delar kan ändras eller verifieras oberoende av varandra.
Använd konkreta villkor i stället för ord som ”snabbt” eller ”enkelt”. Om ett mål för svarstid är viktigt ska du dokumentera arbetsbelastning, miljö och mätmetod utöver själva siffran. Markera tydligt värden som ännu inte har bestämts.
Före: ”Tillåt CSV-export.”
Efter: ”Exportera den valda månaden med överenskomna kolumner och sorteringsordning. Definiera tomma resultat och åtkomstkontroller som separata punkter.”
Den reviderade formuleringen tydliggör vilka val man behöver enas om och gör det lättare att fördela och granska arbetet. Konkreta fältdefinitioner behövs fortfarande före implementeringen.
Ett litet antal fält att börja med
ID, titel och beskrivning
Ge varje post ett beständigt ID, till exempel REQ-001. Ange ämne, villkor och förväntat resultat. Ett beständigt ID gör att man kan hänvisa till posten även om rubriken ändras.
Orsak och källa
Dokumentera problemet som punkten löser och varifrån den kommer, till exempel ett samtal, en förfrågan eller ett underlag.
Prioritet och omfattning
Skilj mellan det som behövs för den här versionen och det som kan vänta. Förklara varför något prioriteras; ge inte allt högsta prioritet.
Ansvarig och beslutsstatus
Ange vem som ska förtydliga posten och om den är ett utkast, under granskning eller överenskommen. Den som ansvarar för genomförandet och den som godkänner kan vara olika personer.
Acceptanskriterier och relaterad information
Länka objektet till relevanta specifikationer, designer, uppgifter och verifieringsprotokoll. Håll länkarna uppdaterade när kravet ändras.
Exempel: tre krav för månatlig CSV-export
Följande är ett illustrativt exempel. Fältnamn och beteenden bör avtalas för produkten du bygger; exemplet är inte en fullständig specifikation för alla exportfunktioner.
REQ-001: poster för den valda månaden
Exempel på specifikation: använd den valda månaden i den överenskomna tidszonen för verksamheten och exportera ID, registreringsdatum och titel i UTF-8, sorterade först efter datum och sedan efter ID. Exempel på acceptanskriterium: tre matchande poster ger en rubrikrad och exakt dessa tre datarader, utan poster från andra månader.
REQ-002: inga matchande poster
Exempel på specifikation: exportera den överenskomna rubrikraden även när inga poster matchar. Exempel på acceptanskriterium: en tom testdatauppsättning ger en fil med denna rubrikrad och inga datarader. Om du föredrar ett meddelande i stället för en fil, kom överens om och dokumentera det avvikande beteendet.
REQ-003: åtkomst kontrolleras före export
Exempel på specifikation: användare utan exportbehörighet kan inte skapa filen, och poster utanför det tillåtna omfånget tas inte med. Acceptansexempel bör omfatta en användare utan exportbehörighet och en användare med begränsad åtkomst till poster.
Använd hierarki utan att tappa bort enskilda beslut
Gruppera objekt efter syfte eller funktion och placera sedan detaljerade villkor under rätt grupp. Exempel: Rapportering → Månatlig CSV-export → Berörda poster / Filformat / Tomma resultat / Åtkomst. Lägg bakgrundsinformation och öppna frågor i anteckningar i stället för att blanda in dem i ett enda långt krav.
Om ett villkor påverkar flera funktioner ska du behålla en tydlig hänvisning till den överenskomna versionen i stället för att kopiera olika versioner till varje avsnitt. Kontrollera vilka efterföljande specifikationer och verifieringspunkter som är beroende av villkoret innan du ändrar det.
Håll överenskommelse, genomförande och verifiering åtskilda
”Överenskommet” betyder att innehållet har godkänts för den avsedda omfattningen. Det betyder inte att funktionen är implementerad. ”Implementerat” visar inte att de överenskomna acceptanskriterierna har uppfyllts eller att funktionen har lanserats. Håll dessa skillnader tydliga även med en enkel statuslista.
Granska normalfallet, tomma eller saknade indata, behörigheter och externa fel där det är relevant. Bestäm vilka underlag som ska sparas, vem som granskar dem och vem som får avsluta en olöst fråga.
Dokumentera en ändring och dess konsekvenser innan den betraktas som godkänd
En ny begäran är ett förslag tills de ansvariga har kommit överens om hur den ska hanteras. Dokumentera orsaken till ändringen, berörda ID:n och påverkan på arbete, datum, specifikationer och verifiering. Fundera också på om ändringen gäller befintliga poster eller användare som redan använder funktionen.
Uppdatera den aktuella specifikationen efter beslutet och informera berörda personer. Behåll den tidigare överenskomna versionen eller en ändringsanteckning om du behöver förklara vad som har ändrats. Utgå inte från att ett verktyg automatiskt registrerar varje godkännande och revidering.
Välj en plats som du kan hålla uppdaterad
För en liten lista kan ett delat dokument eller kalkylblad räcka. När diskussion, implementering och verifiering är utspridda över flera verktyg bör du välja en huvudreferens och länka till relaterat material därifrån. Det viktiga är att alla kan identifiera det innehåll som man för närvarande är överens om.
Använd AI till ett utkast och bekräfta sedan besluten
AI kan hjälpa till att lista möjliga krav, strukturera ett utkast och föreslå frågor som saknas. Skilj bekräftade fakta från antaganden i prompten och be AI att lämna obeslutade värden som frågor. Granska resultatet tillsammans med dem som känner till den avsedda användningen.
I ReqSpec AI kan du organisera krav och specifikationer hierarkiskt och använda AI för att skapa, redigera och kontrollera dem. Ställ en avgränsad fråga som ”Vilka villkor för tomma resultat är fortfarande odefinierade?” Se svaret som ett förslag att kontrollera mot det registrerade innehållet, inte som bevis på godkännande eller fullständighet.
Börja med en funktion och en granskning
Välj en funktion, lista de resultat som behövs, ge punkterna ID:n och lägg till acceptanskriterier och öppna frågor. Gå igenom detta en gång med en berörd person och dokumentera sedan besluten och nästa ansvariga person. En liten samling som hålls uppdaterad är mer användbar än ett stort dokument som ingen uppdaterar.
Organisera krav och specifikationer med ReqSpec AI
ReqSpec AI gör det enkelt att organisera krav och specifikationer på mobilen och webben. Utforska funktionerna på appens sida.