Bilag 4. Dokumentation. Til Kontrakt. Den Nationale Henvisningsformidling

Transkript

1 Bilag 4 Dokumentation Til Kontrakt OM Den Nationale Henvisningsformidling Bilag 4 Dokumentation Side 1/11

2 INSTRUKTION TIL TILBUDSGIVER: Teksten i dette afsnit er ikke en del af Kontrakten og vil blive fjernet ved indgåelse heraf. Formål med bilag: Formålet med Bilag 4 er, at beskrive Kundens krav til Dokumentation af Løsningen og aktiviteter omkring Løsningen i hele Kontraktens løbetid. Instruks vedrørende bilag: Bilag 4 skal ikke udfyldes af Tilbudsgiver. Evaluering af besvarelse: Bilaget indgår ikke i tilbudsevalueringen. Udbudsbetingelsernes bilag X: Det vil være muligt at angive forbedringsforslag i Udbudsbetingelsernes bilag X, Tilbudsgiverens forbedringsforslag. Sådanne forslag kan blive drøftet i forhandlingsfasen, men vil ikke nødvendigvis blive det. Bilag 4 Dokumentation Side 2/11

3 Indholdsfortegnelse 4.1 INDLEDNING FORMÅL MED DOKUMENTATIONEN GENERELLE KRAV TIL DOKUMENTATION ANSVARSFORDELING LEVERING OG GODKENDELSE OPDATERING OG VERSIONERING DOKUMENTATIONSOVERBLIK SPROG VEDLIGEHOLDELSE AF DOKUMENTATIONEN DOKUMENTATIONSOMRÅDER... 7 Bilag 4 Dokumentation Side 3/11

4 4.1 Indledning Nærværende Bilag 4 beskriver Kundens krav til Dokumentation. Dokumentation skal i hele Kontraktens løbetid leve op til kravene i nærværende bilag. De generelle krav, jf. afsnit 4.3 Generelle krav til Dokumentation, gælder for alle leverancer af Dokumentation medmindre andet aftales. Dokumentation, herunder også løbende opdatering af Dokumentation i forbindelse med eksempelvis nye Releases/Versioner af Løsningen, er en del af det faste vederlag angivet i bilag 12 Vederlag og Priser (dette gælder både under udvikling, implementering og efterfølgende under support og vedligeholdelse). 4.2 Formål med Dokumentationen Leverandøren skal levere Dokumentation til Kunden, der er nødvendig for, at tredjemand på rimelige og sædvanlige vilkår kan varetage, drifte og udføre vedligeholdelse/opdatering af Programmel samt ændring af Kundespecifikt Programmel. Dokumentationen skal sikre, at en udenforstående, med kendskab til Løsningens arkitektur og teknologi, kan læse og forstå, hvordan Løsningen er opbygget. Dokumentationen er også en væsentlig del af grundlaget for, at Kunden kan bevise, at gældende regler, f.eks. love, standarder og forordninger, revisionsmæssige, sikkerheds- og tilsynskrav, efterleves. 4.3 Generelle Krav til Dokumentation Krav til format: Dokumentationen skal være udformet efter en ensartet struktur og metode, så Dokumentationen fremstår som en helhed, og tidsforbruget ved at sætte sig ind i Dokumentationen holdes på et minimum. Hvert dokument skal indledes med en kort introduktion til og læsevejledning for det pågældende dokument. Dokumentationen skal følge en af de offentlige anbefalede åbne standarder, Open Document Format (ODF) eller Office Open XML (OOXML) eller tilsvarende. Dokumentationen skal kunne printes i et læsevenligt format. Kunden anvender ITIL (version 3 eller senere) og PRINCE 2, og Leverandøren skal benytte sig af ITIL- og PRINCE 2-terminologi i forbindelse med udarbejdelse af Dokumentation. Tekniske dele af Løsningen skal beskrives både ved tekstuelle beskrivelser og ved diagrammering med modelleringssprog, der er udbredte og anerkendte i Danmark, f.eks. UML eller lignende. Diagrammer, der anvendes til at understøtte tekstbeskrivelser, skal leveres i et redigerbart format. Krav til lagring og adgang til Dokumentation: Leverandøren skal stille en platform til rådighed, hvor Kunden til enhver tid har adgang til den fulde og komplette senest opdaterede Dokumentation online. Dokumentationen skal forefindes i elektronisk form og være fuldstændig, samlet og lagret og kunne beskyttes mod ændringer. Dokumentationen skal stilles til rådighed for Kunden, relevant myndighed, 3. part eller andre af Kundens leverandører (herunder i forbindelse med Kontraktens ophør) som online dokumentation i søge- og redigerbar elektronisk kopi, der er let tilgængelig for modtagergruppen. Kunden kan med et varsel på 2 uger bede om et fuldt elektronisk udtræk af den komplette og opdaterede Dokumentation. Bilag 4 Dokumentation Side 4/11

