Brugerflade dokumentation

Fra Holstebro HTX Wiki
Skift til: navigering, søgning

Ideernes udviklingsrum

Det at lave en simpel dokumentation af brugerfladen, kan være en god måde at få styr på de ideer man har til programmets funktion og udseende, og mest af alt, at man får etableret en sammenhæng mellem disse.

Den grafiske del

Hvis programmet har en grafisk brugerflade, så er det godt at skitsere den, så man har en ide om hvordan man vil have tingene til at se ud.

Det behøves ikke være en fin kvalitet, men blot noget der giver et overblik.

Hvis man har et program hvor der er forskellige skærmbilleder (det kunne være en startskærm, en spilleplade og en higscore), så er det smart at tegne alle de forskellige skærme, selvom man syntes man har helt styr på tingene.

Bruger input

Det er vigtigt at dokumentere hvad det er brugeren har af muligheder i programmet.

Ved at dokumentere dette, så får man startet på at beskrive hvilke funktioner der skal ligge i programmet.

Bruger input skal her betragtes meget bredt. Det er alt fra tal / tekst der kan tastes ind over flueben, klik, styretaster til musebevægelser eller andre ting der skal have indflydelse på programmet.

Det er vigtigt at man i sin beskrivelse også tager med hvad der skal ske, når brugeren aktiverer et input.

Program output

Når brugeren giver et input til programmet, så forventer man også at få et output (en eller anden form for reaktion).

Det er ikke på nuværende tidspunkt nødvendigt at dokumentere hvordan dette output bliver lavet - men man skal tage stilling til hvor det skal komme og på hvilken form (tal / graf / lyd / bevægelse).

Hvordan man får lavet outputtet dokumenterer man ved design af algoritmer opstilling af beregninger eller hvad man gør, som typisk kan dokumenteres med Pseudokode.

Eksempel på Brugerflade dokumentation

Dette er et meget simpelt eksempel der blot skal vise metoden, anvendt på et let forståeligt eksempel.

Programmet er en hjemmeside der skal kunne beregne BMI og klassificere over- under-vægt.

Grafisk layout af BMI-beregner

Layoutet kan skitseres bare ved hjælp af en håndtegning:

BMI-haand.png

Det der er vigtigt er at man får designet det, så det virker logisk for brugeren.

Man kan også lave det i Paint, hvor man kan se det er præcist den samme ide:

BMI-paint.png

Der er dog lige tilføjet nogle tal, der fører os videre til de næste dele af brugerfladen, input og output.

Input til BMI-beregner

Som angivet i brugerfladen, så skal brugeren taste to tal ind: Vægt og højde.

I beregningen indgår vægten i kg og højden i meter.

Med hensyn til input, så kan man overveje hvilke friheder brugeren skal have - Må man taste højden i cm? Må man bruge dansk komma? Skal der tjekkes for om brugeren indtaster skøre værdier?

De to værdier indtastes i felterne markeret med 1 og 2.

Det sidste input er knappen markeret med 3, der skal aktivere beregningen og vurderingen.

Output fra BMI-beregner

Programmet skal selvfølgelig beregne BMI. Det er på nuværende tidspunkt ikke nødvendigt at man ved hvordan BMI beregnes, man skal blot vide at det skal kunne beregnes ud fra de input der er givet.

Det kan derimod være smart at angive, at man ønsker at få BMI ud med 2 decimaler, og at det skal komme i felt 4.

Tilsvarende skal der komme en vurdering af det beregnede BMI (overvægt / undervægt osv.). Outputtet skal placeres i felt 5.

Det er igen ikke nødvendigt at beskrive nu, hvordan man vurderer. Det kan man dokumentere ved hjælp af en algoritme, som man kan dokumentere f.x. ved hjælp af Pseudokode