Dokumentation - One standard to rule them all

Dokumentation er altid besværligt, og kunden vil ofte gerne have noget på skrift inden vi går i gang for at vise du forstår det, og i er enige, og de kan komme bagefter og sige vi har aftalt der står dette i designdokumentet, men sådan ser det ikke ud, eller sådan virker det ikke.

Så er udfordringen så altid at man helst skal have alting med, og her kommer et forsøg på at få det hele med:

1.0 Introduktion til designrapporten

1.1 Revisionshistorik

Væsentlige ændringer i dokumentet noteres.

Version	Dato	Ansvarlig	Beskrivelse

1.1       Referencer

Referencer til andre rapporter.

Dokumentnavn

Designguide til "den nye superapp"

2.0         Beskrivelse af websiden

2.1       Formål

Kort beskrivelse af websidens formål.

2.2       Design

2.2.1        Skærmbilledet

Kort beskrivelse af skærmbilledet med billede eksempler.

2.2.2        Designstandard

Beskrivelse af elementer som ikke er beskrevet i designguiden.

Websiden er designet ifølge designguiden til d-service.

Designskabelon
Skrifttyper
Farvekoder
Afstande
Ikoner
Knapper
Elementer
Faktabokse
Andet

2.2.3        Design af print

Er der mulighed for print på siden, beskrives designet af printet med billede eksempel.

2.3       Rettigheder

Rettigheder på websiden beskrives.

2.4       Tekster

Formuleringer som hardkodes, samt elementer hvor der benyttes tekster som kunden skal kunne administrere beskrives.

2.5       Links

Oversigt over alle links samt referencer. Dette indebærer også bogmærker.

2.6       Print

Beskrivelse af print-funktionen uden billede eksempel. Hvordan skal den opføre sig.

2.7       Pop-up, tooltip og advarsel

2.7.1        Pop-up

Kort beskrivelse af hvornår pop-upper vises. Beskrivelse af tekster og knapper er beskrevet i designrapporten ”Pop-up, tooltip og advarsler”.

2.7.2        Tooltip

Kort beskrivelse af hvornår tooltips vises. Beskrivelse af tekster er beskrevet i designrapporten ”Pop-up, tooltip og advarsler”.

2.7.3        Advarsel

Kort beskrivelse af hvornår advarsler vises. Beskrivelse af tekster er beskrevet i designrapporten ”Pop-up, tooltip og advarsler”.

2.8       Funktioner, usecase og behandling på backend

2.8.1        Funktioner på websiden samt usecase

Beskrivelse af funktionerne på websiden samt usecases.

2.8.2        ”End-to-end”-usecase

Flowbeskrivelse med tilknytning til øvrige programmer.

2.8.3        Overordnet beskrivelse af behandling på backend

3         Beskrivelse af websidens administration

3.1       Skærmbillede

Kort beskrivelse af skærmbilledet med billede eksempler.

3.2       Funktioner og usecase

Beskrivelse af funktionerne samt usecase.

4         Den tekniske del

4.1       SQL-tabeller

4.2       ASP.NET

4.3       Grænseflade til mainframe

4.4       Detaljeret beskrivelse af behandling på backend

5         Test

6         Bilag