5 4.4 Ansvarsfordeling Leverandøren skal indgå i en samarbejdsmodel med Kunden i forbindelse med udarbejdelse af dokumentindhold, hvor Leverandøren som udgangspunkt planlægger, styrer og udarbejder al Dokumentation. Leverandøren og Kunden skal indgå i en proces, der indeholder de aktiviteter og ansvarsfordelingen, der fremgår af figur 1 herunder. Leverandøren skal indarbejde de i figur 1 anførte aktiviteter i tidsplanen. Dokumentationen skal udarbejdes og leveres løbende over leveranceforløbet, således at Kunden undervejs har mulighed for at give en foreløbig godkendelse af Dokumentationen. Figur 1 Aktiviteter, Proces og ansvarsfordelingen for udarbejdelse af Dokumentation 4.5 Levering og godkendelse Al Dokumentation, der skal leveres ved afslutning af en Delleverance, skal være godkendt af Kunden. Kunden kan stoppe påbegyndelsen af næste Delleverance såfremt Dokumentationen for indeværende Delleverance ikke er leveret efter betingelserne i nærværende bilag. Kunden er berettiget til at tilbageholde godkendelse af en prøve, hvis Dokumentationen ikke er leveret i rette tid eller acceptabel kvalitet. Såfremt Dokumentationen ikke kan godkendes skal Kunden redegøre for Fejl og Mangler over for Leverandøren, hvorefter Leverandøren retter og genfremsender til godkendelse. I Afklaringsfasen aftales en procedure for, hvorledes Kundens foreløbige godkendelse af al Dokumentation frem til Overtagelsesprøven skal foregå. Proceduren fastlægger følgende: Hvor lang tid Kunden skal have til at gennemgå Dokumentationen afstemt efter omfanget. Hvilken kvalitetssikring Leverandøren foretager forud for fremsendelse af Dokumentation til godkendelse ved Kunden. Bilag 4 Dokumentation Side 5/11

6 Kundens endelige godkendelse af den samlede Dokumentation sker ved godkendelse af Overtagelsesprøven. I god tid inden Overtagelsesprøven aftaler Parterne de nærmere forhold vedrørende levering af opdateret Dokumentation, således at Kunden har mulighed for at afsætte ressourcer til gennemgang af Dokumentationen op til Overtagelsesprøven. Ved planlægning af godkendelsesaktiviteter skal Leverandøren tage højde for, at der forinden godkendelse af Dokumentation af en større mængde materiale skal foreligge en fase (godkendelsesperiode), hvor Kunden har materialet til kommentering og godkendelse. En godkendelsesperiode består af 4 uger, der opdeles på følgende måde: Til kommentering (review) varighed 10 Arbejdsdage Til rettelse varighed 5 Arbejdsdage (som udgangspunkt) Til godkendelse efter tilretning varighed 5 Arbejdsdage Med Kundens forudgående skriftlige accept kan godkendelsesperioden forkortes, men ikke til mindre end 5 Arbejdsdage. 4.6 Opdatering og versionering Leverandøren skal med tydelig versionsangivelse holde den leverede Dokumentation opdateret, således at Dokumentationen til enhver tid fyldestgørende afspejler Løsningen i drift og opfylder kravet om, at Dokumentationen skal muliggøre Kundens afprøvning, drift, support, anvendelse og videreudvikling af Løsningen, jf. Bilag 5 Support og Vedligehold. Ændringer i Dokumentationen skal være sporbare. Leverandøren skal derfor sikre, at hvert enkelt Dokument indeholder entydig versionering og en dokumenthistorik, så det klart fremgår: Hvornår versionerne af Dokumentet er udarbejdet. Hvilken status den aktuelle version har. Hvilken del af Leverancen (Krav) det relaterer sig til. Leverandøren skal ligeledes gøre Kunden opmærksom på eventuelle nye versioner af dokumentation. Såfremt der sker ændringer i Kontrakten, via en ændringsanmodning er Leverandøren forpligtet til at dokumentere ændringen. 4.7 Dokumentationsoverblik Leverandøren skal udarbejde, og i hele kontraktperioden vedligeholde, en oversigt over: den gældende Dokumentation for Løsningen, den Dokumentation, der vil blive udarbejdet. Oversigten skal, for hvert element, liste: tiltænkt målgruppe, formål, status aktuelt versionsnummer angivelse af, hvor Dokumentationen findes. Bilag 4 Dokumentation Side 6/11

