Mal for faglige problemnotater
En struktur for å beskrive et problem, konsekvensen og dokumentasjonen som finnes.
Et faglig problemnotat skal gjøre et problem mulig å forstå og undersøke før noen bestemmer løsningen. Kopier strukturen nedenfor og fjern hjelpeteksten før notatet deles.
1. Tittel
Skriv en kort tittel som beskriver problemet, ikke den foretrukne løsningen.
Eksempel: Ulik tolkning av dato for korrigerte transaksjoner
2. Kort sammendrag
Beskriv på tre til fem setninger:
- hva som er uklart eller ikke fungerer
- hvor problemet oppstår
- hvem eller hva som påvirkes
- hvorfor problemet bør undersøkes
3. Omfang
| Spørsmål | Beskrivelse |
|---|---|
| Datastruktur eller dokument | Navn og versjon |
| Prosess | Hvor i arbeidsflyten problemet oppstår |
| Aktører | Hvilke roller som berøres |
| Periode | Om problemet gjelder bestemte utgaver eller datoer |
| Utenfor omfang | Hva notatet bevisst ikke vurderer |
4. Forventet forståelse
Beskriv hva en rimelig leser eller implementasjon forventes å forstå ut fra tilgjengelig dokumentasjon. Vis til den konkrete teksten, regelen eller definisjonen som skaper forventningen.
5. Observert problem
Beskriv hva som faktisk skjer. Skill mellom:
- det som er direkte observert
- det som er rapportert av andre
- det som er en mulig konsekvens
- det som er din egen tolkning
6. Dokumentert eksempel
Lag et minst mulig eksempel som fortsatt viser problemet. Fjern personopplysninger, organisasjonshemmeligheter og andre opplysninger som ikke er nødvendige.
Eksemplet bør inneholde:
- relevante inndata
- forventet resultat
- observert resultat
- nødvendige innstillinger eller forutsetninger
- henvisning til dokumentasjonen som er brukt
7. Konsekvenser
Beskriv konsekvensene uten å overdrive:
- feil eller avvik i data
- ekstra manuelt arbeid
- redusert sammenlignbarhet
- vansker med kontroll eller sporbarhet
- risiko for at ulike aktører velger ulike løsninger
Oppgi om konsekvensen er observert, beregnet eller antatt.
8. Mulige årsaker
List mulige årsaker hver for seg. Eksempler kan være:
- uklar definisjon
- manglende eksempel
- motstridende dokumentasjon
- utilstrekkelig valideringsregel
- lokal implementasjonsfeil
- manglende versjonsinformasjon
Ikke konkluder før dokumentasjonen støtter én forklaring bedre enn de andre.
9. Forslag til neste steg
Foreslå den minste handlingen som kan gi mer kunnskap eller redusere uklarheten. Det kan være å:
- avklare en definisjon
- legge til et eksempel
- teste flere grenseverdier
- sammenligne to dokumentversjoner
- be ansvarlig fagmiljø om en autoritativ avklaring
- invitere berørte roller til en avgrenset gjennomgang
10. Kilder og vedlegg
Oppgi tittel, ansvarlig utgiver, versjon eller dato og direkte lenke der den finnes. Merk tydelig hvilke vedlegg som kan deles offentlig.
Send notatet
Send notatet til post@boar.no . Les først hvordan vi behandler faglige innspill .