Dokumentasjonskrav til leverandør v. 1.11

Hensikt og omfang

Hensikten med prosedyren er å beskrive hvilke dokumenter HEMIT krever at leverandør skal levere i utviklings og innføringsprosjekter for å sikre nødvendig omfang og kvalitet på dokumentasjon av leveranser fra eksterne leverandører.

Ansvar

Prosjektleder har ansvar for at prosedyren etterleves.

Definisjoner

Ekstern leverandør: Ekstern part som har betydelige leveranser inn til prosjektet.

Utviklingsleveranser: Løsninger som utvikles spesielt for prosjektet, i motsetning til hyllevare

Hyllevare: Standard løsninger som kjøpes slik de tilbys, uten noen spesielle tilpasninger for hver enkelt kunde

Arbeidsbeskrivelse

Hvilke dokumenter som bør kreves vil være avhengig av kontraktstype, utviklingsmetode og grad av spesialutvikling i leveransene. F.eks. vil tradisjonelle utviklingskontrakter stille andre krav til dokumentasjon enn smidig utvikling.

 

Før utlysing av anskaffelser:

  1. Gå gjennom tabellen under, og avgjør hvilken dokumentasjon som må leveres fra leverandør for det aktuelle prosjektet. For nødvendige dokumentasjonskrav angående informasjonssikkerhet og IKT-tjenester, se NO-18 og NO-19 under Relatert.
  2. List opp krav til nødvendig dokumentasjon. Tekst må tilpasses.
  3. Angi også eventuelle krav til språk på dokumentasjonen.
  4. Kravene til dokumentasjon fra leverandør skal inngå i kravspesifikasjon i underlaget for anbudet, og skal være formalisert som del av kontrakten.
  5. Tidspunkt for leveranse av dokumentene skal angis i anbud, og i milepælsplanen for prosjektet.
  6. I utviklings- og innføringsprosjekter som avviker fra standarden ved at det av spesielle årsaker likevel ikke er aktuelt at leverandør utarbeider enkelte av dokumentene i listen, skal prosjektleder vurdere å levere disse dokumentene fra prosjektet dersom det er praktisk mulig.

 

I prosjekter der HEMIT selv står for utviklingen og leveransen:

  1. Vi skal stille de samme krav til oss selv mht. dokumentasjon som til eksterne leverandører.
  2. Hvilken dokumentasjon som leveres bør spesifiseres i en plan, med tidspunkt for dokumentasjonsleveransen, og hvem som er ansvarlig.

 

 

I tillegg til de dokumenter vi avtaler levert fra leverandøren, kommer den dokumentasjonen HEMIT selv er ansvarlig for å utarbeide. Kravspesifikasjoner og driftsdokumentasjon er et eksempel på et dokument HEMIT selv har ansvaret for å utarbeide, også i utviklings- eller innføringsprosjekter.

 

Tabellen viser eksempler på dokumenter som normalt skal leveres fra leverandør i utviklings- og innførings-prosjekter:

Dokument

Beskrivelse

Kommentar

Leveran-dørens løsnings-beskrivelse

Leverandørens svar på våre kravspesifikasjoner. Dette kan være en videre detaljering av våre krav, eller et design-dokument som viser hvordan kravene kan implementeres

Avhengig av kontrakts-type

Overordnet design

Beskriver arkitektur, integrasjoner og datamodeller på overordnet nivå

Bør alltid leveres

Detaljert design

Beskriver arkitektur, integrasjoner, datamodeller og løsninger på detaljert nivå

Avhengig av kontraktstype

System-dokumen-tasjon

Inneholder tilstrekkelige tekniske beskrivelser slik at Hemit kan drifte løsningen. Eksempler på innhold:

  • Detaljert designdokument (se punkt over)
  • Beskrivelse av de enkelte modulene (menyvalg, knapper og lenker) og dataflyten i mellom dem
  • Beskrivelse av integrasjoner
  • Beskrivelse av datafelter og gyldighetssjekker
  • Behov og krav til diskplass
  • Beskrivelse av katalogstruktur (plassering av logger, WebServicer, meldinger, databaseområder og andre elementer)
  • Kapasitetskrav f.eks. linjehastigheter
  • Nødvendige brannmuråpninger
  • Beskrive brukerautorisasjon og –autentisering
  • Spesielle ting i systemet som krever spesiell utdyping (print ect)
  • Krav til drift (ting som vi må ivareta for å drifte systemet)
  • Beskrivelse av feilmeldinger (feilhåndtering)
  • Beskrivelse av tilgjengelig grensesnitt for integrasjon fra 3.part (WS, .NET, API etc)
  • Spesielle anbefalinger til driftsprosedyrer som skal gjennomføres for å sikre stabil drift (sletting av logger ect)
  • Anbefalinger for sikkerhetskopiering

 

Systemdokumentasjon for støtte til Helse Midt-Norges drift av løsningen skal alltid leveres

Innstallasjons-dokument
  • Installasjonsveiledning som beskriver både installasjonsprosessen og konfigurering og tilrettelegging av moduler, inkludert tilbakerulling dersom installasjonen feiler
  • Dokumentasjonen skal være så detaljert at systempersonell ikke trenger assistanse fra leverandør ved installasjon av oppdateringer og framtidige versjoner
  • Installasjonslogg skal genereres under installasjonen (på hvilken måte og hvordan installasjonen forløp, tidsforløp)

Skal alltid leveres

Leveranse-beskrivelse ("Release Notes")

Dette er en versjonsbeskrivelse som leveres ved hver leveranse:

  • Identifikasjon av leveransen (navn, versjonsnummer)
  • Innhold i leveransen (hvordan pakket, hvilke skript leveres etc)
  • Endringer siden forrige versjon
    • feilretting
    • ny funksjonalitet
    • endringer i systemet
  • Kjente utestående feil
  • Liste over gjeldene dokumentasjon (all berørt dokumentasjon endres og følger med leveransen)

 

Skal alltid leveres

Bruker-dokumenta-sjon
  • Beskrivelser av alle funksjoner slik at bruker kan operere systemet uten videre opplæring
  • Brukerstøtte bør være implementert i systemet ("On Line Help")

 

Avhengig av leveranse og kontraktstype, men en brukerveiledning på en eller annen form bør alltid leveres

Testplan

Beskrivelse av leverandørens systemtest (omfang og plan):

  • Krav til testmiljø og integrasjoner
  • Krav til spesielle testdata
  • Dekningsgrad
  • Normaltesting vs. negativ testing
  • Testing av grensetilfeller
  • Ytelsestesting
  • Testing av skalerbarhet
  • Testing av sikkerhet
  • Brukertesting
  • Testtilnærming, dvs. hvordan testes de forskjellige områdene
  • Tidsplan
  • Krav til testressurser og testkompetanse

Avhengig av kontraktstype.

For utviklingsleveranser skal leverandøren som minimum levere en overordnet testplan, som viser testtilnærming og testomfang.

Testrapport

Beskrivelse av resultatet fra leverandørens systemtest:

  • Testresultater
  • Vurdering av leveransens kvalitet basert på testresultater og testomfang

 

Avhengig av kontraktstype.

Skal alltid leveres for utviklingsleveranser

 

Referanse

Ingen relevante referanser.