Case study: fifthplay – 4 handleidingen voor de prijs van 1


Posted on July 9th, by Yves in Blog. No Comments

Onze klant fifthplay is een innovatief Belgisch bedrijf dat vernieuwende technologieën voor slim energiebeheer ontwikkelt en produceert. Voor particuliere klanten ontwikkelden ze de Smart Energy box en de Smart Thermostat Touch, waarmee je zowel thuis als vanop afstand jouw elektrische apparaten en verwarming kunt bedienen.

Toen fifthplay samen met de Nederlandse nutsleverancier DELTA in zee ging om deze toestellen op de markt te brengen, besloten ze dat het tijd werd voor een grondige update van de documentatie. En dus kwamen ze bij ons terecht.

De verwachtingen

Een snelstartgids en een uitgebreidere gebruikershandleiding in pdf-formaat. En een versie daarvan in de fifthplay-huisstijl, en eentje in de DELTA-huisstijl.

De oplossing

We schreven alles volgens de DITA-principes, een topic-geöriënteerde xml-standaard om inhoud te schrijven en te publiceren. Klinkt dat als Chinees in de oren? Hieronder vind je een opsomming van de voordelen die deze methode omvat, in niet-Chinees.

Modulaire aanpak

We delen alle inhoud op, tot op het laagste niveau. Concreet betekent dit dat elke titel en de daarbijhorende inhoud als apart document bestaat. Deze documenten noemen we topics. Door op dit niveau te werken, kunnen we gemakkelijk informatieblokken aan de handleiding toevoegen of er weer uithalen.

Bijvoorbeeld: Bedrijf A biedt de zonnepaneelmodule aan, bedrijf B doet dit niet. Voor bedrijf B haal je dus simpelweg alle topics die naar de zonnepaneelmodule verwijzen uit de handleiding.

Makkelijk herbruikbare inhoud

Doordat we alles modulair opbouwen, kunnen we deze aparte topics heel gemakkelijk hergebruiken.

Bijvoorbeeld: We ‘recycleerden’ de inhoud van de snelstartgids en hergebruikten hem in de gebruikershandleiding.

Herbruikbare inhoud

Gebruik van informatiefilters

Door zogenaamde attributen toe te kennen aan bepaalde stukken tekst, kunnen we informatie filteren. Hierdoor kunnen we bepaalde tekst niet – of net wel – zichtbaar maken in de uiteindelijke, gepubliceerde handleiding.

Bijvoorbeeld: Eenzelfde topic kan zowel in de snelstartgids als in de gebruikershandleiding gebruikt worden, maar de uitgebreidere technische gegevens zijn alleen zichtbaar in de gebruikershandleiding, niet in de snelstartgids.

Goedkopere vertalingen

De topics hoeven slechts eenmaal vertaald te worden, en niet telkens de hele handleiding opnieuw. De inhoud wordt immers niet gekopieerd en in elke handleiding geplakt, het is dezelfde inhoud die op verschillende plaatsen gebruikt wordt. Dus eenzelfde vertaling wordt ook op verschillende plaatsen gebruikt.

Consistentie in terminologie

Alle terminologie, zoals termen die gebruikt worden in de applicatie en hyperlinks, verzamelen we in 1 enkel document: de ‘conref library’. Elke term in de conref library krijgt een uniek verwijzingsnummer (ID) mee. Wanneer we in een topic een bepaalde term nodig hebben, dan typen we die term niet gewoon in de topic zelf, maar voegen we een content reference (conref) in. Deze conref is eigenlijk een verwijzing naar het ID van de term in de content library. Hierdoor haalt een topic deze term gewoon op in de conref library, zodat hij voor de eindgebruiker leesbaar wordt alsof de term gewoon in de topic getypt was. Dit lijkt veel gedoe, maar een conref invoegen duurt veel minder lang dan uitleggen hoe een conref eigenlijk werkt. En het loont: tijdens het vertalen hoeft elke term slechts eenmaal vertaald te worden, en niet telkens als hij gebruikt is. En als een term vervangen wordt door een nieuwere term, dan hoef je die term alleen maar in de conref library aan te passen om overal in de handleiding de juiste term te krijgen. En de nieuwe term moet ook slechts eenmaal vertaald worden.

Inhoud staat los van layout en output

Alle inhoud wordt geschreven als topics in xml-formaat. Vanuit deze topics kan naar een waaier van outputformaten gepubliceerd worden.
Bijvoorbeeld: Fifthplay koos ervoor om beide handleidingen als pdf te publiceren. DELTA koos er dan weer voor om de gebruikershandleiding als pdf te publiceren, maar om de snelstartgids als Word (rtf) te publiceren en zelf voor een manuele opmaak in InDesign te zorgen. Dit alles werd gepubliceerd vanuit dezelfde topics. En met die topics kan je bijvoorbeeld ook nog eens webhelp publiceren. Eén bron, verschillende resultaten.

Inhoud versus layout

Branding

Voor elke nutsleverancier die de fifthplayproducten op de markt brengt, moeten we zowel de snelstartgids als de gebruikershandleiding gemakkelijk kunnen personaliseren (‘branden’). Dit kunnen we eenvoudig verwezenlijken door de bedrijfsnaam en productnaam ook als conref in te voegen, en door de inhoud los te koppelen van de layout en output. Voor een nieuwe samenwerking moeten we dan alleen de product- en bedrijfsspecifieke terminologie in de conref library aanpassen, en moeten we bij het publiceren een nieuwe template gebruiken. Aan de eigenlijke inhoud van de handleidingen raken we niet.

Resultaat

Benieuwd naar de output? Raadpleeg dan even onze fifthplay pdf. Of de DELTA pdf. Of bekijkt u liever het webhelpformaat? Aan u de keuze. Een waaier aan formaten, en dat allemaal van dezelfde bron.

En u? Welke output zou u kiezen?





Leave a Reply

Your email address will not be published. Required fields are marked *



Scripto Blog

News and insights from the Scripto experts!