Sider
Denne sektion dokumenterer de enkelte sider og skærmbilleder i applikationen.
Hver sidedokumentation fokuserer på hvad siden repræsenterer, hvilken information den viser, og hvilke handlinger der er tilgængelige fra siden.
Hvis du forsøger at forstå hvad et bestemt skærmbillede gør, er dette det rette sted at kigge.
Hvad betyder en “side” i denne dokumentation
I denne dokumentation refererer en side til ét enkelt skærmbillede eller visning i applikationen.
Sider er typisk: - Fokuseret på visning eller redigering af en specifik type data - Tilgængelige afhængigt af rettigheder og roller
En sidedokumentation forklarer formålet og opbygningen af skærmbilledet - ikke en fuld opgave eller proces.
Hvad er dækket her
Hver sidedokumentation indeholder typisk:
- Sidens formål
- Hvilke nodetyper der vises eller administreres
- Betydningen af centrale felter og indikatorer
- Tilgængelige handlinger og kontroller
- Hvordan nodetilstand (for eksempel aktiv eller inaktiv) afspejles i brugerfladen
- Eventuelle relevante rettighedskrav
Sidedokumentation beskriver hvad der er muligt på den pågældende side - ikke den fulde rækkefølge af trin for at opnå et mål.
Hvad er ikke dækket her
Denne sektion beskriver ikke:
- End-to-end-opgaver
- Flertrinsprocesser, der spænder over flere sider
- Godkendelsesflows eller forretningslogik
- Edge cases på tværs af systemet
Disse emner dokumenteres under Arbejdsgange.
Hvordan sider relaterer sig til arbejdsgange
Sider og arbejdsgange supplerer hinanden:
- Sider beskriver hvor interaktioner finder sted
- Arbejdsgange beskriver hvordan et mål opnås på tværs af sider
En enkelt arbejdsgang vil ofte referere til flere sider.
På samme måde kan en side indgå i flere arbejdsgange.
Hvornår skal du bruge denne sektion
Brug Sider, når du: - Vil forstå et specifikt skærmbillede - Har brug for afklaring af, hvad en kontrol eller indikator betyder - Udforsker brugerfladen - Vil vide, hvilke handlinger der er tilgængelige fra en given side
Hvis du forsøger at løse en konkret opgave, vil du typisk skulle følge en Arbejdsgang i stedet.
Hvor går du videre herfra
- Leder du efter et bestemt skærmbillede? → Gennemse sidelisten nedenfor
- Forsøger du at løse en opgave? → Gå til Arbejdsgange
- Er du usikker på et begreb eller koncept? → Start med Begreber
Gennemse dokumentationen for specifikke sider: