Was ist Technische Dokumentation?
Technische Dokumentation ist – grob vereinfacht – der Teil der Produktkommunikation, der das Produkt erklärt und für die Nutzer verwendbar macht. Es geht also nicht um Werbung und Presse-Mitteilungen, sondern um die „harten“ Fakten. Je nach den Produkten kann die Technische Dokumentation natürlich sehr unterschiedlich aussehen: Die Anleitung für einen Airbus füllt ausgedruckt ganze Räume; die Anleitung für das neue iPhone ist dagegen in einem winzigen Leaflet untergebracht (und weitere Informationen dann digital auf dem Gerät).
Neben der Produktkommunikation für den Kunden kann sich Technische Dokumentation auch an die Mitarbeiter im eigenen Unternehmen (interne Technische Dokumentation) richten, zum Beispiel als Arbeitsanweisungen. Auch hier geht es also darum, Produkte kommunikativ benutzbar zu machen. Außerdem steht dann auch oft im Fokus, bestimmte Arbeitsvorgänge zu dokumentieren (zum Beispiel in einem Wartungsplan, der von Servicemitarbeitern ausgefüllt werden muss).
Welche Dokumente gehören zur Technischen Dokumentation eines Produkts?
Sie werden es schon ahnen: Eine abschließende Liste gibt es da nicht. Bei Technischer Dokumentation geht es im Wesentlichen darum, das Produkt benutzbar zu machen. Im Kern der Technische Dokumentation steht deshalb die Gebrauchsanleitung (oder Bedienungsanleitung, Betriebsanweisung...). Diese kann alle Aspekte des Produktlebenszyklus enthalten, kann aber auch in mehrere Dokumente aufgeteilt werden, also z. B. in ein Instandsetzungshandbuch, eine Betriebsanleitung, ein Wartungshandbuch und eine Entsorgungsanleitung.
Die Technische Dokumentation muss übrigens nicht aus gedruckten Dokumenten bestehen; der überwiegende Teil an Handbüchern wird heute digital ausgeliefert. Und: Technische Dokumentation bedeutet auch nicht, dass es sich um geschriebenen Text handelt. Videoanleitungen, Augmented-Reality-Anwendungen und viele andere audiovisuelle Formate gehören ebenfalls zur Technischen Dokumentation.
Aufbau und Inhalt: Was gehört in eine Technische Dokumentation?
Was in eine Anleitung gehört, hängt natürlich ebenfalls vom Produkt ab. Allerdings gibt es einige feste Konstanten, die für alle Geräte gelten:
-
Alle Anleitungen müssen Hinweise zur Sicherheit beinhalten.
-
Außerdem braucht die Technische Dokumentation eine Darstellung bzw. Beschreibung des Geräts.
-
Und natürlich eine Erklärung der verschiedenen Handlungen, die sich mit dem Gerät verrichten lassen.
-
Insgesamt muss die Technische Dokumentation alle Phasen des Produktlebenszyklus abbilden, also vom Transport über die Instandsetzung, Verwendung, Reinigung und Wartung bis hin zur Entsorgung.
-
Allerdings muss das nicht in einem einzelnen Dokument geschehen, sondern kann auf mehrere Dokumente aufgeteilt werden.
-
Und zu guter Letzt muss die Anleitung alle Zielgruppen berücksichtigen, also zum Beispiel Bedienpersonal, Maschinenführer und Servicetechniker.
Wie genau Sie eine Betriebsanleitung aufbauen, verraten wir Ihnen in unserem Praxis-Guide "So erstellen Sie eine nutzerfreundliche Betriebsanleitung".
Praxis-Guide jetzt herunterladen
Welche Anforderungen müssen erfüllt werden und was muss beachtet werden?
Wer sich mit produzierenden Unternehmen auskennt, dem wird klar sein, dass Technische Dokumentation viel mit Normen und Richtlinien zu tun hat. Denn zum einen muss die Dokumentation natürlich alle Normen berücksichtigen, die für die eigene Branche und das eigene Produkt gelten (zum Beispiel die Maschinen-Richtlinie 2006/42/EG). Und dann gibt es noch eine ganze Reihe von Normen, die sich mit Prozessen, Qualitätsmanagement (z. B. DIN 9001) und Textgestaltung (z. B. DIN 1450) ganz allgemein beschäftigen.
Schließlich gibt es dann auch noch einige Normen speziell für Gebrauchsanleitungen und andere Technische Dokumente (z. B. DIN 82079-1). Noch komplizierter wird das Ganze, wenn man die Produkte exportiert. Denn in den verschiedenen Zielmärkten gelten selbstverständlich ebenfalls wieder verschiedene Normen. Außerdem kommen dann noch Normen für die Übersetzung der Anleitungen hinzu. Zu guter Letzt haben die meisten Unternehmen auch noch interne Normen und Standards, mit denen sie die Qualität ihrer Anleitungen steuern. Insgesamt also eine gehörige Menge an Normen.
Was macht eine gute Technische Dokumentation aus?
Zunächst einmal muss eine gute Anleitung verstanden werden. Deshalb müssen Technische Redakteure sehr genau berücksichtigen, für welche Zielgruppen sie schreiben, d. h. wer ihre Produkte verwendet. Inhaltlich muss die Dokumentation natürlich korrekt sein. Sie muss aber auch vollständig sein, das heißt sie muss den Nutzern der Anleitung den Funktionsumfang des Produkts vollständig erschließen.
Besonders wichtig ist außerdem, dass sie vor allen Gefahren warnt, die die Nutzung des Produkts so mit sich bringt. Denn sonst entstehen für das Unternehmen Haftungsrisiken – mal ganz abgesehen davon, dass im schlimmsten Fall Nutzer zu Schaden kommen oder sogar das Leben verlieren).
Aus Sicht des Unternehmens kommt noch hinzu, dass die Anleitung rechtzeitig (also mit Auslieferung des Produkts) fertiggestellt sein muss. Denn Anleitungen sind ein integraler Produktbestandteil – ohne Anleitung darf das Produkt nicht in Verkehr gebracht werden. Und zu guter Letzt sollte eine Anleitung natürlich möglichst effizient und kostensparend erstellt werden.
Redaktionshandbuch, Schreibleitfaden, Styleguide?
Das Redaktionshandbuch ist ein Kernbaustein für die sprachliche Qualität in Technischen Redaktionen. Anders als CI-Handbücher im Marketing regelt er nicht vorwiegend Gestaltung und Layout, sondern den sprachlichen Stil der Produkthandbücher. Ziele sind dabei vor allem die Einheitlichkeit der Texte, eine gute Übersetzbarkeit und hohe Verständlichkeit der Dokumentation.
► Hier geht's zum Blogbeitrag "Redaktionsleitfaden - Das dürfen Sie nicht vergessen";
Optimale Textverständlichkeit erreichen?
Optimale Verständlichkeit lässt sich in der Technischen Dokumentation nur erreichen, wenn man ein genaues Bild von der Zielgruppe hat, für die man schreibt. Anleitungen sollen sowohl präzise formuliert sein, als auch in möglichst einfacher Sprache. Es gilt außerdem das Prinzip des Minimalismus, dass Nutzer mit möglichst wenig Inhalten belastet werden, damit sie ihr Informationsziel schnell erreichen können.
Wer erstellt Technische Dokumentation?
Technische Dokumentation wird in Technischen Redaktionen von Technischen Redakteurinnen und Redakteuren erstellt.
Daneben sind an der Erstellung der Dokumentation viele weitere Personen beteiligt. Fachlichen Input geben Entwickler und Entwicklerinnen oder andere Menschen mit Produktexpertise. Terminologiefachleute sorgen dafür, dass Inhalte einheitlich benannt sind. Technische Zeichner und Zeichnerinnen erstellen Grafiken, sowohl schon während der Entwicklung als auch während der Dokumentationserstellung. Übersetzer und Übersetzerinnen kümmern sich bei exportierenden Unternehmen um die Übertragung der Dokumentation in die Sprachen der Kunden. Außerdem entstehen in der Technischen Redaktion laufend neue Berufsfelder wie Content Architektur, Videoschnitt, Chatbot-Modellierung oder Scrum Master in agilen Dokumentationsprozessen.
Was macht ein guter Technischer Redakteur?
Technische Redakteure machen weit mehr als nur Anleitungen zu schreiben, z. B. Recherche, Textkonzept, Contentverwaltung. Daneben gibt es eine ganze Reihe organisatorischer Aufgaben, wie Druckabwicklung oder Übersetzungsmanagement. Außerdem übernehmen Technische Redakteure oft Zusatzaufgaben, die mit dem Schreiben nur wenig zu tun haben, wie Terminologiemanagement oder die Verwaltung der Ersatzteilkataloge.
Englische Doku, deutscher Redakteur - geht das?
Englische Doku, deutscher Redakteur, das ist in vielen Unternehmen Normalität. Und auch wenn diese Situation nicht der Idealfall ist, gibt es Maßnahmen, mit denen die fremdsprachige Redaktion klappen kann. Wichtig sind ein gut durchdachtes Redaktionshandbuch, professionelles Übersetzungsmanagement und vor allem eine präzise Korrekturphase. Dieses Review sollte automatisiert mit Prüfsoftware und durch geschulte Korrektoren erfolgen.
► Hier geht's zu unserer umfangreichen Landing Page zu diesem Thema
Wie wird bei der Technischen Dokumentation vorgegangen?
Jede Anleitung beginnt mit der Recherche der verschiedenen Informationen zu dem (zukünftigen) Produkt. Technische Redaktionen bedienen sich dafür aus verschiedenen Quellen: Vorgängermodelle und deren Dokumentation, Entwicklungsunterlagen, Prototypen, Interviews mit Produktexperten und noch vieles mehr. Nach der Faktenrecherche bauen sich die Redakteure und Redakteurinnen ein Informationskonzept, das festlegt welche Information für welche Zielgruppe in welcher Tiefe kommuniziert wird. Oft arbeiten Redaktionen mit Content Management Systemen. Dann legen sie in dieser Phase fest, welche Informationsbausteine bereits vorliegen, welche geändert oder erstellt werden müssen und wie die Informationsbausteine miteinander kombiniert werden.
Erst nachdem diese Vorarbeiten erledigt sind, beginnt das eigentliche Schreiben. Sobald die Texte (oder Contentmodule) fertig gestellt sind, durchlaufen sie einen mindestens zweistufigen Freigabeprozess. Zuerst erfolgt ein redaktionelles Review, bei dem Technische Autoren und Autorinnen die sprachliche Korrektheit und die Einhaltung der redaktionellen Standards prüfen. Danach prüft ein Produktexperte in der fachlichen Freigabe die Anleitungen auf inhaltliche Korrektheit. Oft schließt sich an diese zweistufige Freigabe noch ein Usability-Test mit der Zielgruppe der Anleitung an. Erst nachdem die Anleitung komplett freigegeben ist, wird sie publiziert und ausgeliefert, z. B. als gedrucktes Handbuch oder als interaktive Benutzerführung auf dem Maschinendisplay.
Neben dem eigentlichen Erstellen der Anleitungen gibt es noch eine Reihe von Querschnittsaufgaben in den Technischen Redaktionen. Dazu gehören beispielsweise die Festlegung von Schreibstandards in einem Redaktionsleitfaden, die Definition von Metadaten und Ontologien zur Beschreibung der Produkte und ihrer Funktionen oder Steuerung und Kontrolle der Übersetzungen.
Was sind häufige Probleme bei der Erstellung einer Technischen Dokumentation?
Eines der Kernprobleme vieler Technischer Redaktionen ist der Zeitdruck. Recherche, Schreiben, Review, Übersetzung und Produktion dauern ihre Zeit; in manchen Extremfällen sogar länger als zum Beispiel die Produktion einer Sondermaschine. Viele Redaktionen setzen deshalb auf leistungsfähige Software-Lösungen wie z. B. Content Management Systeme, um die einzelnen Prozessschritte zu beschleunigen und doch Informationen zuverlässig bereit zu stellen.
Ein weiteres Problem ist der Umgang mit Varianten. Das Produktportfolio moderner Hersteller ist oft extrem individuell ausgerichtet, Kunden können sich ihre Produkte fast beliebig zusammenstellen. Die Redaktionen müssen diese Individualität ebenfalls abbilden können, so dass die Kunden jeweils nur die Funktionalität ihrer Produktvariante erklärt bekommen. Weitere Dokumentvarianten entstehen durch verschiedene Zielgruppen (Basis- und Profiversion) und durch die diversen Sprachvarianten und regionalen Besonderheiten (Übersetzungen, Versionen für den britischen und den amerikanischen Markt). Auch bei diesen Problemen hilft ein leistungsfähiges Content Management System, den Überblick zu behalten.
Sie haben Fragen rund um die Optimierung Ihrer Technischen Dokumentation?
Melden Sie sich bei uns!
Wie kann eine nutzerfreundliche Gestaltung sichergestellt werden?
Die Zeiten sind schon lange vorbei, in denen als Produktdokumentation ein schmales Informationsblättchen reichte. Nutzer und Nutzerinnen erwarten heute die richtige Dokumentation zur richtigen Zeit und zwar in dem Umfang und Medium, die ihren Bedürfnissen am besten entsprechen. Moderne Dokumentation ist deshalb nicht nur digital und interaktiv. Sie hilft den Produktnutzern und -nutzerinnen, ihre Informationsbedürfnisse anschaulich und schnell zu befriedigen, z. B. durch 3D-Animationen oder Produktvideos.
Welche Informationsart am besten zur Zielgruppe und zur Nutzungssituation passt, ermittelt man normalerweise in Usability Tests. Hier bearbeiten repräsentative Testgruppen produktbezogene Aufgabenstellungen oder sie beantworten Fragen zu den Produkten. Dadurch lässt sich dann erkennen, wie gut eine Anleitung wirkt.
Wie genau Sie eine nutzerfreundliche Betriebsanleitung aufbauen, verraten wir Ihnen in unserem Praxis-Guide "So erstellen Sie eine nutzerfreundliche Betriebsanleitung".
Praxis-Guide jetzt herunterladen
Was bedeutet Terminologiemanagement in der Technischen Dokumentation?
In vielen Technischen Redaktionen ist auch die Pflege der Terminologie als Aufgabe angesiedelt. Terminologiemanagement kümmert sich darum, dass Produktbezeichnungen, Fachbegriffe und z. B. typische Verfahren immer konsistent gleich benannt werden. Es sorgt für die Identifikation von Termkandidaten, für die Standardisierung der Begriffe und für die Verteilung und Bekanntmachung der Terminologie. Terminologiemanagement erleichtert außerdem die Übersetzung, da Kernbegriffe definiert sind und immer gleich übersetzt werden können.
Weitere Informationen finden Sie in folgenden Artikeln:
► Terminologiemanagement – hausgemacht
► Terminologie-Management – Bitte eindeutig und verständlich
Was sind Metadaten in der Technischen Dokumentation?
Metadaten sind der Schlüssel zur Automatisierung in Technischer Dokumentation. Mit ihnen legt man fest, wie ein Contentmodul sich später verwenden lässt: Welche Produktteile beschreibt es? In welcher Phase des Produktlebenszyklus ist es relevant? Für welche Zielgruppe ist es gedacht? Metadaten lassen sich individuell für unterschiedliche Unternehmen, Produkte, Anwendungsfälle und Einsatzszenarien festlegen. Sie können auch wechselseitige Abhängigkeiten aufweisen, so dass das Metadatenkonzept für einen Contentpool genau durchdacht sein muss.
► Mehr erfahren? Hier geht es zum Artikel "Wer braucht schon Metadaten?"
Was hat es mit "Kontrollierter Sprache" auf sich?
Kontrollierte Sprache klingt vielleicht zunächst abschreckend, erleichtert aber den Arbeitsalltag. Kontrolliert wird nämlich nicht der Technischer Redakteur und die Redakteurin, sondern die Sprache. Diese soll möglichst einheitlich und verständlich sein. Dadurch fallen viele Entscheidungen während des Schreibens weg; Anleitungen lassen sich schneller in gleichbleibend hoher Qualität produzieren. Softwaresysteme für kontrollierte Sprache prüfen die Texte schon während des Schreibens im Content Management System, schlagen Formulierungen vor und weisen auf Problemstellen hin.
► Mehr erfahren? Hier geht es zum Artikel "Mit kontrollierter Sprache effizient dokumentieren"
Normen und Standards für die Technische Dokumentation
Normen und Standards spielen eine wichtige Rolle in der Technischen Dokumentation. Da sind zum einen die Normen, die für das Produkt selbst gelten. Diese müssen in der Dokumentation berücksichtigt und explizit genannt werden. Darüber hinaus gibt es einige Normen, die für Betriebsanleitungen und die Arbeit in Technischen Redaktionen gelten. Im Zentrum stehen hier die „Gebrauchsanleitungsnormen“ DIN EN 82079-1 und ISO 20607. Dazu kommen allgemeinere Normen beispielsweise für das Übersetzungsmanagement (z. B. ISO 17100) oder Qualitätsmanagement (z. B. ISO 9001). Zu guter Letzt erstellen viele Technische Redaktionen auch eigene Standards, in denen sie Gestaltung und Formulierung der Anleitungen festhalten.
► Mehr erfahren? Lesen Sie "Normen und Standards für die Technische Doku"
► Hier geht's zum Blogbeitrag "Die wichtigsten Normen und Standards"
Was ist die SAFE-Formel für die Technische Dokumentation?
Sachschäden und Personenschäden zu verhindern, ist eine der wichtigsten Aufgaben von Gebrauchsanleitungen. Deshalb haben sich in der Technischen Redaktion eigene Standards für Sicherheitskapitel und Warnhinweise entwickelt. Das wichtigste Prinzip ist die sogenannte SAFE-Formel, die beschreibt, wie die Stärke der Gefahr signalisiert wird und wie sich Gefahrenbeschreibung und Maßnahmen, um die Gefahr zu verhindern, miteinander kombinieren lassen.
► Mehr erfahren? Hier geht es zum Artikel "Richtig warnen - eine Kunst, die gelernt sein will"
► Noch mehr Infos zu Warnhinweisen? Hier gibt es all unsere Infos zum Thema
Wie lassen sich Review-Prozesse in der Technischen Dokumentation optimieren?
Qualität ist wichtig in der Technischen Dokumentation und dementsprechend stellt sie ganz besondere Anforderungen an das Review. In der Korrekturphase müssen unterschiedliche Rollen einbezogen werden: Die Anleitung muss sowohl fachlich richtig sein, sie muss den sprachlichen Anforderungen entsprechen, Layout und Usability müssen stimmen. Deshalb ist das Review meist in mehreren Zyklen organisiert. Oft wird auch ein Qualitätsziel für das Review festgelegt und z. B. durch das 4-Augen-Prinzip umgesetzt. Checklisten erleichtern den Überblick bei Aufgaben, die in jedem Review wieder erledigt werden müssen.
► Mehr erfahren? Hier geht es zum Artikel "Bessere Review-Prozesse in der Technischen Dokumentation"
Wozu braucht die Technische Redaktion 3D-Modelle?
3D-Modelle haben viele Vorteile für die Technische Redaktion. Sie sind anschaulicher als Text oder auch einfache Abbildungen. Der Benutzer kann sich seinen Blickwinkel frei wählen, in ein Objekt hineinzoomen oder es stufenweise in seine Bauteile zerlegen. Außerdem lassen sich 3D-Modelle als Navigationsinstrument verwenden: Ein Klick auf das Bauteil und schon öffnet sich die passende Beschreibungsseite. Und zu guter Letzt sind 3D-Modelle natürlich eine gute Ausgangsbasis für Animationen in der Anleitung. 3D-Modelle können also eine wichtige Rolle spielen in der Dokumentation.
Wie kann Software bei der Technischen Dokumentation unterstützen?
Moderne Redaktionssysteme helfen Technischen Redaktionen bei allen Aspekten der Dokumentation. Die stellen Informationen medienneutral bereit und ermöglichen es so, dieselben Inhalte für die unterschiedlichsten Kommunikationskanäle (z. B. Handbuch, Online-Portal, Doku-App) zu publizieren. Umfangreiche Handbücher layouten sie automatisiert auf Knopfdruck. Sie unterstützen bei der Verwaltung verschiedener Sprachen und Produktversionen. Sie automatisieren Abläufe und publizieren zielgruppengenau und stets aktuell die passenden Anleitungen. Und Sie organisieren fachlichen und redaktionelle Freigaben, damit stets sichergestellt ist, dass nur korrekte Informationen bei den Nutzern und Nutzerinnen ankommen.
Ob eine Software auch für Sie die Erstellung Ihrer Technischen Dokumentation erleichtert, erfahren Sie in unserem White Paper "Brauche ich ein Redaktionssystem?".
White Paper jetzt herunterladen
Sie möchten mehr über XML-Redaktionssysteme wissen? Fordern Sie jetzt unsere White Paper an!
In unserer White Paper-Trilogie erfahren Sie, ob sich ein XML-Redaktionssystem für Ihre Redaktion lohnt, welche Redaktionssysteme es gibt und wie sie sich unterscheiden und wie Ihnen die Einführung eines solchen Systems problemlos gelingt.
Was ist ein XML-Redaktionssystem?
XML-Redaktionssysteme wie SCHEMA ST4 verwalten Inhalte layoutunabhängig. Inhalte werden semantisch klassifiziert und gegebenenfalls nach Varianten verwaltet. Dadurch gewinnen Technische Redaktionen einen hohe Wiederverwendbarkeit ihrer Inhalte und große Flexibilität bei der Ausgabe der Inhalte in verschiedenen Medien. XML-Redaktionssysteme lohnen sich für die meisten Redaktionen, die große Mengen an variantenreichen Dokumenten erstellen müssen. Sie bringen auch in Ein-Personen-Redaktionen einen hohen Nutzen.
► Braucht Ihre Technische Redaktion ein XML-Redaktionssystem?
Welche Vorteile bietet ein XML-Redaktionssystem?
Modularisierung Ihrer Inhalte
Modularisierung ist einer der Kernfaktoren für den Erfolg der Technischen Dokumentation. Mit Modularisierung des Contents strebt man an, Informationsbausteine zu erzeugen, die an einer zentralen Stelle gespeichert werden und sich in möglichst vielen Zusammenhängen wiederverwenden lassen. Modularer Content mindert den Pflegeaufwand bei den Anleitungen, da Änderungen auf Knopfdruck an zahlreichen stellen gleichzeitig durchgeführt werden können und senkt die Übersetzungskosten.
Übersetzungen im Griff
In einem XML-basierten Redaktionssystem lassen sich Übersetzungen deutlich leichter abwickeln. Zum Beispiel indem nicht immer wieder das ganze Handbuch übersetzt wird, sondern nur die Passagen, die sich geändert haben oder noch nicht in der entsprechenden Zielsprache vorliegen. Inhalte können außerdem unkompliziert und in Echtzeit über eine Schnittstelle mit Übersetzern ausgetauscht werden, ohne dass diese Zugriff auf Ihr Redaktionssystem haben. Mit einem XML-Redaktionssystem senken Sie die Kosten Ihrer Übersetzungen deutlich, während Sie außerdem Zeit beim Übersetzungsmanagement und in der Zusammenarbeit mit den Übersetzern sparen.
Zielformate leicht erstellen
Mit XML werden Layout, Inhalt und Struktur getrennt. Layout wird automatisch erzeugt. Ändert sich das Erscheinungsbild oder wird der Inhalt in einem anderen Format gebraucht, wird lediglich das Layout geändert und die Inhalte werden einfach erneut publiziert. Und das auf Knopfdruck und ganz ohne Programmierkenntnisse! Mit einem XML-Redaktionssystem werden Layout und Ausgabe Ihrer Technischen Dokumentation zum Kinderspiel. Das spart Zeit, Geld und Nerven. Oder kurz gesagt: So einfach waren Layout und Ausgabeformat in der Technischen Dokumentation noch nie!
Varianten einfach managen
Ein XML-basiertes Redaktionssystem zerlegt Ihre Dokumentation in viele kleine Text- und Bildbausteine, die Sie dokumentationsübergreifend an den unterschiedlichsten Stellen wiederverwenden können. Diese Module werden zum leichteren Suchen und Finden mit Metadaten versehen, an einer zentralen Stelle verwaltet und geändert und sie schlagen dem Autor beim Schreiben sogar passende Textbausteine vor. Mit einem XML-Redaktionssystem behalten Sie immer den Überblick. Mühsame manuelle Arbeiten werden automatisiert und die Fehlerquote wird deutlich gesenkt.
Kosten, Zeit und Nerven sparen
Ein XML-Redaktionssystem liefert effiziente Lösungen für unterschiedliche Einsatzbereiche. Redaktionelle Prozesse lassen sich damit unkompliziert optimieren, Kosten werden gesenkt, der Zeitaufwand wird reduziert und die Nerven von Technischen Redakteuren werden erheblich geschont. Von den Vorteilen der Arbeit mit solch einem Content-Management-System profitiert jede Redaktion!
Fehleranfälligkeit senken, Qualität steigern
Ein XML-Redaktionssystem automatisiert und vereinfacht die Prozesse in Ihrer Technischen Redaktion. Dadurch wird die Fehleranfälligkeit Ihrer Dokumentationen deutlich gesenkt, während gleichzeitig deren Qualität erheblich gesteigert wird. Sie interessieren Sich für ein XML-Redaktionssystem? Dann schauen Sie sich doch gleich an, was unser Redaktionssystem SCHEMA ST4 zu bieten hat.
Inhalt, Struktur, Layout in der Technischen Dokumentation trennen – warum?
Zunächst klingt das Verfahren, Inhalte, Struktur und Layout zu trennen, nach einem Rückschritt. WYSIWIG ist ja seit vielen Jahren Standard bei der Dokumenterstellung. Will man große Dokumentbestände effizient verwenden, dann ist die Trennung von Layout, Struktur und Inhalt das Mittel der Wahl. Sie gewinnen dadurch Wiederverwendbarkeit und Medienneutralität. Die Inhaltseinheiten lassen sich also in ganz unterschiedlichen Zusammenhängen wiederverwenden und für alle möglichen (Print- und Online-)Formate layouten. Dieselbe Textpassage kann dann in sehr verschiedenen Kontexten auftauchen - in einem gedruckten Handbuch ebenso wie als interaktive Hilfestellung auf dem Maschinendisplay.
► Mehr erfahren? Hier geht es zum Artikel "Inhalt, Layout und Struktur trennen"
Was ist SCHEMA ST4?
SCHEMA ST4 ist ein sogenanntes Component Content Management System (CCMS), das heißt ein Redaktionssystem, in dem Inhalte modular erstellt und vorgehalten werden. Dadurch lassen sich diese Inhalte flexibel miteinander kombinieren und in vielen verschiedenen Kontexten nutzen: z. B. als Druckvorlage, Internetseite, in einer Wissensdatenbank oder als mobile Anwendung. Eine mächtige Layout-Engine sorgt bei SCHEMA ST4 dafür, dass automatisch – aber frei anpassbar – für jede Publikation das richtige Layout entsteht.
Der Schwerpunkt des Einsatzes von SCHEMA ST4 liegt in der Technischen Dokumentation, es wird aber auch in vielen anderen Bereichen verwendet, z. B. im Vertragswesen oder in der Erstellung von Schulungsmaterialen. SCHEMA ST4 findet seinen Einsatz in einem breiten Branchenspektrum, z. B. im Maschinenbau, in der Softwareentwicklung, der Anlagentechnik, der Medizingeräteherstellung oder in der Pharmazie. SCHEMA ST4 wird weltweit verwendet und gilt als technischer Marktführer im Bereich Component Content Management Systeme.
Was ist Content Delivery?
Content Delivery ist mehr als ein Schlagwort. Im Kern steht der Gedanke, dass die Nutzer auf jeder Plattform zu jeder Zeit die für sie passende Information in der für sie passenden Form abrufen können. Dazu braucht es ein ausgefeiltes Zielgruppen- und Rechtekonzept, Metadaten zur Steuerung der Inhalte und natürlich einen Server, der die Inhalte verteilt. Wir empfehlen da übrigens den Quanos InfoTwin.
Welche Rolle spielt Technische Dokumentation in Software-Projekten?
In Software-Projekten nimmt die Technische Redaktion eine ganze Reihe von Rollen ein. Zunächst einmal ist sie natürlich für die Erstellung der Anleitungen und kontextsensitiven Hilfen zuständig. Oft ist sie aber auch die erste Instanz, die die Software aus Kundensicht analysiert und so Usability-Fehler an der Software-Oberfläche oder umständliche Bedienwege identifiziert. Außerdem sorgt die Technische Redaktion für terminologische Konsistenz und in der Konsequenz dafür, dass Funktionalitäten und Oberflächenelemente in der Software an allen Stellen gleich benannt werden.
Wie unterscheidet sich Software-Dokumentation von anderen Anleitungen?
Software-Dokumentation unterscheidet sich in einigen Aspekten von anderen Produktanleitungen. Das dokumentierte Produkt lässt sich nicht anfassen, hat aber oft eine hohe Komplexität. Sie beschäftigt sich mit unterschiedlichsten Themen und Zielgruppen und unterliegt oft einer hohen Änderungsfrequenz. Außerdem kommen bei der Software-Entwicklung Prozesse zum Einsatz (wie etwa agile Methoden), die es für Technische Redakteure und Redakteurinnen nicht immer einfach machen, sich einzuklinken.
► Mehr erfahren? Hier geht es zum Artikel "Die Herausforderungen der Software-Dokumentation meistern"
Unsere Themenseiten
Zu verschiedenen Detail-Themen haben wir umfangreiche Informationen - Videos, Podcasts, Texte, Poster & White Paper - für Sie zusammengestellt. Stöbern Sie doch gerne ein bisschen auf diesen Detailseiten herum und eignen sich neues Wissen an!
Sie haben Fragen rund um die Optimierung Ihrer Technischen Dokumentation?
Melden Sie sich bei uns!
Erfahren Sie jetzt mehr über XML-Redaktionssysteme
Wir haben für Sie eine White Paper-Trilogie erstellt, die all Ihre Fragen beantwortet:
- Braucht Ihre Redaktion ein Redaktionssystem? Was sind die Vorteile und lohnt sich eine solche Anschaffung für Sie?
- Welche Redaktionssysteme gibt es auf dem Markt und was sind die Unterschiede? Wir haben sechs XML-Redaktionssysteme für Sie verglichen.
- Wie gelingt die Einführung eines solchen Redaktionssystems und worauf müssen Sie achten?
Fordern Sie die White Paper jetzt an!
