Topic based authoring, topic based writing, ämnesbaserat skrivande – kärt barn har många namn. Här beskriver vi vad det är och vad det är bra för.
Vad är topic based authoring?
Det traditionella arbetssättet för att skriva teknisk dokumentation – rad för rad från början till slut – börjar allt mer trängas bort av topic based authoring (TBA). TBA innebär att skriva korta innehållsbitar, ämnen, i stället för att skriva hela dokument eller kapitel. Varje ämne besvarar bara en fråga, till exempel ”Vad gick fel?”, ”Hur gör jag x?” eller ”Vad är x?”.
Man brukar prata om tre huvudsakliga innehållstyper:
- Uppgifter (tasks): Steg-för-steg-beskrivningar av hur användaren uppnår sitt mål, till exempel att byta bläckpatron.
- Koncept (concepts): Bakgrundsinformation om hur saker fungerar eller vad de betyder, till exempel hur en skrivare fungerar.
- Referensmaterial (reference): Detaljerad information som användaren inte kommer memorera men som är viktig att ha, till exempel produktspecifikationer.
Inom TBA producerar man dessa innehållstyper separat, som olika ämnen, och sparar dem i en databas. Sedan har man möjlighet att söka bland ämnesbitarna och sätta ihop dem till ett omfattande dokument.
Inom TBA producerar man olika innehållstyper – till exempel uppgifter och referensmaterial – för sig. Sedan lägger man ihop bitarna till olika dokument.
Vilka är fördelarna med topic based authoring?
Tänk dig att du ska skriva en instruktionsbok. Du är stressad för att du behöver skicka manuset på korrektur, på faktagranskning och på översättning, och du är inte ens halvklar än. Det problemet – och många andra – kan du lösa med TBA.
TBA underlättar granskning och översättning
Med TBA behöver inte hela bruksanvisningen, servicemanualen eller produktdokumentationen vara färdig innan texten kan gå vidare till ämnesexperter, språkgranskare och översättare. Experter och översättare kan jobba med varje ämne så fort det är klart. De får en jämnare arbetsbörda, och dessutom kortar det ner tiden från att alla ämnen är klara till att det färdiga dokumentet kan levereras.
TBA funkar bra på webben
Eftersom varje ämne bara handlar om en enda sak är de relativt fristående. Användaren måste inte läsa ämnena i någon särskild ordning och kan hoppa runt. Det är kanske extra användbart på webben, där det går att länka mellan olika ämnen.
TBA gör det lätt att skapa anpassade versioner
De fristående ämnena gör det också lätt att sätta ihop olika versioner med lite olika innehåll. Till exempel kan en instruktionsbok till reparatörer och en till privatpersoner dela mycket innehåll, men den till reparatörer kan innehålla fler och mer avancerade uppgiftsbeskrivningar och färre konceptbeskrivningar. Alla ämnesbitar som finns kan pusslas ihop till olika pussel, beroende på syftet.
TBA hjälper användaren att känna igen sig
Eftersom ämnena kan pusslas ihop hur som helst måste alla ämnen ha samma ton och vara strukturerade på samma sätt. Det gör det också lättare för användaren att känna igen sig och hitta rätt information.
TBA sparar tid och pengar
Alla ämnen kan sparas i en databas och återanvändas i andra dokument. En viss bit text måste bara skrivas, granskas och översättas en enda gång.
Tillsammans med STI (simplified technical illustrations) kan TBA spara ännu mer tid. Inom båda arbetssätten skapar man innehåll i bitar och plockar de bitar som man behöver för tillfället. Allt finns samlat i en innehållsbank, redo att användas.
Upptäck vårt program CLM för teknisk dokumentation.