7 4.8 Sprog Al Dokumentation vedrørende Løsningen skal tilbydes Kunden på dansk inden ibrugtagning af Løsningen. Alle besvarelser, designoplæg og kravspecifikationer i relation til udbud skal være på dansk. Teknisk Dokumentation kan leveres på engelsk, hvis denne ikke skal anvendes af Løsningens Standardbrugere. Der skal til teknisk dokumentation anvendes UML modelleringssprog i forbindelse med teknisk dokumentation. Supplerende kan E/R diagrammer benyttes til dokumentation af datastrukturer. Alle vejledninger til Superbrugere og Administratorer skal leveres på dansk. 4.9 Vedligeholdelse af Dokumentationen Leverandøren skal vedligeholde den leverede dokumentation, så den til hver en tid er så fyldestgørende og detaljeret, med klar angivelse af grænseflader, anvendte tekniske standarder og programmeringsteknikker m.v., at Leverancen samlet fremstår som veldokumenteret. Dokumentationen skal endvidere til stadighed leve op til kravene i Kontrakten. Kunden skal til enhver tid have adgang til den opdaterede dokumentation. I relation til dokumentation for tredjemandsprogrammel skal Leverandøren stille den af tredjemand senest udarbejdede dokumentation til rådighed for Kunden. Hvis vedligeholdelse af Leverancen medfører ændringer, skal Leverandøren sørge for, at den tilhørende dokumentation ændres i overensstemmelse dermed. Leverandørens vedligeholdelse af dokumentation omfatter fuldstændig vedligeholdelse af alt til Løsningen. Kontrakten og Bilag 3 Leverance- og ydelsesbeskrivelse angiver yderligere konkrete forpligtelser i forbindelse med vedligeholdelse af dokumentation. I forbindelse med nye releases er det et krav, at Leverandøren forud for udrulning af opdateret version dokumenterer, at releasen er gennemtestet og igangsættes i en fejlfri version. Dokumentation af systemet og installationen betragtes som en naturlig del af vedligehold. Leverandøren skal derfor vedligeholde den leverede dokumentation, så kunden til enhver tid er i besiddelse af en opdateret udgave af den aftalte dokumentation. Opdateringer af dokumentation skal leveres 10 arbejdsdage før installationen i produktionsmiljøet finder sted Dokumentationsområder I dette afsnit er listet de områder, som Dokumentationen som minimum skal dække. Bemærk listen er ikke udtømmende og er ikke udtryk for en dokumentstruktur. Leverandøren skal efter kontraktindgåelse, jf. pkt. 4.4, levere et oplæg til en dokumentstruktur, der understøtter Leverandørens udviklings-, vedligeholds-, og implementeringsmetode. Dokumentationsområder Leverance-, løsnings-, og Systemdokumentation Beskrivelse/Formål Løsningsbeskrivelsen skal have en logisk sammenhæng med kravene til den efterspurgte løsning jf. Bilag 3, Leverance- og Ydelsesbeskrivelse. Løsningsbeskrivelsen skal være understøttet af aktørdiagrammer eller lignende. Løsningsbeskrivelsen skal desuden beskrive den overordnede tilgang til og strategi for, hvordan funktionaliteten kan testes i den tilbudte løsning. Bilag 4 Dokumentation Side 7/11

