Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloed

HOE TECHNOLOGIE HET SCHRIJVEN VAN TECHNISCHE- EN BEDRIJFSDOCUMENTEN BEÏNVLOEDT

Luc Bouquet

Inleiding

Deze artikel heeft geen academische aspiraties. U moet het eerder beschouwen als een praktijkgetuigenis van iemand die de laatste twintig jaar gewerkt heeft als schrijver van technische en andere zakelijke documenten. Gedurende de afgelopen twintig jaar zijn de technologische hulpmiddelen voor de schrijver geëvolueerd van leuk speelgoed naar hulpmiddelen die we nog nauwelijks zouden kunnen missen, tenminste als we ons werk op een professionele manier willen uitvoeren.

In dit artikel wil ik het niet hebben over de technologie zelf, maar wel op de manier waarop ze de taal van onze documenten en het schrijfproces zelf hebben beïnvloed. Deze laatste evolutie is een stuk minder spectaculair dan de evolutie van de hulpmiddelen, maar ze is wel even belangrijk. Deze bijdrage gaat dus over hoe de technologie de macrostructuur en de microstructuur van technische- en bedrijfsdocumentatie heeft beïnvloed, en dat gezien door de ogen van een insider.

Ik wil eerst de trends beschrijven die ik gedurende de laatste twintig jaar in ons vakgebied heb opgemerkt. De voornaamste trend is uiteraard het gebruik van nieuwe technologieën. In tegenstelling met wat men zou kunnen denken, hebben deze nieuwe technologieën de schrijvers niet meer vrijheid gegeven; integendeel, ze leggen de schrijver steeds meer beperkingen op. Bijgevolg zien schrijvers van technische- en bedrijfsdocumenten zich verplicht om hun schrijfwijze aan te passen aan deze beperkingen, vooral dan door het aanwenden van gestandaardiseerde schrijfmethoden.

In deze lezing zal ik één van deze methoden behandelen, de methode die ik het beste ken: Information Mapping.

Tenslotte toon ik enkele voorbeelden van toepassing van deze methode. Dit zijn voornamelijk voorbeelden op een computerscherm. De schermafbeeldingen in dit artikel geven natuurlijk niet helemaal weer wat er tijdens de lezing op het scherm gebeurde.

1 Trends in technische- en bedrijfsdocumentatie 1.1 Groepsschrijven (collaborative writing)

De tijd is voorbij dat één schrijver of een kleine groep schrijvers verantwoordelijk was voor een document, vanaf het ontstaan ervan tot het maken van soms duizenden identieke kopieën.

Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet 407

De volgende oorzaken zijn daarvoor aan te wijzen:

•  toenemende specialisatie waardoor één enkele schrijver nog moeilijk de totale problematiek kan behandelen

•  weinig tijd om te schrijven, precies omdat schrijven geen voltijdse bezigheid is

•  steeds grotere complexiteit van de documenten

•  grotere documenten, denk bijvoorbeeld aan de omvang van een complete intranet-site

Deze evolutie verplicht meerdere schrijvers om bij te dragen tot hetzelfde document.

1.2 Van top-down naar bottom-up aanpak

De top-down aanpak is de traditionele manier om documenten aan te maken. De schrijver begint met het opstellen van een macrostructuur, een raamwerk van hoofdstukken en paragrafen waarbij hij/zij er zorg voor draagt dat er een evenwichtige verdeling ontstaat tussen de verschillende eenheden. Uiteindelijk wordt de structuur opgevuld met informatie. De top-down aanpak is echter enkel mogelijk onder de volgende zeer stringente voorwaarden:

•  het grootste deel van de broninformatie moet beschikbaar zijn voor men begint te schrijven, anders is het niet mogelijk een structuur op te zetten

•  de broninformatie mag niet te veel veranderen tijdens het schrijven, zoniet is het moeilijk om het evenwicht tussen de eenheden te behouden.

