Project

General

Profile

Guide til oprettelse af fejl, ændringer og udviklingsønsker

Inden du overvejer at oprette en sag eller ønske, så søg eller se oversigten over sagerne så vi undgår dobbeltarbejde!

OBS. Fra oversigten kan også du bruge filtre til at få overblik f. eks. Emne -> Søgning - Brønd

Oplysninger vi skal bruge for at løse dit problem

DDB har brug for en række oplysninger for at forstå, prioritere og løse de problemer bibliotekerne indberetter tilfredsstillende.

Kan du ikke udfulde alle punkterne så opret sagen alligevel, så skal vi spørge hvis vi er i tvivl og hjælpe med til at du får den bedst mulige løsning.

Eksempel: https://platform.dandigbib.org/issues/2467

1- Problemstilling

Hvad handler problemet om, hvad virker ikke, hvad kan brugerne ikke forstå etc.

2- Formål

Hvad vil vi gerne opnå, hvilke oplysninger skal brugene kunne se etc.

3. Løsningsbeskrivelser

Hvilke løsninger kunne man forestille sig og er der en hurtig løsning og måske en der er bedre på længere sigt.

4. Forudsætninger og afhængigheder

Kan problemet først løses efter et andet issue eller projekt er gennemført eller skal der tages beslutninger eller ændres praksis.

5. Acceptkriterier

Prosa

Beskriv hvilke kriterier skal være til stede før en løsning kan accepteres.

Det er oplysninger vi skal bruge når løsningen er udviklet og vi skal teste den og afgøre om den skal udrulles til alle bibliotekerne.

Gherkin syntax (avanceret)

Er en måde at beskrive de krav vi stiller til løsningen på en måde som udviklerne kan udvikle automatiske tests efter.

Gherkin syntaxen er beskrevet under https://docs.cucumber.io/gherkin/reference/.

Eksempel:

@api @seek001 @seekNologin @regression

Scenario Outline: S001 Search for special letters
Given I have searched for "<title>"
When I set number of results per page to "50"
Then I can see "<letter>" somewhere in the search result

Examples:
| title | letter |
| term.language=dansk AND term.type=bog AND term.title=Å* | Å |

Kilde: https://github.com/ding2/ding2/blob/master/tests/behat/features/01-Searching.feature#L33

Når du skal oprette en sag findes der følgende felter der skal udfyldes:

Du opretter et nyt issue via http://platform.dandigbib.org/projects/ddb-cms/issues/new.

Type
Det kan være svært at skelne imellem de forskellige typer, men forsøg at være kritisk så bugs kun bruges når det er deciderede fejl i eksisterende funktionalitet.

  • Bug er en fejl i eksisterende funktionalitet
  • Enhancement dækker forbedringer af eksisterende funktionalitet
  • Feature er en ny funktion der mangler i systemet

Emne
Giv din sag en god sigende beskrivelse. Det kunne være:

  • "Når jeg vil forny et tidskrift sker der ingenting"
  • "Som lokal administrator kan jeg ikke oprette nye brugere"
  • "Som bruger kan jeg ikke filtrere søgeresultatet efter udgivelsesår - ældste først"

Beskrivelse
Beskriv fejl eller udviklingsønsket så detaljeret du kan så det er lettere for andre at gennemskue og genskabe fejlen.

Bugs beskrivelser bør indeholde:

  • Forudsætninger der skal være opfyldt for at fejlen kan genskabes (version, hosting plan, hosting miljø etc.)
  • Trin for at genskabe fejlen
  • Forventet resultat
  • URL
  • Konsekvens for brugere eller redaktører
  • Browser og browserversion
  • Screenshots

Features og enhancement beskrivelser bør indeholde:

  • Baggrund for ændringen (usability test, statistik eller UX praksis)
  • Formålet med ændringen (F. eks. userstory "Som X skal jeg kunne Y for at være i stand til Z")
  • Forslag til hvordan ændringen skal implementeres med designskitse, sekvens eller procesdiagram, wireframe ellerlignende.

OBS: Vær grundig og skriv så mange af ovenstående oplysninger som muligt da gør det meget lettere at analysere og beskrive de opgaver udviklerne skal lave. Dermed er der også en højere chance for at dit issue prioriteres og bliver løst hurtigere.

Status
Bare vælg New. Closed er kun hvis man redigerer sin sag igen

Emner
Vælg de funktionsområde der er tale om så det er lettere at få et overblik ved at foretage filtreringer.

Filer
Upload meget gerne skærmbilleder af hvad der sker. Det giver os meget bedre mulighed for at fejlsøge.

OBS: Husk ikke at lægge CPR eller andre personfølsomme data ind i sagen.

Emneopdelinger i DDB CMS issue trackeren

Ved oprettelse af et issue tildeles det et eller flere kategorier så det er muligt at se alle issues inden for et givent område.

Tryk på nedenstående links for at se de issues der er tildelt de pågældende kategorier:

Inspiration - Forsiden
Inspiration - Karruseller
Inspiration - Nyheder
Inspiration - Arrangementer
Inspiration - Temaer
Inspiration - Kampagner
Inspiration - Personalisering
Biblioteksinfo - Biblioteker
Biblioteksinfo - Åbningstider
Biblioteksinfo - Sidefod
Biblioteksinfo - Sider
Søgning - Søgeresultat - Brønd
Søgning - Værkvisning
Søgning - Materialevisning
Søgning - Søgeresultat - hjemmeside
Min konto - Login/Adgang og proxy
Min konto - Login brugeroprettelse
Min konto - Lån
Min konto - Reserveringer
Min konto - Mellemværende
Min konto - Brugerprofil
Min konto - Huskekliste
Administation - Menuer og taksonomier
Administration - Systemkonfiguration
Administration - Design (Theming af desktop og mobil)
Integration - BPI
Integration - DDELibra
Integration - Integra
Integration - FBS
Integration - Brønd - Søg, rankér filtrér sortér
Integration - Brønd - Data og relationer
Integration - DIBS (Betaling)
Integration - Place2book (Arangementer)
Integration - Openlist (Personalisering)
Integration - VoxB
Driftsvedligehold - Refakturering (Opdatering af kodebasen)
Driftsvedligehold - Oversættelser (udarbejdes før udrulning)
Driftsvedligehold - Manual (udarbejdes før udrulning)
Driftsvedligehold - Tilladelser (udarbejdes før udrulning)
Driftsvedligehold - Sikkerhedsopdateringer