8 Kravsporingsmatrice Arkitekturbeskrivelse Formålet er at sikre sporbarhed af krav fra kravspecifikationen til test og ibrugtagning af Leverancen. Af matricen skal det fremgå, hvor i Dokumentationen realiseringen af de enkelte krav er beskrevet. Arkitekturbeskrivelsen skal beskrive den komplette arkitektur for den tilbudte løsning. Dokumentationen skal indeholde Topologitegning illustreret vha Archimate eller Visio. Formålet er at komme fra forretningsgangsbeskrivelsen til design af systemet ved at dokumentere arkitekturovervejelser og arkitekturbeslutninger. Arbejdet med arkitektur kan ske på mange måder. En metode er at anvende forskellige EA Metoder som fx OIO Metode på Arkitekturbeskrivelsen skal beskrive Løsningens komplette arkitektur, så det kan fungere som grundlag for design af Løsningen. Brugerdokumentation Og Undervisningsmateriale Leverandøren skal også levere dokumentation for tekniske snitflader i Leverancen. Leverandøren skal dokumentere samtlige systemafhængigheder og integrationer både på skrift og i arkitekturtegning(er). Leverandøren skal således beskrive komponenter, moduler og deres interfaces ud fra en teknisk synsvinkel, herunder grænseflader, applikationslag med dertilhørende Application Program Interface(s) (API). Leverandøren skal: danne et overblik over leverancens komponenter med et komponentdiagram. Komponentdiagrammet skal give overblik over Leverancens tekniske dele og deres indbyrdes samspil og afhængigheder. Beskrive bruger- og programmeringsinterfaces. Beskrive datamodellen og dens implementering i produktionsfiler og database for permanent lagring, inklusiv en beskrivelse af forespørgselssprog (query language). Målgruppen for brugerdokumentationen er slutbrugere, superbrugere, faglige systemansvarlige, systemadministratorer og andre brugere, der skal anvende og administrere Løsningen. Dokumentationen skal give målgruppen tilstrækkelig indsigt i Leverancens funktioner, workflows, anvendelses-, konfigurations- og opsætningsmuligheder til, at Kunden kan være selvhjulpen i alle arbejdsgange. Der skal således foreligge en vejledning af de handlinger, der er nødvendige for at en bruger (her menes både slut-, super- og administrativ bruger) kan anvende Løsningen. Dokumentationen skal således: sætte nye brugere i stand til at bruge/benytte Løsningen, og fungere som opslagsværk for mere øvede brugere. Der ønskes en differentiering af vejledningerne, således at en rolle hurtigt kan fremsøge den relevante vejledning i henhold til opgave/ansvar. Brugerdokumentationen skal være renset for funktioner, der ikke er relevante eller ikke stilles til rådighed for alle brugere. Brugervejledningen skal suppleres med online-hjælp (e-learning). Brugervejledningen kan ligeledes suppleres med undervisning. Der skal Bilag 4 Dokumentation Side 8/11

9 Installationsdokumentation formuleres en klar sondring mellem administratorvejledning og brugervejledning. Målgruppen for installationsdokumentation er driftspersonale og andet personale, der har aktiviteter relateret til at bringe Løsningen til at virke efter hensigten på relevante miljøer. Installationsdokumentationen beskriver, hvordan den leverede Løsning installeres, sættes i drift og vedligeholdes i de relevante miljøer på de rette tidspunkter. Vejledningen skal indeholde information om fall-back, dvs. dels hvordan en installation afbrydes og den hidtidige installation reetableres, dels hvordan enkelte komponenter afinstalleres. Vejledningen skal også give en detaljeret redegørelse for, hvorledes der skal tages backup, for at systemet kan genetableres ved restore/genetablering med data efter en disaster situation. De dertilhørende procedurer for restore af data skal også angives. Vejledningen skal beskrive, hvordan det verificeres at Systemet er korrekt installeret og kørende. Vejledningen skal også give en detaljeret redegørelse for systemets logning ud over standard server logning. Driftshåndbog Vejledningen skal være udformet så en driftsoperatør med sædvanlige IT kompetencer på den valgte driftsplatform kan udføre installationen, herunder skal alle forudsætninger være beskrevet. Formålet med Driftshåndbogen er at overlevere Løsningen til Drift i et ITmiljø, og skal gøre Kunden eller 3. part i stand til proaktivt at drifte og vedligeholde Løsningen, herunder skal evt. anbefalede kontrolprocesser være beskrevet. Driftshåndbogen skal indeholde en beskrivelse af (eller henvisninger til Dokumentation, der beskriver) alle relevante forhold og vejledninger relevant for Drift af Løsningen i et IT-miljø, herunder en beskrivelse af de processer, der er en forudsætning for stabil drift samt vejledning til fejlsituationer og afhjælpning af disse, samt beskrivelse af organiseringen af Løsningens Drift og vedligeholdelse. Driftshåndbogen inkluderer eksempelvis: Vejledninger og forhold vedrørende Løsningens Drift og tekniske vedligeholdelse. Styring af faste og bestilte batchjobs (dags- og periodekørsler m.v.). Overvågningsværktøjer og procedurer. Sikkerhedsadministration (inklusive specielt udviklet og tilpasset Programmel). Opstarts- og nedlukningssekvens, systemspecifikke procedurer, Løsningens brugsmønster og patch management. Almindelige eller rutinemæssige driftsopgaver. eks. kloning af miljøer, anonymisering af hele eller dele af databasen mhp. etablering af testmiljøer, datasikkerhed og overvågning. Procedurer for anonymisering, arkivering og genindlæsning af data. Etablering og vedligehold, herunder beredskabsplan som beskriver, hvad der som minimum skal gøres for at genetablere drift af Løsningen efter et nedbrud eller lignende (Backup/recovery procedurer). Bilag 4 Dokumentation Side 9/11

