IQuality levert software, internet en media oplossingen op maat om informatie zo effectief mogelijk te delen. Standaarden en in het bijzonder DITA spelen daarbij een belangrijke rol. Uitwisseling van informatie tussen mensen en organisaties wordt veel effectiever als de interpretatie van gegevens geen drempels opwerpt. Wat ons betreft is DITA dus geen doel maar een middel. In dit artikel zullen we op basis van deze uitgangspunten een business case met technische details verder toelichten.
DITA en Sitecore CMS als single source voor technische documentatie
Het schrijven van technische documentatie, beschikbaar maken via verschillende kanalen en het vertalen, is geen eenvoudige opgave. Zeker niet als het aantal producten, versies en verschillende auteurs toeneemt. Daar komt nog bij dat steeds meer verschillende partijen in verschillende omgevingen niet alleen toegang willen hebben tot niet de documentatie, maar juist specifieke informatie in de documentatie. Tel daar nog eens bij op een verlangen om efficiënter te werken en kosten te besparen en dan is de uitdaging compleet.
Vanuit deze uitdaging hebben wij voor Neopost een implementatie gedaan van een content management systeem (Sitecore) met de xml standaard DITA als uitgangspunt. Het content management systeem is de single source voor de technische documentatie (topics, maps etc.). Publicatie vanuit het content management systeem gebeurt in DITA, PDF of naar 1 of meerdere websites. Daarnaast kan DITA ook geïmporteerd worden en is er een koppeling gemaakt met een vertaalservice.
Architectuur: DITA via een content management systeem
Wij hebben expliciet gekozen om niet gebruik te maken van een XML DITA editor, maar juist voor een generiek content management systeem. We kijken dus veel meer vanuit de dimensie informatie dan de dimensie manual. Binnen het content management wordt de structuur van de informatie gedefinieerd. Dus de gehele gevensverzameling onafhankelijk van presentatie is genormaliseerd binnen het CMS systeem. Hierbij zijn de structuren van DITA als uitgangspunt/best practice genomen. Bij de implementatie is gekozen om niet de gehele DITA structuur te implementeren maar de zaken die binnen Neopost van belang zijn. Per object zijn de velden, relaties, validaties, rechten etc. vastgelegd. Hiernaast ziet u de structuur van een DITA topic.
Groot voordeel van deze werkwijze is dat bijvoorbeeld topics ook verbonden kunnen worden met andere zaken, zoals producten, Knowledge base entries, resolutions van servicecalls etc. Deze links kunnen bv. binnen een website-omgeving worden gebruikt (een KB artikel kan naar een topic van een manual linken).
Daarnaast wordt de integriteit van de content afgedwongen(o.a. links tussen items) en zorgt de workflow en autorisatie voor een gestructureerde en toegestane werkwijze.
Lees verder over dit ontwerp in Informatie delen met DITA - deel 2. Hier gaan we verder in op het content management, de workflow en de vertalingen binnen deze Sitecore / DITA oplossing.