Altinn II - Altinnett - Forsiden og... · Design dokumenter for OpenSSO inkludert egne design for...

Altinn II

Leseguide og spesifikasjon av dokumentasjon

Versjon 1.0 Dato: 10.05.2010

Leseguide og Leseguide og spesifikasjon av dokumentasjon.doc

Altinn Side 2 / 13

Innhold

1 Leseguide ...................................................................................................................................... 3 2 Struktur og innhold i systemdokumentasjon ............................................................................ 4

2.1 Overordnete dokumenter ....................................................................................................... 5

2.2 Spesifikasjonsdokumenter ..................................................................................................... 5 2.2.1 AP226 Use Case Diagram: ............................................................................................ 5 2.2.2 AP221 Use Case: ........................................................................................................... 5 2.2.3 AP246 Storyboard: ......................................................................................................... 6 2.2.4 AP342 Site Map: ............................................................................................................ 6

2.2.5 TA223 Detaljert teknisk spesifikasjon ........................................................................... 6 2.2.6 Sikkerhet og Register ..................................................................................................... 6 2.2.7 Vedlegg .......................................................................................................................... 6

2.3 Designdokumentasjon ........................................................................................................... 7 2.3.1 AP350 Component Overview ........................................................................................ 7 2.3.2 AP353 Component Definition ....................................................................................... 7 2.3.3 AP347 Page Specification High Level........................................................................... 7

2.3.4 AP311 Service Definition - High Level ......................................................................... 7 2.3.5 AP310 Intermediary Functional High Level Design ..................................................... 7

2.3.6 AP312 Batch Design Definition .................................................................................... 7 2.3.7 AP370 Data Conversion Design .................................................................................... 7

2.3.8 Teknisk Arkitektur ......................................................................................................... 7 2.3.9 Sikkerhet og register ...................................................................................................... 8

2.3.10 Datamodell design.......................................................................................................... 8 2.3.11 Implementasjonsguider .................................................................................................. 8 2.3.12 Altinn I integrasjon ........................................................................................................ 8

2.4 Utviklingshåndbok ................................................................................................................ 8 2.5 API......................................................................................................................................... 8

2.6 Installasjon og driftsdokumentasjon ...................................................................................... 8

3 Struktur og innhold i brukerdokumentasjonen ..................................................................... 10 3.1 Kurs ..................................................................................................................................... 11

3.1.1 Tjenesteutviklere .......................................................................................................... 11 3.1.2 Brukerstøtte .................................................................................................................. 11

3.1.3 Integrasjon Altinn – tjenesteeiersystemer .................................................................... 11 3.2 Leseguider ........................................................................................................................... 11 3.3 Brukerdokumentasjon ......................................................................................................... 11

3.3.1 E-læring ........................................................................................................................ 11

3.3.2 Brukerveiledning for brukerstøtte ................................................................................ 11 3.3.3 TUL brukerveiledning.................................................................................................. 12

4 Struktur og innhold i testdokumentasjonen ........................................................................... 13 4.1.1 TE598 Testrapport ....................................................................................................... 13 4.1.2 AP249 User Feedback Report ...................................................................................... 13


Altinn Side 3 / 13

1 Leseguide

Dette kapittelet gir en overordnet beskrivelse av hvordan ulike brukergrupper kan benytte seg av de

ulike delene av dokumentasjonen.

Funksjonelle brukere har mest nytte av å lese overordnete dokumenter og deretter fordype seg i

spesifikke funksjonelle brukerscenarioer innen TUL eller SBL. For disse brukerne vil dermed

dokumentasjon som definert i kapitler 2.1og 2.2 være relevante.

Tekniske brukere innen Altinn har mest nytte av å lese design dokumenter som linker til

tjenester/metoder. Metodene kan deretter slås opp i kodedokumentasjonen. Dersom en bruker

ønsker å fokusere på et bestemt brukerscenario, anbefales det å lokalisere det relevante use caset.

Use caset har referanser til relevante design dokumenter. For tekniske brukere blir dermed kapitler

2.2 2.3 og 2.5 relevante.

Driftsoperatorer trenger kun å fokusere på installasjons- og driftsdokumenter som beskrevet i

kapitler 2.6

Tekniske ressurser hos tjenesteeiere og sluttbrukersystemer trenger å fokusere på de respektive

implementasjonsguidene som beskrevet i kapittel 2.3.11. Utover selve guiden er det inkludert egne

leseguider for hvordan guidene best bør lese, disse er beskrevet i 3.2