10 Testdokumentation Projektdokumentation Udrulningsplan for præproduktion, test-, udvikling og produktionsmiljø Driftsplan Vejledning til administratorer (superbrugere) Nødprocedurer og nødserver. Organiseringen, herunder kontaktoplysninger for alle personer involveret i Drift. Driftshåndbogens præcise indhold aftales under overgang til forvaltning. Leverandøren skal levere testdokumentation jf. Bilag 14 Prøver. Dokumentation omhandler Teststrategi i detaljer, testplan, testrelateret risikostyring, testdækning og sporbarhed samt testcases, testdata og omfang af tests samt testrapporter dokumenteres af Leverandøren, så Kunden har dokumentation til brug for Kundens andel af forberedelse af tests samt dokumentation af gennemførte tests. Dokumentationen skal være i en sådan stand at både planlægningen og implementeringen i relevante miljøer er beskrevet og klar til iværksættelse. Formålet med projektdokumentationen er at understøtte Kundens- og Leverandørens projektstyring, og bibringe Parterne et grundlag for at konstatere og drøfte eventuelle afvigelser samt overholde Kundens interne rapporteringskrav. Den endelige form og opdateringsinterval for projektdokumentation aftales mellem Parterne i Afklaringsfasen og løbende i Programmet, når behov for ændringer opstår. Projektdokumentationen skal følge Kundens projektmodel, som er baseret på Prince2, og dermed som minimum inkludere relevante planer (såvel overordnede som detailplaner for enkelte spor/aktiviteter), logs og registre, statusrapporter og referater. Leverandøren skal udarbejde en plan for hvordan Løsningen skal implementeres i produktion-, præproduktion-, test- og udviklingsmiljø. Det er vigtigt at udrulningsplanerne for henholdsvis produktion, præproduktion, test og udviklingsmiljø er adskilte. Leverandøren skal udarbejde en oversigt over de kørsler, der kører på bestemte tidspunkter. Det kan f.eks. være backup kørsler, schedulerede skift og sikring af logfiler og generering af rapporter mv. Det skal af planen fremgå, hvordan og hvornår aktiviteterne sættes i gang, samt forventet outputresultat af de enkelte aktiviteter. Dokumentationen skal være udformet således alle kørsler er beskrevet, samt ansvaret for aktiviteterne er placeret og fremgår af dokumentationen. Vejledningen skal give læseren den fornødne viden til at kunne administrere den del af Leverancen, som administratoren er ansvarlig for. Det kan fx være brugeradministration eller konfigurationsændringer. Leverandøren skal i tilbuddet angive, hvilke dele af Systemet, der kan konfigureres af Kunden, og hvilke dele der kræver konfiguration fra Leverandøren efter den initiale opsætning. Det skal fremgå af dokumentation i hvilket omfang Løsningen kan konfigureres (dels af Kundens udpegede roller/aktører og dels af Leverandøren) og hvad konsekvenserne af konfigurationerne er. Det skal fremgå af vejledningen hvordan konfiguration skal ske. Konfigurabilitet relaterer sig f.eks. til grafisk udtryk, redaktionelle tekster, fejlbeskeder, samt værdilister, tidsfrister, logiske regler/udtryk, roller, Bilag 4 Dokumentation Side 10/11

11 privilegerede bruger/aktører, funktionelle og informationsmæssige rettigheder, rapporter og ledelsesinformation, statisk, notifikationer og alarmer, servicemålsrapportering, responstidsrapportering og andre parametre styrende for forretningslogikken, valideringslogik, schedulerings- og datakommunikationslogikken. Bilag 4 Dokumentation Side 11/11