OJECT 
Documentatie is een belangrijk deel van de levering van een DCS systeem. Het belang ervan werd tijdens de enquête van dit onderzoek door eindgebruikers hoger beoordeelt dan door de DCS leveranciers.
Het opzetten en vervaardigen van een goed documentatiepakket laat bij veel leveranciers, contractors, installateurs en system integrators vaak te wensen over. Het is helaas geen uitzondering dat de documentatie pas wordt vervaardigd nádat het besturingssysteem afgeleverd en opgestart is. De eindgebruiker zal in een heel vroeg stadium zijn wensen kenbaar (moeten) maken om er voor te zorgen dat hij in staat is om, zonder al te veel moeite, het systeem te onderhouden, aan te passen en uit te breiden[1]. Hieronder wordt onder andere het doel, richtlijnen en eigenschappen van een goed documentatiesysteem omschreven.
Deze paragraaf is onderverdeeld in de volgende secties:
Het doel van documentatie is om de gebruiker op een duidelijke en efficiënte manier voldoende informatie te geven zodat hij in staat is om de installatie te gebruiken, te onderhouden en om het gewenste product te produceren[2].
Het statement van "Gebruikers willen geen documentatie, ze willen antwoorden[3]” geeft in essentie goed aan waar het echt om draait. Door de vraag naar 'verticale integratie' waarbij werkvloer en management steeds vaker gebruik maken van elkaars gegevens, is een goed inzicht en overzicht van alle verbindingen in de letterlijke en figuurlijke zin van het woord daarom belangrijk. Ook bij het uitbreiden en wijzigen van de installatie moet een systematische en controleerbare aanpak gegarandeerd zijn; een goede basisdocumentatie is daarbij een onontbeerlijk hulpmiddel.
Een typische procesbesturingsinstallatie bestaat uit meerdere lagen, de automatiseringsystemen. Zoals analyse apparatuur, DCS systemen, PLC, hybride systemen, veiligheidssystemen, proces historie systemen, advance control en procesnetwerken. Bij veel bedrijven ligt de kennis van de interacties tussen de verschillende deelsystemen bij enkele van de site engineers en technici. De documentatie die veel leveranciers leveren gaat vaak alleen over hun eigen systeem en is daarmee alleen een gedeeltelijke oplossing van de documentatie behoefte[4].
De taakstelling waar de documentatie dan ook aan moet voldoen zijn:
Goede documentatie zal de eindgebruiker antwoorden op de volgende vragen kunnen geven:
Het is van belang om samen met de DCS leverancier afspraken te maken hoe en conform welke standaarden de documentatie wordt aangeboden.
We kunnen de standaarden en richtlijnen in een aantal subgroepen onderverdelen:
De Europese CE markering bestaat uit eisen en richtlijnen met als doel de ontwikkeling van algemeen geldende technische voorschriften in de hele EU te realiseren en in welke vorm dit gedocumenteerd moet worden.
De voorschriften ten aanzien van de typen technische specificaties zijn de[11]:
De volgende onderdelen worden in de hEN, ETAG of CUAP beschreven[12]:
De CE richtlijn stelt dat een bedrijf moet beschikken over een gedocumenteerd Factory Production Control (FPC) systeem dat gericht is op de belangrijke stappen in het voortbrengingsproces.
De betrokkenheid van een Notified Body bij de bepaling van de productconformiteit conform is afhankelijk van de in de Europese technische specificatie vastgelegde toezicht.
De volgende onderwerpen dienen conform de CE richtlijn te worden beschreven:
Deze Nederlandse praktijkrichtlijn uit 1993 geeft richtlijnen en voorbeelden voor het samenstellen van een basisdocumentatiepakket voor procesbesturingsinstallaties. De praktijkrichtlijn geeft aan hoe een basisdocumentatiepakket kan worden opgezet. Er worden groepen documenten gegeven die worden gebruikt en/of nodig zijn tijdens opeenvolgende fasen in de technische realisatie van procesbesturingsinstallaties en –systemen in hoofdzaak voor de procesindustrie. Het totale pakket is naast de voorstudie, ontwerp en de montage van een procesbesturingsinstallatie ook van belang voor de bedrijfsvoering en het onderhoud. Hiertoe zullen veel documenten na het opstarten van het project moeten worden gereviseerd zodat ze "as-built" zijn. Als regel zal de opdrachtgever aangeven welke documenten "as-built" moeten worden opgeleverd[13].
Binnen de beroepsorganisatie (ISA) zijn de onderstaande standaarden opgesteld[14].
Bij een aantal branches wordt gewerkt met een eigen set van standaarden en richtlijnen een aantal daarvan zijn:
Veel grote ondernemingen hebben hun eigen interne standaarden, soms afgeleid van een internationale richtlijn soms intern ontwikkeld. Als een DCS leverancier hieraan zal moeten voldoen kan dit leiden tot hogere kosten in het project.
De DCS leveranciers hebben een intern proces om de documentatie te verzorgen en zij zullen dit systeem gebruiken als de eindgebruiker geen andere norm stelt. Soms is dit een standaard van één van hun grote klanten bijvoorbeeld Shell.
De systeemdocumentatie wordt over het algemeen door de DCS leverancier centraal opgebouwd en onderhouden. De applicatie- en projectdocumentatie zullen per project worden opgesteld en kan opgezet worden conform de hiervoor genoemde documentatie mogelijkheden.
Opdrachtgever en uitvoerder stellen als regel in onderling overleg vast hoe en waaruit het basisdocumentatiepakket wordt samengesteld. Ook als de opdracht door de eigen engineeringsafdeling wordt uitgevoerd is dit absoluut noodzakelijk. Als meer dan één afdeling of onderaannemers bij het project betrokken zijn dan dienen alle documenten op één en dezelfde manier vervaardigd te worden om misverstanden te voorkomen en de uitwisselbaarheid van gegevens te waarborgen. In de praktijkrichtlijn zijn een vijftigtal publicaties en voorschriften met betrekking tot procesinstrumentatie, procesbeveiliging, procesbesturing en alarmeringen in procesinstallaties vermeld. Een documentatiepakket hoeft lang niet altijd alle vermelde documenten te bevatten en kan met andere, niet vermelde documenten, worden uitgebreid.
Tijdens de loop van het project kan en moet waar nodig, het basisdocumentatiepakket worden gewijzigd en aangepast aan de gang van zaken. Het is handig om een documentatie stroomdiagram te hanteren en op ieder document de titel uit het stromingsdiagram te vermelden.
Daaronder kan dan desgewenst een nadere aanduiding van de inhoud worden gegeven. Wanneer een tekening, schema of dergelijke niet voor zich zelf spreekt is het aan te raden los een verduidelijking toe te voegen.
Hieronder staat een lijst met eigenschappen van goede documentatie zoals:
Voor de gebruikers
Opzet
Compleetheid
Onderhoud
Juistheid
Tijdigheid
De praktijk leert dat deze laatste loodjes vaak zwaar wegen, omdat de contractor/leverancier inmiddels de aandacht op andere opdrachten richt. Het is dus zaak hierover vooraf goede afspraken te maken en voldoende menskracht bij het project betrokken te houden tot ook dit deel van de opdracht naar wens is uitgevoerd![16]
Zoekfuncties
Als een gebruiker iets niet kan vinden in de documentatie, vanuit zijn blikveld, zal hij de documentatie als onvolledig beschouwen en er van uitgaan dat het er niet instaat.
De meeste moderne documentatie is in te delen in twee hoofdgroepen betreft verschijningsvorm:
Moderne papieren documenten, zoals boeken of handleidingen, zijn niet volgeschreven met een minimale regelafstand met kleine lettertjes.
Bijvoorbeeld, papieren documentatie die gebruik maakt van niet-gedrukte gebieden, bekend als witruimte. Witte ruimte, zoals het inspringen van een paragraaf, vermindert de lezer intimidatie en vermindert de vermoeidheid.
De gedrukte documentatie is onder te verdelen in:
Elektronische documenten, zoals een online help of website, dienen korte onderwerpen te bevatten. Elektronische documenten gebruik vaak een kleur ter verbeteren van de leesbaarheid en kunnen ook animatie bevatten voor zinvolle demonstratie doeleinden.
Het te beschrijven onderwerp zou behandeld moeten worden in maximum van twee schermen. Indien nodig, kan een onderwerp ook van pop-ups worden voorzien voor een snelle uitleg en hyperlinks naar aanverwant materiaal.
De elektronische documenten zijn onder te verdelen in:
De opbouw en samenstelling van een basisdocumentatiepakket moet zo zijn dat het een overzichtelijk en inzichtelijk geheel vormt. Het pakket moet alle documenten bevatten die nodig zijn voor het tot stand brengen en onderhouden van de procesbesturingsinstallaties. Als voorbeeld van een aantal projectfasen kan gedacht worden aan de fasen zoals aangegeven in de tabel (zie appendix E9). Het is zaak dat aan het einde van iedere projectfase een aantal basisdocumenten gereed zijn. Dit is van groot belang omdat deze basisdocumenten weer dienen als startdocument voor de volgende fase. Een goede voortgangscontrole is daarom een vereiste.
Het zal in de praktijk overigens nog al eens voorkomen dat documenten uit een eerdere projectfase moeten worden aangepast als gevolg van activiteiten tijdens de volgende fase. Een ander gegeven is dat een zekere overlapping van projectfasen zal optreden. De operationele, technologische en veiligheidsaspecten, inclusief de wettelijk bepaalde worden tijdens de projectfasen 0 en 1 in documenten vastgelegd.
Zonder in te gaan op precieze definities van ieder document (zie NPR 5269 Appendix E9) blijkt dat er nogal wat documentatie vervaardigd moet worden.
Er is dan ook nogal wat geld mee gemoeid en wellicht is dat de reden dat er vaak geen al te goede documentatie wordt geleverd. Besef echter dat een veelvoud van de kosten moet worden gemaakt als later onderhoud, wijzigingen en uitbreidingen moeten worden doorgevoerd zonder dat de organisatie beschikt over goede en up-to-date gehouden documenten.
Denk hier bij aan een engels gezegde: Wees niet pennywise en pound foolish[17].
“Documenting software architectures Views and Beyond Paul Clement
Zie ook boek ISA-Instrumentation, Systems, and Automation (October 2004)
[1] Veenbrink A.R, "Eindgebruiker van procesbesturingsinstallaties heeft recht op een goed basisdocumentatiepakket," Automatie, november, 1996, 302.
[2] Meijer Fred, "Control System Documentation," in A Guide to the Automation Body of knowledge, ed. Trevathan L. Vernon (NC: ISA, 2006), 75.
[3] Techscibe, 25 september, 2006, "What Is Good Documentation?," http://www.techscribe.co.uk/techw/whatis.htm. (accessed 13 januari, 2008).
[4] Tejani Riaz, Houston, to author, 7 juni, 2007, PAS Integrity MOC proposal, Houston.
[5] Self Tony, Beyond Software Manuals and Online Help: Interactive Help (: Tony, 1999), 6-5; quoted in N.a, What is good documentation?, ed. http://www.techscribe.co.uk/techw/whatis.htm (: , 2007).
[6] Kicker Clover, "Howto: Write Bad Documentation That Looks Good," Kuro5hin, 30 september, 2003, http://www.kuro5hin.org/story/2003/9/29/104212/112/ (accessed 8 januari, 2008).
[7] Bentvelsen Ysolde, "Informatie Beheren," Carrieretijger, 2004, http://www.carrieretijger.nl/functioneren/professionele-vaardigheden/eigen-werk-organiseren/informatie-beheren/ (accessed 7 janauari, 2008).
[8] Hendrikx Van Der Spek, "Goede Documentatie: Onmisbaar!," http://www.hvds.nl/index.html?http://www.hvds.nl/cgi-bin/artikel.cgi?ID=498/ (accessed 13 januari, 2008).
[9] Johan Wolt, interview by author, December, 2007, Plant maintenace manager AKZO NOBEL MEB.
[10] Tejani Riaz, Houston, to author, 7 juni, 2007, PAS Integrity MOC proposal, Houston
[11] Kuil J.R, "Presentatie Ce Markering Botlekgroep," Botlekgroup, 28 october, 2004, http://www.procos.nl/BOTLEK/presentaties/2004/20041028%20-%20CE%20FPC%20-%20J.R.%20Kuil.pdf. (accessed 13 januari, 2008).
[12] [12] Kuil J.R, "Presentatie Ce Markering Botlekgroep," Botlekgroup, 28 october, 2004, http://www.procos.nl/BOTLEK/presentaties/2004/20041028%20-%20CE%20FPC%20-%20J.R.%20Kuil.pdf. (accessed 13 januari, 2008).
[13] Nederlands Normalisatie Instituut, 01 januari, 1993, "Meet- En Regeltechniek - Basisdocumentatiepakket Voor Procesbesturingsinstallaties," http://www2.nen.nl/nen/servlet/dispatcher.Dispatcher?id=BIBLIOGRAFISCHEGEGEVENS&contentID=087117/ (accessed 13 januari, 2008).
[14] ISA, 2007, "Isa Documentation Standards And User Resources For Industrial Automation And Control Systems," http://www.isa.org/Template.cfm?Section=Standards2&template=/Ecommerce/ProductDisplay.cfm&ProductID=9000/ (accessed 13 januari, 2008).
[15] Devonia, "What Is Good Documentation?," http://www.devonia.com/text-documents.htm#complete#complete/ (accessed 8 januari, 2008).
[16] Veenbrink A.R, "Eindgebruiker van procesbesturingsinstallaties heeft recht op een goed basisdocumentatiepakket," Automatie, november, 1996, 302.
[17] Veenbrink A.R, "Eindgebruiker van procesbesturingsinstallaties heeft recht op een goed basisdocumentatiepakket," Automatie, november, 1996, 302.
[18] Spek Hendrikx van der, "Goede Documentatie: Onmisbaar!," Hendrikx Van Der Spek, http://www.hvds.nl/index.html?http://www.hvds.nl/cgi-bin/artikel.cgi?ID=498/ (accessed 8 januari, 2008).
When you need specific information please send my a e-mail.
18-10-2009