Deze voorwaarden zijn vandaag de dag nog zelden vervuld. Daarom zijn onze vakgenoten geneigd een andere aanpak te hanteren: de bottom-up aanpak. In deze aanpak werken verschillende schrijvers onafhankelijk van elkaar aan kleine documentbouwstenen, en dát naarmate de broninformatie ter beschikking komt. Het uiteindelijke document wordt pas samengesteld in de allerlaatste fase van het documentatieproces.

1.3 Single sourcing

Single sourcing betekent dat documentbouwstenen naar verschillende media worden gepubliceerd vanuit één enkel bronbestand. Sommige bouwstenen kunnen bijvoorbeeld worden gecombineerd tot een handleiding op papier, maar kunnen even goed dienen voor een on-line-help-toepassing, voor het intranet, het internet of zelfs voor het scherm van een mobiele telefoon.

Eerder dan uitvoerig opgemaakte tekst te schrijven voor een publicatie op papier, gaan schrijvers eerst brokken informatie schrijven die bedoeld zijn voor scherminformatie. De versie op papier komt pas later en is een compositie van de scherminformatie waaraan de pagina-opmaak later wordt toegevoegd.

Onderstaand voorbeeld toont een pagina uit een interne nieuwsbrief. De linkse versie is een zeer modulair opgesteld document dat zowel op papier als op een scherm goed te lezen valt. Deze brontekst wordt gebruikt voor conversie naar HTML zodat het op het intranet kan worden geconsulteerd. Maar dezelfde versie wordt opnieuw onder handen genomen

408 I Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet

door een graficus die er enkel lay-outtechnische veranderingen aan aanbrengt om het geheel aantrekkelijker te maken op papier.

1.4 Meta--informatie

Het bestaan van bedrijfsdatabases vereist dat ook documentbouwstenen in de database worden opgeslagen en eventueel gelinkt met bedrijfsprocessen alvorens ze worden gepubliceerd. Om dergelijke databases te kunnen beheren en de informatie die er in zit beter te kunnen exploiteren is het nuttig de informatie te verrijken met meta-informatie. De meest voor de hand liggende meta-informatie is de naam van de schrijver, datum, versienummer, goedkeuring enz. Meta-informatie maakt het mogelijk om intelligente zoekopdrachten uit te voeren op een document. Het is eveneens de meta-informatie die ervoor zorgt dat bepaalde fragmenten van een document 'conditioneel gepubliceerd' worden. M.a.w., afhankelijk van de meta-informatie die aan een fragment hangt wordt het al dan niet in het finale document opgenomen. Dat leidt tot toestanden waar één woord met meerdere regels meta-informatie kan zijn 'verrijkt'.

1.5 Standaarden

De huidige trend naar single sourcing en groepschrijven vraagt om standaarden zodat hergebruik, uitwisseling en combinatie van documentbouwstenen mogelijk wordt.

De eerste standaarden zijn ontstaan in de militaire wereld met SGML (Standard Generalised Mark-up Language) dat op zijn beurt afkomstig was uit CALS (Computerised Acquisition and Logistics System). Eén van de toepassingen van SGML was HTML (HyperText Mark-up Language), de standaard voor het Internet. XML (Extensible Mark-up Language) is een metataal die documentatiedeskundigen toelaat een bedrijfsspecifieke documentstructuur te ontwikkelen en op te leggen. De nieuwste trends zoals 'the Dublin Core' gaan in de richting van het standaardiseren van de meta-informatie.

Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet 1409

1.6 Virtuele documenten

Uiteindelijk komen we terecht bij virtuele documenten. Groepschrijvers, professionele schrijvers en deskundigen in een bepaald gebied schrijven alsmaar kleinere document-bouwstenen met weinig of geen context. Deze bouwstenen worden in de allerlaatste fase van het project, ad hoc, tot een document gecombineerd voor één enkele gelegenheid, voor een beperkt publiek, vaak zelfs voor één enkele lezer. Op basis van lezersprofielen worden specifieke bouwstenen tot een enkel document samengesteld, soms door een machine. Dit leidt ertoe dat ook kenniswerkers vervreemd, gealiëneerd worden van hun eigen product, net zoals Marx dit had opgemerkt bij de fabriekswerkers van de 19de eeuw.

