Hou je programmatuur in het oog, maak een moduledossier

De programmamodules die we tijdens het project en onderhoud maken moeten we goed documenteren. Deze documentatie heeft niet alleen betrekking op de inhoud en de opzet van het programma. De documentatie heeft ook betrekking op het gebruik. Meer specifiek gaat het om de gebruikersdocumentatie. Dat wil zeggen niet alleen de handleiding maar denk ook aan de productiedocumentatie in de vorm van een moduledossier.

Het moduledossier is in feite de gebruikershandleiding voor de systeembeheerders. Zoals de eindgebruiker 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 vaak om handelingen die we direct moeten uitvoeren. Gebruikers kunnen namelijk vastzitten of de verwerking is gestopt.

Toegankelijkheid van het moduledossier

Het is daarom van groot belang dat het moduledossier zeer toegankelijk is. Bijvoorbeeld in de vorm van een database. In de eerste plaats dient er een lijst met mogelijke foutcodes en hun oplossing te zijn. Daarnaast kunnen we per module een dossier aanleggen 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 het ook onmogelijk om van een vaste indeling af te wijken.

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

De in te vullen vakken van het moduledossier

Kenmerken

• 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 geven we de aard van de programmamodule aan.
• Mag worden aangevraagd door. Hier geven we aan wie geautoriseerd is voor het aanvragen van deze programma­module. Indien dit meerdere personen zijn, kunnen we naar een autorisatielijst verwijzen.
• 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 geven we aan wie geautoriseerd is voor het draaien van deze programma­module. Indien dit meerdere personen zijn, kunnen we naar een autorisatielijst verwijzen. Om het onderhoud op het productiedossier te beperken kunnen we hier het beste de functiebenaming invullen.
• Platform. Van belang voor de wijze waarop we de autorisaties toekennen is het te weten op welk platform de module draait. Binnen één informatiesysteem kunnen meerdere platforms aanwezig zijn. On premise of in de Cloud maar ook van verschillende fabrikanten.
• Benodigde randapparatuur. Dit kan per programmamodule verschillen, het varieert van printers tot scanners en leespennen. Denk ook aan specifieke netwerkapparatuur of bijzondere koppelingen.

Werking

• Schematische weergave Job. Met name bij batchjobs is het verstandig om met een flowdiagram aan te geven in welke volgorde de programmastappen verlo­pen. Op deze wijze maken we namelijk in één oogopslag zichtbaar op welke momenten randapparatuur nodig is. Tevens zien we hoe we na een onderbreking verder kunnen draaien.
• Omschrijving. De functie van de programmamodule omschrijven we in dit vak.
• Frequentie/tijdstippen. Van elke programmamodule moet bekend zijn op welk moment hij draait. Dit is met name voor batch-jobs 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 een programmamodule benadert. Ook de benaderingswijze is van belang. Deze tabellen voeren we in dit vak op. D.m.v. een CRUD-matrix (Create/Read/Upda­te/Delete) geven we aan welke acties het programma op deze tabellen uitvoert. Dit kan namelijk van belang zijn bij een eventuele restore van de backup.

Instructies

• Karakteristieken. Van programma’s zijn een groot aantal eigenschappen vast te leggen. In dit vak geven we aan 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 aan hoe we deze parameters moeten invullen.
• 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 kunnen we in dit vak echter naar aparte werkinstructies verwijzen.
• Mogelijke fout/returncodes. In een korte opsomming maken we kenbaar 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 geven we aan welke actie we moeten uitvoeren om de foutsituatie ongedaan te maken.

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

Discussieer mee op LinkedIn.