Formålet med dokumentationen er at sikre nedestående forhold:
Det udviklede skal tilbageleveres til OS2forms fællesskabet. Det skal derfor:
- kunne vedligeholdes som en del af OS2forms Core
- kunne installeres på fælles test og driftsmijø af ekstern leverandør (Bellcom)
- kunne installeres af ekstern leverandør (Bellcom) på den enkelte kommunes test og driftsmiljø
- kunne enables/disables
- kunne anvendes af forretningsenhederne i anvenderkommunerne
Dokumentationen består af:
- Integrationsoverblik (tekst/diagrammer)
- Teknisk implementeringsguide/installationsvejledning
- Vejledning til opsætning og konfigurationer
- Krævede roller og rettigheder
- vejledning i hvor forretningen ser kvittering fra hhv. Fordelingskomponenten og KP
- vejledning i XML via computed Twigg
- Kodekommentarer
Alle dele af koden som f.eks. procedurer, funktioner, metoder og objekter bør have en samlet kommentar i toppen af kodeafsnittet. Kommentaren skal beskrive, hvad koden i afsnittet laver, inputs, outputs og sideeffekter.
- PR med link til sagen
- commit beskeder
- vejledning i hvordan det udviklede testes, så faglige systemejere i forretningen kan teste
Formålet med dokumentationen er at sikre nedestående forhold:
Det udviklede skal tilbageleveres til OS2forms fællesskabet. Det skal derfor:
Dokumentationen består af:
Alle dele af koden som f.eks. procedurer, funktioner, metoder og objekter bør have en samlet kommentar i toppen af kodeafsnittet. Kommentaren skal beskrive, hvad koden i afsnittet laver, inputs, outputs og sideeffekter.