1.7 Conclusie: meer beperkingen dan vrijheid

Na de uitvinding van de boekdrukkunst kregen we op een gegeven moment schrijvers aan de ene kant en typografen aan de andere kant. Ook in kantoren was dat het geval, althans tot in het midden van de tachtiger jaren van de twintigste eeuw: leidinggevenden en deskundigen gaven hun handgeschreven teksten aan een typist(e) of secretaresse die ze verder verwerkte.

Met de opkomst van 'desktop publishing' systemen rond 1985 was ineens iedereen typograaf. Ik weet niet of er ooit onderzoek naar gedaan is maar ik denk dat er een periode is geweest waarin sommige schrijvers meer tijd staken in het exploreren van de mogelijkheden van hun tekstverwerker (lees worstelen met hun tekstverwerker) dan met de inhoud van hun teksten. Maar in het licht van wat we zoëven hebben besproken is dit waarschijnlijk een fenomeen van voorbijgaande aard geweest.

We gaan terug naar een situatie waarin schrijvers platte tekst aanbieden, weliswaar voorzien van structuuraanwijzers. Tot overmaat van ramp -ogenschijnlijk- kunnen ze die structuuraanwijzers niet eens vrij aanmaken maar ze moeten ze kiezen uit een bestaande lijst. Technisch noemen we dat een DTD, een Data Type Definition.

Betekent dat nu dat schrijvers ondanks de technologie alleen maar slechte documenten kunnen schrijven? Niet noodzakelijk. Niet als ze beschikken over een methode die met de voornoemde beperkingen kan omgaan. Information Mapping is zo'n methode.

2 Information Mapping(R) een methode en een Standaard

De Information Mapping methode is niet enkel een methode om inhoud te structureren. Je kunt ze uiteraard gebruiken om documenten leesbaarder en toegankelijker te maken maar je kunt ook een stap verder gaan en ze gebruiken als een standaard. Een standaard als Information Mapping laat toe om aan `groepsschrijven' te doen. Dit ligt volledig in de lijn van de trends die ik hierboven heb vernoemd.

410 I Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet

2.1 De vier pijlers van de Information Mapping methode

De Information Mapping methode rust op vier pijlers:

- de eenheden van informatie

- de taak- en gebruikergeoriënteerde analyse

- de zeven informatietypes

- de op wetenschappelijk onderzoek gebaseerde basisprincipes.

2.2 De eenheden van informatie

De Information Mapping methode begint met het definiëren van de eenheden van informatie. Het informatieblok is de kleinste eenheid van informatie. Informatieblokken zijn een soort containers om informatie in op te bergen; ze zijn beperkt qua grootte. Een blok kan tekst bevatten, of een opsomming, een tabel, een tekening een audio- of een videofragment. De inhoud van een blok mag nooit het onmiddellijk geheugen van de lezer overschrijden. Zo zal een opsomming bijvoorbeeld nooit meer dan 7±2 elementen bevatten.

Het grotere geheel is de Informatiemap. Een informatiemap kan maximaal 7±2 informatieblokken bevatten.

2.3 Taak- en gebruikergeoriënteerde analyse

Schrijvers die de IMAP-methode gebruiken maken altijd eerst een analyse van de doelgroep in termen van 'actie' en 'kennis', met andere woorden van `doe'- en 'weet'-informatie. Ze maken eerst een overzicht van de actie welke ze verwachten van de lezer, op basis van het document. Pas daarna zullen ze voor elke actie bepalen of er bijkomende kennisinformatie dient te worden verstrekt zodat de lezer de actie kan uitvoeren.

