productie documentatie

Gebruik de 522 IT checklisten van ITpedia, met in totaal 22028 vragen.

Zoek in de omschrijvingenOmschrijvingAantal vragen
IT projectfaseringBestaat uit meerdere checklisten
Application Services Library (ASL)Bestaat uit meerdere checklisten
ContinuïteitBestaat uit meerdere checklisten
KwaliteitsattributenBestaat uit meerdere checklisten
Functies in de automatiseringBestaat uit meerdere checklisten
WebdesignBestaat uit meerdere checklisten
Of zoek naar een woord: Fulltekst

Laatst gebruikt: Rapportage acceptatietest op: 2017-02-25 17:12 Checklist
Toezenden van eerdere beoordelingen per e-mail.
E-mailadres:


Hou je programmatuur in het oog, maak een moduledossier.

De programmamodules die worden gebouwd dienen tijdens de bouw goed gedocumen­teerd te worden. Deze documentatie heeft niet allen betrekking op de inhoud en de opzet van het programma maar heeft ook betrekking op het gebruik. Meer specifiek gaat het om de gebruikersdocumentatie, d.w.z. de handleiding en de productiedocumentatie in de vorm van een moduledossier.

Het moduledossier is in feite de gebruikershandleiding voor de systeembeheerders. Zoals de gebruiker moet kunnen opzoeken welke waarden hij op een scherm kan invullen, moet systeembeheer weten welke handelingen hij moet verrichten als een programma hem (fout)meldingen stuurt.

Het gaat hierbij in veel gevallen om handelingen die direct uitgevoerd moeten worden omdat gebruikers vastzitten of de verwerking gestaakt is.

Het is daarom van groot belang dat het moduledossier zeer toegankelijk is. In de eerste plaats dient er een lijst met mogelijke foutcodes en hun oplossing te zijn. Daarnaast dient er per module een dossier te worden aangelegd met daarop de relevante productiegegevens. Voor het opzoeken van de productiegegevens dient elk dossier gelijk van opzet te zijn. Door voor elke programmamodule een formulier te gebruiken is niet van een vaste indeling af te wijken.

Het formulier kan tevens door het ontwikkelteam worden gebruikt om een voor- aankondiging te doen van de komst van een programmamodule. Op deze wijze worden productieafdeling en gebruikersorganisatie vooraf geïnformeerd over de aard van een programmamodule. Voor de daadwerkelijke overdracht van modules dient een andere procedure.

De in te vullen vakken van het module dossier worden als volgt omschreven :

•    Programmamodule : De naam die de programmamodule heeft gekregen.
•    Versienummer : Het hoogste versie nummer van de programmamodule.
•    Datum : Datum waarop de laatste versie van het moduledossier tot stand kwam.
•    Online/Batch/Print programma : In dit vak wordt de aard van de programmamodule aangegeven.
•    Mag worden aangevraagd door : Hier wordt aangegeven wie geautoriseerd is voor het aanvragen van deze programma­module. Indien dit meerdere personen zijn, kan naar een autorisatielijsten worden verwezen.
•    Systeemnaam : Naam van het informatiesysteem waarvan de programmamodule deel uit maakt.
•    Deelsysteemnaam : Naam van het deelsysteem waarvan de programmamodule deel uit maakt.
•    Mag worden uitgevoerd door : Hier wordt aangegeven wie geautoriseerd is voor het draaien van deze programma­module. Indien dit meerdere personen zijn, kan naar een autorisatielijsten worden verwezen. Om het onderhoud op het productiedossier te beperken kan hier beter voor de functiebenaming dan voor de naam van de functiona­ris worden gekozen.
•    Platform : Van belang voor de wijze waarop de autorisatie worden toegekend is het te weten op welk platform de module draait. Binnen één informatiesysteem kunnen meerdere platforms aanwezig zijn.
•    Benodigde randapparatuur : Dit kan per programmamodule verschillen, het varieert van printers tot scanners en leespennen.
•    Schematische weergave Job : Met name bij batchjobs is het verstandig om met een flowdiagram aan te geven in welke volgorde de programmastappen worden doorlo­pen. Op deze wijze wordt in één oogopslag zichtbaar gemaakt op welke momenten randapparatuur nodig is en hoe na een onderbreking verder kan worden gedraaid.
•    Omschrijving : De functie van de programmamodule wordt in dit vak omschreven.
•    Frequentie/tijdstippen : Van elke programmamodule moet bekend zijn op welk moment hij draait. Dit is met name voor batchjobs van belang zodat een productie­planning is te maken. De starttijd en de te verwachten doorlooptijd zijn hierbij eveneens van belang.
•    Betrokken tabellen/CRUD-matrix : T.b.v. eventuele herstel acties is het belangrijk om te weten welke tabellen door een programmamodule worden benaderd. Deze tabellen worden in dit vak opgevoerd. D.m.v. een CRUD-matrix (Create/Read/Upda­te/Delete) wordt aangegeven welke acties op deze tabellen door de programmamo­dule worden uitgevoerd. Kan van belang zijn bij een eventuele restore van de backup.
•    Karakteristieken : Van programma’s zijn een groot aantal eigenschappen vast te leggen. In dit vak wordt aangegeven welke eigenschappen en instellingen de program­mamodule heeft. Zodoende kan systeembeheer het systeem voor het draaien van het programma zo optimaal mogelijk instellen met als doel die verwerking zo snel mogelijk en met de minste risico’s te laten verlopen.
•    Opstart parameters : Bij batches en lijsten moeten vaak parameters zoals een verwerkingsdatum of een bestandsnaam worden opgegeven. In dit vak geeft men op hoe deze parameters moeten zijn gevuld.
•    Instructies : Onder bepaalde omstandigheden kan het moduledossier onvoldoende gegevens bevatten om een programma af te werken. Dit kan bijvoorbeeld het geval zijn bij foutmeldingen. Voor die gevallen kan in dit vak naar aparte werkinstructies worden verwezen.
•    Mogelijke fout/returncodes : In een korte opsomming wordt kenbaar gemaakt welke fout- en returncodes het programma kan opleveren. Niet alleen de code wordt vermeldt maar tevens de foutsituatie.
•    Te volgen acties bij fout/returncodes : Per aangegeven fout/returncode wordt aangegeven welke actie moet worden uitgevoerd om de foutsituatie ongedaan te maken.

Klik hier (Moduledossier.pdf) om een voorbeeld moduledossier (PDF) te downloaden.


-- Printbare PDF-versie --