Kursholdere trenger hovedsakelig å fokusere på kursmaterialet som er utarbeidet for superbrukere

som definert i 3.1. Utover kursmaterialet kan det være hensiktsmessig å referere til dokumentasjon

for funksjonelle brukere for ytterligere detaljeringer.

Sluttbrukere både for TUL og SBL portal trenger hovedsakelig å benytte seg av de relevante

brukerveiledningsdokumentene som beskrevet i kapittel 3.3.


Altinn Side 4 / 13

2 Struktur og innhold i systemdokumentasjon

Denne seksjonen beskriver hvilke dokumenter som inngår i systemdokumentasjon for Altinn II

versjon 1. Systemdokumentasjonen innebefatter følgende type dokumenter:

Overordnete dokumenter som beskriver løsningen og veileder leser gjennom hvordan

systemdokumentasjonen best kan brukes.

Spesifikasjonsdokumenter oppdatert hvor nødvendig og med klare linker til relaterte

designdokumenter. Det er naturlig å starte med et use case for å se på den funksjonelle

gjennomføringen av en spesifikk del av løsningen. Dette vil så kunne støttes opp med

storyboards og og site map for å se hvor denne funksjonaliteten passer inn i hele løsningen. I

figur 1 kan du se hvordan detaljerte spesifikasjonsdokumenter (Detaljspek.) brukes som et

funksjonelt utgangspunkt for de teknisk rettede designdokumentene.

Designdokumenter oppdatert med faktiske skjermbilder og hvor relevant med justeringer på

implementert funksjonalitet. Denne delen av dokumentasjonen skal vise den tekniske

gjennomføringen av de funksjonelle beskrivelser i spesifikasjonsdokumentene. På toppen

ligger det komponent og sub-komponent design som forklarer oppbygningen av løsningen.

Side og tjeneste design vil igjen referere til disse komponent designene for å indikere hvor i

løsningen de hører hjemme. Side designene vil også ha referanser til hvilke tjenester som

brukes for funksjonalitet og data tilgang. Tjeneste designene vil referere til hvilke data

modeller som støtter opp data behovet deres.

Utviklingshåndbok

API’er for TUL, SBL (inkludert Java doc fra OpenSSO)

Installasjons- og driftsdokumenter produsert for bruk av driftsleverandør.

Figure 1 - Systemdokumentasjon


Altinn Side 5 / 13

Figure 2 - Sammenheng mellom spesifikasjon- og designdokumentene i systemdokumentasjonen

2.1 Overordnete dokumenter

Utdrag fra overordnet spesifikasjon.

Leseveiledning for forståelse av vedlegg.

Altinn ”ordbok”

2.2 Spesifikasjonsdokumenter

Følgende typer dokumenter omfatter spesifikasjonsdokumentene:

2.2.1 AP226 Use Case Diagram:

Oversikt over aktører, use cases og forholdet mellom dem.

Kort beskrivelse av alle use case

2.2.2 AP221 Use Case:

Et dokument per usecase

Kort beskrivelse av usecaset

Aktivitetsdiagram (eller evt. annen mer hensiktsmessig grafisk fremstilling/modell) av den

funksjonelle hovedflyten og evt. alternativ flyt

Beskrivelse av aktivitetsdiagram/grafisk modell


Altinn Side 6 / 13

Liste over krav som dekkes i usecaset

Referanser til design dokumenter som støtter den tekniske gjennomføringen av use caset.

2.2.3 AP246 Storyboard:

Navigasjonsmodell og eksempler på sidetyper og –flyt

Inkl. overgang til standardverktøy for tjenesteutvikling

2.2.4 AP342 Site Map:

Alle sider og deres organisering

2.2.5 TA223 Detaljert teknisk spesifikasjon

Teknisk spesifikasjon for applikasjons-, informasjons-, infrastruktur-, integrasjons-,

løsnings-, utviklings- og testarkitektur.

2.2.6 Sikkerhet og Register

Teknisk spesifikasjon for sikkerhetsarkitektur for SBL og TUL

2.2.7 Vedlegg

Systemdokumentasjon for standardprodukter


Altinn Side 7 / 13

2.3 Designdokumentasjon

Følgende typer dokumenter omfatter spesifikasjonsdokumentene:

2.3.1 AP350 Component Overview

Sett med grensesnitt definisjoner, hver definisjon med et sett av metoder som støttes av

komponenten.

Sett med grensesnitt definisjoner, hver definisjon med et sett av klasser og komponenter som

inngår i komponenten

