De bekende slogan voor recycleren vormt ook een strategie voor goede documentatie: Stroomlijn en hergebruik je content waar mogelijk. Zo kan je er het meeste uithalen en efficiënter werken.
Meer halen uit minder
Zoeken naar goeie recepten op het internet wordt meer en meer eindeloos scrollen door familieanekdotes over hoe het recept door de generaties heen geëvolueerd en geperfectioneerd is, voor je te weten komt hoeveel eieren je nu precies nodig hebt.
Minimalisme is een schrijfstrategie die je helpt om bij de les te blijven en de vragen van je lezer te beantwoorden zonder die te overweldigen met overbodige informatie. In goede documentatie moet elk stuk tekst één vraag beantwoorden en niet meer. Wanneer we dit concept van minimalisme toepassen op onze prozaïsche recepten, reduceren we de tekst tot twee cruciale blokken: een ingrediëntenlijst en de instructies. De familiegeschiedenis mag dan ontroerend zijn, lezers willen vooral gewoon weten wat ze moeten doen.
In goede documentatie moet elk stuk tekst één vraag beantwoorden en niet meer.
Een ander aspect van minimalistisch schrijven passen we vaak al toe zonder het zelf te beseffen. Je kan een recept opstellen over ‘traditionele bara brith met geconfijte citrusschil’, maar je gaat die woorden niet herhalen in elke zin. In plaats daarvan spreek je gewoon over ‘vruchtencake’ of kortweg ‘cake’ omdat dit nu eenmaal sneller schrijft.
In een handleiding ga je op gelijkaardige manier niet elke keer de volledige productnaam herhalen, maar schrijf je best gewoon ‘de machine’ of ‘de software’. We kunnen wat inspiratie halen uit wettelijke teksten en aan het begin van een document dit inleiden met “hierna ‘de software’ genoemd”. Zo weet de lezer meteen wat te verwachten.
Op die manier kan je met minimalisme je teksten sneller en intelligenter schrijven, en vinden je lezers ook sneller de informatie die ze zoeken. Daar bovenop verlaagt het vertaalkosten en stoomt het je teksten klaar op hergebruik.
Contentrecepten
We laten de cakerecepten even zijn en concentreren ons op machines. Beeld je in dat je een onderhoudsinstructie voor mixers aan het schrijven bent. De verschillende mixertypes lijken op elkaar maar zijn niet identiek. Hoe pak je dat aan? Je kopieert wellicht de handleiding voor één type, verandert de titel, wat tekst en de afbeeldingen en klaar is kees.
Je hebt tijd bespaard op die tweede handleiding, maar op lange termijn heb je nu twee (bijna) identieke handleidingen die zorgvuldig nagekeken moeten worden. Want als er fouten in het eerste document stonden, dan zijn die nu mee gekopieerd naar het tweede document en mogelijks naar alle andere die erop gebaseerd zijn.
In plaats daarvan kan je de handleidingen aanpakken met minimalisme in het achterhoofd: je breekt het document op in kleinere hapklare blokken en kijkt welke uniek zijn voor een mixertype en welke meerdere keren gebruikt worden. Hiermee kan je aan de slag om een contentrecept op te bouwen: een plattegrond of architectuur die bepaalt hoe je documenten kan samenstellen met hergebruikte content.
Eén update, automatisch overal toegepast. 'Linked reuse.'
Voor dit hergebruik gaan we dan niet copy-pasten, maar doen we aan linked reuse. Dit houdt in dat we informatie ergens centraal schrijven en ernaar linken (of verwijzen) in verschillende documenten. Wanneer je een aanpassing maakt in de bron, wordt het overal automatisch toegepast.
Goede documentatie: Stroomlijn en hergebruik je content
Hoe meer schrijvers en handleidingen je hebt, hoe meer je kunt halen uit een centrale database van hergebruikte blokken tekst. Zo schrijf je sneller en update je sneller. Je informatie wordt zo ook consistenter in alle handleidingen, wat je vertalingen ook ten goede komt.
Dit allemaal omdat je vanaf het begin minimalisme hebt toegepast: Je breekt je documenten in kleinere stukjes (de familiegeschiedenis staat los van de ingrediëntenlijst en de instructies) en je hebt je tekst intelligenter verwoord (‘cake’ in plaats van ‘traditionele bara brith met geconfijte citrusschil’) waardoor het in meer contexten relevant is en hergebruikt kan worden.
Als alle schrijvers werken volgens hetzelfde contentrecept, werkt iedereen efficiënter. Hergebruik je content en zo kan je eindgebruiker genieten van goed gestructureerde en consistente documentatie die up-to-date is.