Onderstaande tabel bevat een voorbeeld van een eenvoudige taakanalyse die tot doel heeft een gebruiksaanwijzing te schrijven voor het gebruik van een bloeddrukmeter. De linkse kolom 'Actie' geeft een overzicht van de taken die de lezer moet kunnen uitvoeren met behulp van de gebruiksaanwijzing. Voor elke taak staat in de rechtse kolom aangegeven welke kennis vereist is zodat de lezer de taak kan uitvoeren.

Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet 1411

2.4 De zeven informatietypes

De acties in het voorbeeld hierboven behoren allen tot het informatietype 'Procedure'. Kennis, daarentegen kan uit meerdere informatietypes bestaan. Met de informatietypes raken we de kern aan van de Information Mapping methode. De informatietypes geven ons een houvast om informatie in te delen in kenniscategorieën. Onderstaande tabel geeft een overzicht van de zeven informatietypes; elk informatietype wordt bondig omschreven en van enkele voorbeelden voorzien.

412 l Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet

Bij wijze van voorbeeld tonen we opnieuw de tabel onder 'Taak- en gebruikergeoriënteerde analyse' maar nu met een bijkomende rechterkolom die het informatietype van elk kenniselement bevat:

2.5 Van informatietype naar sleutelblok

Het bepalen van het informatietype is slechts een tussenstap. Voor elk informatietype geeft de methode een aantal presentatiewijzen om de betreffende informatie voor te stellen. Die presentatiewijzen noemen we sleutelblokken.

Onderstaande tabel toont de zeven informatietypes, samen met de sleutelblokken die kunnen worden gebruikt om de informatie voor te stellen:

Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet 1413

2.6 De basisprincipes

De methode wordt vervolledigd met de zgn. zeven basisprincipes. Dit zijn principes die technische en zakelijke schrijvers hoedanook toepassen.

De volgende tabel geeft een overzicht van deze principes, telkens met een korte uitleg:

3 Toepassingen van Information Mapping en nieuwe technologieën

Voorbeeld 1: van versie op papier naar HTML

De eerste schermafbeelding toont een database waarin de informatiemappen zijn opgeslagen in een dynamische en flexibele structuur. Je zou dit een 'virtueel' document kunnen noemen. Elke informatiemap (witte document-ikoontjes) stelt één MS-Word bestand voor.

414 I Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet

Onderstaande schermafbeelding toont hoe de Word-bestanden eruit zien. De schrijvers maken informatieblokken aan met behulp van een aangepaste knoppenbalk:

Tenslotte volgt hier de HTML-versie die bijvoorbeeld op het bedrijfsinterne intranet te zien is. Het frame links laat de lezer toe door het document te navigeren. Het frame rechts bevat de informatiemap met de verschillende blokken.

Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet 415

Voorbeeld 2: van versie op papier naar multimedia-animatie

De eerste schermafbeelding toont de Word-versie die als basis heeft gediend voor de versie op papier. De procedure staat in een stappentabel:

De volgende schermafbeelding toont hetzelfde informatieblok, nu met een geanimeerde proceduretabel. De lezer kan door de procedure klikken en ziet enkel de informatie die voor hem/haar relevant is.

Voorbeeld 3: Word + )(XML en presentatie in functie van de meta-informatie

Hier beginnen we op nieuw met een Word-bestand. De schrijvers kunnen met behulp van een sjabloon een gemapte tekst invoeren. Het sjabloon laat eveneens toe meta-informatie in te voeren. In dit geval kan de schrijver voor elk blok het IMAP-informatietype aangeven.

Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet 1 41 7

Het volgende scherm toont de standaard HTML-versie waarin alle blokken worden getoond in dezelfde volgorde als in het brondocument:

41 8 1 Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet

De volgende schermafbeelding toont een alternatieve presentatie van dezelfde broninformatie. De lezer ziet alleen de procedures; informatie die behoort tot een ander informatietype moet afzonderlijk aangeklikt worden om ze te kunnen lezen.

Hoe technologie het schrijven van technische- en bedrijfsdocumenten beïnvloedt - L. Bouquet 1419