Komponent diagram som illustrerer samhandling med og avhengigheter til andre

komponenter

2.3.2 AP353 Component Definition

Definerer formålet med komponenten

Definerer sub-komponenter (klasser og andre komponenter) som inngår i og grensesnitt

tilbudt av komponenten.

2.3.3 AP347 Page Specification High Level

Detaljert layout spesifikasjon av det grafiske grensesnitte.

Definerer all teknisk informasjon nødvendig for en utvikler å kode siden

Det er et page spec. design dokument per side eller delside i SBL og TUL løsningen. Noen

design vil beskrive mer enn en side hvis dette er sammenhengende funksjonalitet over flere

sider.

2.3.4 AP311 Service Definition - High Level

Detaljerer det funksjonelle og tekniske design av en tjeneste, ett designdokument per

tjeneste.

2.3.5 AP310 Intermediary Functional High Level Design

Detaljerer det funksjonelle designet for integrasjonsløsningen – intermediary komponenten.

En design per tjeneste

2.3.6 AP312 Batch Design Definition

Detaljerer den funksjonelle batch jobben per batch område

Beskriver tekniske grensesnitt

2.3.7 AP370 Data Conversion Design

Dokumenterer manuelle og automatiske prosedyrer som må kjøre for å ekstrahere data fra

nåværende applikasjon og migrere/replikere til den nye applikasjonen.

Dokumenterer replikeringsjobber mellom nye komponenter

2.3.8 Teknisk Arkitektur

Dokumenter som beskriver applikasjons-, integrasjons- og sikkerhetsarkitekturer.

Komplett oversikt over alle tjenester på tvers av alle komponenter.


Altinn Side 8 / 13

2.3.9 Sikkerhet og register

Design dokumenter for OpenSSO inkludert egne design for alle autentiseringsmoduler

Komponent og tjenestedefinisjoner for autorisasjon

2.3.10 Datamodell design

ER diagrammer for alle databaser – et diagram per komponent

Konseptuel datamodell for hele løsningen

2.3.11 Implementasjonsguider

Guide for integrasjon med Altinn for sluttbrukersystemer og tjenesteeiere inneholdende:

Grensesnitt og metode beskrivelser

Beskrivelse av feilmeldinger og andre meldinger som kommer fra Altinn

2.3.12 Altinn I integrasjon

Dokumenter fra eksisterende løsning som beskriver grensesnitt som videreføres i ny løsning.

2.4 Utviklingshåndbok

Utviklingshåndboken er et oppslagsverk benyttet under utvikling av løsning for å samle opp all

informasjon nødvendig for å komme i gang med utvikling. Den inneholder også informasjon som

trengs for å sørge for at alle utviklere oppretter sine moduler på en uniform og konsistent måte.

Håndboken fungerer i hovedsak som et oppslagsverk, men kan også leses sekvensielt som

opplæringsmateriale for nye utviklere. Håndboken er dynamisk materiale og alle

utviklere/designere er oppfordret til å legge til eller endre materiale når nødvendig.

Håndboken overlevers i .zip format som kan ekstraheres og lastes opp til kundes tilsvarende Wiki.

2.5 API

All selvutviklet kode er kommentert i koden både for SBL og TUL. Kodedokumentasjonen er

generert med standard kodeverktøy på bakgrunn av kodekommentarene. API’et er oppdatert med

siste versjon av kommentarene for installasjonsdag.

Kommentarene overlevers som en kompilert HTML hjelpefiler hvor alle klasser og metoder er

definert og finnes også som en del av systemdokumentasjon.

2.6 Installasjon og driftsdokumentasjon

For at driftsleverandør skal kunne sette opp test- og produksjonsmiljøer samt utarbeide

driftsdokumentasjon, er det utarbeidet og overlevert nødvendig dokumentasjon/innspill av den

tekniske løsningen med god kvalitet:

Grunnoppsettsdokumentasjon

Installasjonsinstrukser, inkludert konfigurasjonsbehov, for all programvare som kreves for å

drive den tekniske løsningen.


Altinn Side 9 / 13

Oversikt over manuelle/automatiske rutiner som kjøres og andre driftbare områder


Altinn Side 10 / 13

3 Struktur og innhold i brukerdokumentasjonen

Det skal utarbeides dokumentasjon rettet mot brukerne av Altinn, både brukere av

sluttbrukerløsningen og av tjenesteutviklingsløsningen. Med sluttbrukerløsning menes her både

portal og sluttbrukersystemer. Dokumentasjonen skal være på et så detaljert nivå at brukerne på

