Vijf voordelen van modulaire content

Gebruikers van een ‘Component Content Management System’ (CCMS) of misschien zelfs SCHEMA ST4, zijn al vertrouwd met het begrip ‘modulaire content’.

De inhoud of ‘content’ in deze systemen bestaat uit afzonderlijke modules die kunnen worden samengebracht om volledige documenten vormen. Een individuele module kan echter ook op zichzelf staan als bijvoorbeeld een aparte HTML-pagina op een systeemcontrolepaneel of -tablet.

Dit basisprincipe van modularisering is heel belangrijk voor het technisch schrijven en biedt vele voordelen.

In deze post doen we vijf van die voordelen uit de doeken.

Eén module kan worden geïmplementeerd in tig contexten

Bij lineair schrijven in bijvoorbeeld Word-documenten kan de inhoud vaak alleen in andere contexten worden gebruikt door te kopiëren en plakken, terwijl dat bij modulair schrijven veel gemakkelijker kan. Een module wordt één keer aangemaakt en kan vervolgens in verschillende contexten worden ingezet. Als de technisch schrijver de inhoud van de module wijzigt, wordt die wijziging dynamisch overgenomen op alle andere plaatsen waar de module is gebruikt. De koppeling tussen de module en de plaats waar hij wordt gebruikt, geldt voor alle gebruikte talen, varianten en documenttypen. De module staat op zichzelf, zodat hij in verschillende contexten kan worden gebruikt.

Een goed voorbeeld van een module is de functionele beschrijving of de montage-instructies voor een onderdeel van een systeem. Als dat onderdeel ook in andere systemen wordt gebruikt, kan de betreffende module ook in de bijbehorende documentatie worden hergebruikt.

Metagegevens om modules gemakkelijker te vinden en beheren

Elke module heeft metagegevens met informatie over het type module (bv. instructie, beschrijving …), de doelgroep en nog veel meer. Veel informatie, zoals productvarianten of zelfs metagegevens uit de iiRDS-context, doet dienst als metagegevens. Met metagegevens worden modules geclassificeerd en beheerd in geautomatiseerde systemen, en kunt u bovendien sneller en efficiënter de exacte module vinden die u zoekt. Voor zulke zoekopdrachten wordt er in alle modules gezocht naar metagegevens of een combinatie van metagegevens. Als zoekresultaat krijgt u dan alle relevante modules, bijvoorbeeld alle modules van het type ‘instructie’ voor variant A die nog niet zijn vertaald.

Wanneer we kijken naar de varianten geldt bijvoorbeeld een instructie over hoe specifieke stamgegevens worden gecreëerd in softwarevariant A (bv. ‘Premium’) ook voor softwarevariant B (‘Classic’), maar niet voor softwarevariant C (‘Light’). Als de metagegevens voor de module goed worden onderhouden, kunnen ze via die criteria worden gevonden. Daarnaast kunnen de metagegevens ook nog worden gebruikt om automatisch documenten samen te stellen die bijvoorbeeld alleen modules voor variant A bevatten.

Modularisering betekent standaardisatie – en dus een beter overzicht

Wie werkt met modulaire content, zal vroeg of laat ook wel standaardiseren. Dat omvat standaard tekstformuleringen, moduletypes en modulegroottes, een archiveringssysteem voor modulebeheer en zo verder. Voor technisch schrijvers betekent dat dat ze duidelijke richtlijnen hebben voor hun dagelijkse handelingen in het CMS, waardoor hun werk wordt vereenvoudigd en misverstanden worden vermeden.

Gemodulariseerde content staat dus quasi synoniem voor gestandaardiseerde content in combinatie met een gestandaardiseerd schrijfproces, en dat heeft een positief effect op alle daarop volgende processen.

Nog twee andere voordelen van een uniforme en herkenbare structuur in modulaire content:

De kwaliteitsborging voor het schrijfproces en de technische controles kan aanzienlijk worden vereenvoudigd en versneld. Controles in een CCMS worden namelijk beperkt tot de content die nog moet worden goedgekeurd. Dankzij de metagegevens van alle modules weet het CMS of de content al een schrijf- of technische goedkeuring heeft gekregen.
Het is gemakkelijker voor technisch schrijvers (en ook voor eindgebruikers in het geval van content delivery) om te vinden wat ze zoeken.

Kwalitatievere output dankzij modulaire content

De modularisering, classificatie en standaardisatie van de content verbetert de kwaliteit van de documentatieproducten en schrijfprocessen.

Een CCMS zoals SCHEMA ST4 kan gestructureerde modulaire content zelfstandig interpreteren en bijvoorbeeld lay-outs bepalen die zijn afgestemd op het doelformaat. Alle uitvoerformaten voor alle varianten en talen zijn op die manier centraal gestuurd, en de gestandaardiseerde lay-outs vermijden onaangename verrassingen tijdens de publicatie (zoals soms te zien is bij afbeeldingen in Word). Het resultaat: dezelfde informatiesamenstelling, dezelfde structuur, dezelfde lay-out en hetzelfde design.
Door modulaire content te hergebruiken hoeft er minder nieuwe content te worden gecreëerd voor nieuwe projecten of varianten. Componentcontent-managementsystemen verlichten de administratieve last van technisch schrijvers, omdat ze het overzicht kunnen bewaren over welke modules waar worden gebruikt en zo ook weten welke modules nog moeten worden vertaald of al vertaald zijn én in welke talen. Dat reduceert aanzienlijk de vertaaltijd en -kosten én verhoogt de kwaliteit.
Aangezien de standaarden van toepassing zijn op alle modules en de modules mogelijk al zijn vertaald, wordt de hoofdtaak van de technisch schrijvers – het creëren en beheren van content – eenvoudiger en efficiënter. Zij hoeven zich slechts nog drie vragen te stellen: Zijn alle modules beschikbaar voor het huidige project? Zo nee, welke moeten er nog worden gecreëerd? En welke modules vragen welk doeldocument voor dit project?

Content in flexibele outputformaten dankzij modularisering

Contentcreatie met behulp van een componentcontent-managementsysteem zoals SCHEMA ST4 is media-neutraal. Dat betekent dat de inhoud, de structuur en de lay-out van uw uitvoerformaten onafhankelijk van elkaar worden gecreëerd en bewerkt. Zo kan de inhoud naar wens worden samengesteld en wordt de individuele lay-out pas achteraf toegepast, specifiek voor het beoogde uitvoerformaat.

Zo zal in het geval van softwaredocumentatie bijvoorbeeld een module van het type ‘instructie’ zowel deel uitmaken van de documentstructuur van de gebruikershandleiding in PDF-formaat als van een HTML-pagina die is verbonden met een software-interface.

U merkt het al, de voordelen van modulair werken zijn met elkaar verbonden en in onze beschrijving zijn zo goed als alle parameters voor modulair werken opgesomd. We hebben de belangrijkste voordelen uiteengezet, maar u zult er zelf vast nog meer ontdekken.

Wilt u er meer over weten? Wilt u graag een presentatie of een vrijblijvende demonstratie? Neem gerust contact met ons op.

Informatieaanvraag