egenhånd blir i stand til å ta i bruk løsningene.

Det skal også utarbeides dokumentasjon rettet mot brukerstøtte, både i Altinn, hos tjenesteeiere og

hos sluttbrukersystemer, samt dokumentasjon rettet mot tjenesteeiere som brukere i Altinnportalen.

Kurs

Leseguider

Brukerdokumentasjon

Figure 3 - Brukerdokumentasjon


Altinn Side 11 / 13

3.1 Kurs

Det er utarbeidet materialet for tre kurs som Accenture holder for ’superbrukere’ innenfor de ulike

brukergruppene. Superbrukerne vil i sin tur gi opplæring internt i sin brukergruppe. Til hjelp i den

videre interne opplæringen tilbys system- og brukerdokumentasjon, samt leseguide til

dokumentene.

3.1.1 Tjenesteutviklere

Kursmaterialet fokuserer på en gjennomgang av bruk av løsningen, både rettet mot

tjenesteutviklere, fagpersoner og brukeradministratorer. Kurset inneholder også forslag til oppgaver

og enkelte testskjema som kan benyttes i en klasseromsbasert undervisning.

3.1.2 Brukerstøtte

Gjennomgang av løsningen - inkludert sentrale feilmeldinger - for de ulike brukerstøttefunksjonene.

Kurset inneholder også forslag til oppgaver og enkelte testskjema som kan benyttes i en

klasseromsbasert undervisning

3.1.3 Integrasjon Altinn – tjenesteeiersystemer

Gjennomgang av de ulike tjenestene og grensesnittene. Kurset er rettet mot systemintegratorer,

fagpersoner og løsningsarkitekter hos ASF og tjenesteeiere.

3.2 Leseguider

Som hjelp til dette selvstudiet og/eller interne opplæringen er det utformet leseguider til

dokumentasjonen med mål/oppgaverettet informasjon med pekere til relevante deler av

dokumentasjonen. Det er utformet leseguider til:

Brukerdokumentasjon for tjenesteutviklingsløsningen

Implementasjonsguide for tjenesteeier

Implementasjonsguide for sluttbrukersystemer

3.3 Brukerdokumentasjon

3.3.1 E-læring

Det er utformet en online hjelpefunksjon på lik linje som i eksiterende løsning av Altinn. Innholdet

er tilgjengeliggjort til sluttbruker gjennom en kombinasjon av egenutviklete sider, samt gjennom

publisering av innhold på egne sidemaler for dette i Informasjonsportalen. Alt sentralt innhold i

online hjelpefunksjon vil kunne skrives ut av sluttbruker, enten ved hjelp av utskriftsvennlige

nettsider, og/eller ved at relevant innhold tilgjengeliggjøres som utskrivbare dokumenter.

3.3.2 Brukerveiledning for brukerstøtte

Det er utformet en egen dokumentbasert dokumentasjon rettet mot brukerstøtte hos Altinn. Denne i

tillegg til å inneholde de funksjonelle beskrivelser som beskrevet i online hjelpefunksjonen for


Altinn Side 12 / 13

sluttbrukere, referere til innhold i online hjelpefunksjonen, og gir en oversikt over og forklaring til

sentrale feilmeldinger som gis i portalen og til sluttbrukersystemene.

3.3.3 TUL brukerveiledning

Det er utformet en egen brukerdokumentasjon for tjenesteutviklingsløsningen. Dokumentasjonen er

tilgjengeliggjort tjenesteutviklingsløsningen og er rettet mot ulike brukergrupper som

brukeradministratorer, tjenesteutviklere (funksjonelle samt tekniske) og brukskvalitetsansvarlige.


Altinn Side 13 / 13

4 Struktur og innhold i testdokumentasjonen

Følgende dokumenter overlevers på installasjonsdag som del av testdokumentasjonen:

4.1.1 TE598 Testrapport

En testrapport per testfase som oppsummerer resultatet av testene og dokumenterer alle

aktiviteter som har blitt utført som del av en vellykket overrekkelse til kunde.

Oppsummerer viktig informasjon i forhold til testfasen (utestående defecter, målinger osv).

4.1.2 AP249 User Feedback Report

Dokumenterer resultatet av alle brukerintervju, fokus gruppe møter, brukertest

Et dokument per gjennomgang

Altinn II - Altinnett - Forsiden og... · Design dokumenter for OpenSSO inkludert egne design for...

Documents

Transcript of Altinn II - Altinnett - Forsiden og... · Design dokumenter for OpenSSO inkludert egne design for...