Sie haben Fragen zum XML-gestützten Redaktionssystem TIM? Hier haben wir für Sie alle wichtigen Informationen und die Antworten zu den häufigsten Kundenfragen zu TIM-RS zusammengefasst.
Inhalt
Was ist das Redaktionssystem TIM?
TIM-RS bietet eine datenbankgestützte Verwaltung von Inhalten an, die zur Erstellung Technischer Dokumentation geeignet ist. In erster Linie geht es also darum, alle Redaktionsprozesse zu optimieren: Informationen werden in einem integrierten Editor erstellt, in einer XML-Datenbank abgelegt und verwaltet und anschließend in verschiedenen Medien publiziert.
Sie benötigen weitere Informationen zum Aufbau und den Funktionen der aktuellen Redaktionssysteme?
Unsere Übersicht dazu sowie zu den verschiedenen Typen aktueller Redaktionssysteme finden Sie hier. Jetzt kostenlos herunterladen!
Die Inhaltserstellung in TIM-RS
Die Inhaltserstellung im Redaktionssystem TIM zielt auf einen modularen Aufbau ab. Demnach werden Inhalte als Module angelegt, die mit Metadaten versehen werden. Informationen können damit in unterschiedlichen Dokumenten wiederverwendet werden: Über die Metadaten können Sie im Nachhinein dann nach Modulen suchen und diese in die sogenannte „Document Control Lists” (DCL) einbauen.
Eine DCL stellt ein gesamtes Dokumentationsprojekt dar – es stellt die gesamte Struktur bspw. eines Handbuchs oder einer Betriebsanleitung dar. Die DCL besteht hierbei aus drei Arten von Knoten:
- Chapter
- Section
- Para
Die Inhaltsverwaltung
Die Inhaltsverwaltung funktioniert über den Objektmanager, das Herz des Redaktionssystems TIM. Dieser ermöglicht es Ihnen, alle redaktionellen Objekte zu finden und aufzurufen, sodass diese zum Erstellen neuer Dokumente zur Verfügung stehen. Die Suchfunktion innerhalb des Objektmanagers unterstützt zudem eine metadatengestützte Suche.
Das Publizieren mit TIM-RS
Die Inhalte bzw. Module in TIM-RS sind dank XML-Format medienneutral. Das bedeutet, dass Sie in verschiedenen Zielformaten publizieren können – dafür ist zunächst allerdings eine Formatvorlage notwendig, die die optische Gestaltung (Layout) regelt. Bei der Formatvorlage handelt es sich um eine Programmierung, die über eine Formatierungssprache definiert, wie Inhalte schlussendlich auszusehen haben.
Damit das Redaktionssystem die Formatvorlagen richtig interpretieren kann, ist weitere Software erforderlich. Hierbei handelt es sich um sogenannte „Rendering Engines“, die in der Lage sind, XML-Dokumente und Formatvorlagen zu interpretieren und dementsprechend das gewünschte Layout und Format zu produzieren.
Der Editor von TIM-RS
Das Redaktionssystem TIM nutzt für die Bearbeitung von Modulen XML-Editoren. Die Besonderheit eines XML-Editors liegt darin, dass Inhalte einer Struktur folgen müssen: Es müssen an den richtigen Stellen die richtigen Elemente eingefügt werden und dann die Elemente mit Inhalt oder Text gefüllt werden. Das Einfügen von Elementen erfolgt am Besten über die Strukturansicht, die wie eine Baumstruktur visualisiert wird.
Geeignet hierfür ist z.B. der unter TIM-RS weit verbreitete XML-Editor FrameMaker von Adobe.
Die Wiederverwendung von Inhalten
Wie bei der Inhaltserstellung bereits angedeutet, ist eine der wichtigsten Funktionen von TIM-RS die Wiederverwendung von Inhalten, die durch die datenbankgestützte Verwaltung und dem Objektmanager ermöglicht wird.
Ein wichtiger Bestandteil davon sind verschachtelte Module. Das sind in TIM-RS Bausteine, die zur Wiederverwendung gespeichert und in anderen Bausteinen verwendet werden, z. B. maschinenübergreifend. Das Arbeiten mit verschachtelten Modulen bringt den Vorteil mit sich, dass inhaltliche Änderungen nur einmal ausgeführt werden müssen. Denn überall dort, wo ein verschachteltes Modul verwendet wird, wird die Änderung übernommen.
Darum ist es sinnvoll verschachtelte Module zu erstellen, wenn der gleiche Inhalt innerhalb einer Betriebsanleitung mehrfach verwendet wird. Aber nicht nur für Wiederverwendungen bieten sich diese Module an. Sie sind auch zwingend erforderlich für die Variantensteuerung. Beim Erstellen verschachtelter Module werden Eigenschaften hinterlegt, die für den Publikationsprozess relevant sind.
Weitere wichtige Funktionen von TIM-RS
Neben den Kernfunktionen vom Redaktionssystem TIM, die z.B. die Inhaltsverwaltung über den Objektmanager oder die simple Wiederverwendung von Inhalten umfasst, gibt es noch weitere wichtige Funktionen, welche die Redaktionsprozesse vereinfachen.
Variantensteuerung
TIM-RS ermöglicht auch eine Variantensteuerung. Über diese können Sie aus nur einem Dokument (DCL) unterschiedliche Produktvarianten publizieren. Mit dieser kann bspw. die Betriebsanleitung auftragsspezifisch publiziert werden, sodass das mitgelieferte Dokument einer Maschine exakt die Ausstattung beschreibt, die der Kunde gekauft hat.
Hierfür müssen Module mit Eigenschaften (Metadaten) versehen sein. Die Auftragsdatei bestimmt beim Publizieren, welche Inhalte tatsächlich publiziert werden. Mit Hilfe der Eigenschaften kann man also eine Art Filter vordefinieren.
Besonders hervorzuheben ist, dass diese Art von Filterung nicht nur nach dem Entweder-oder-Verfahren stattfindet, sondern beliebig ausgeweitet werden kann. Sie können mittels der Eigenschaften Module so bearbeiten, dass diese beim Publizieren berücksichtigt oder ausgeschlossen werden.
Versionierung
Mit Hilfe der Versionierung sichern Sie sich einen bestimmten Arbeits- oder Auslieferungstand Ihrer Dokumentation. Vor allem bei Auslieferungen ist es vorteilhaft, wenn jederzeit auf verschiedene Versionen zurückgegriffen werden kann. Denn dadurch wird verhindert, dass verwendete Bausteine überschrieben werden und somit den Stand der Auslieferung verändert. Über die Eigenschaften können Sie einsehen, ob Ihre Dokumentation auf dem aktuellen Stand ist bzw. die aktuellsten Bausteine (Textinhalte und Grafiken) verwendet werden.
Um eine Version in TIM-RS zu erzeugen, muss zunächst der Baustein freigegeben sein. Die Freigabe wird über den Status erteilt. Eine neue Version lässt sich dann ganz leicht mit einem Rechtsklick auf der Maus anlegen. Wenn Sie eine neue Version erzeugt haben (Version 1.1) können Sie die alte Version (1.0) nicht mehr editieren. Wenn Sie die neue Version (1.1) freigeben wollen, aber im Nachhinein Anpassungen vornehmen möchten, die sich auf den gleichen Versionsstand beziehen, müssen Sie zunächst den Status in „Zur Prüfung freigeben“ ändern. Daraufhin können Sie Ihre Anpassungen durchführen und anschließend den Status wieder in „Freigeben“ ändern. Damit muss nicht zwangsweise für jede Änderung eine neue Version erzeugt werden.
Suchfunktionen
Suchfunktionen gibt es in TIM-RS sowohl im Objektmanager als auch in der Document Control List (DCL).
In der Suche innerhalb des Objektmanagers lassen sich alle verfügbaren Redaktionsobjekte finden, die als „Informationspool“ hinterlegt sind. Über eine Filteransicht bietet der Objektmanager Felder zur Eingabe von Suchkriterien an. Gesucht wird über die Metadaten aller Objekte.
Über den Objektmanager können zudem Module bzw. Bausteine über ihre Eigenschaften gefunden werden. Der Objektmanager zeigt Ihnen alle vorhandenen Bausteine an, die Ihren Suchkriterien entsprechen. Dafür müssen sie allerdings bei der Erstellung der Bausteine eine Eigenschaft vergeben haben. So können Sie über den Objektmanager auch einsehen, wo überall diese Bausteine verwendet werden und welche weiteren Bausteine darin enthalten sind (vor allem bei verschachtelten Modulen relevant). Das ist vor allem dann zu berücksichtigen, wenn Sie Änderungen an Bausteinen vornehmen möchten.
Bei der Suche innerhalb des Dokumentationsprojektes (DCL) handelt es sich um eine Suche nach verwendeten Objekten oder Modulen innerhalb des Dokumentationsprojektes. Die gefundenen Objekte werden im Dokumentationsprojekt blau hinterlegt.
Probleme und Herausforderungen bei der Nutzung
TIM-RS ermöglicht es den Technischen Redakteuren, ganze Topics oder auch nur bestimmte Blöcke und Absätze als sogenannte verschachtelte Module (oder Bausteine) wiederzuverwenden. Diese Bausteine wiederum können einzelne Sätze oder bspw. Tabellenzeilen als „innere Bausteine“ beinhalten.
Bei der Erstellung eines Handbuchs für eine neue Maschine oder bei der Anpassung bestehender Inhalte – z. B. bei Änderungen einer bestehenden Maschine – ergeben sich darum für den Redakteur sehr komplexe Arbeitsprozesse und Abhängigkeiten innerhalb dieser Bausteine. In solchen Fällen braucht es sehr erfahrene Redakteure, die selbst bei großen und komplexen Bausteinstrukturen innerhalb eines Topics die Übersicht behalten. Diese können Anpassungen vornehmen, ohne ungewollte Änderungen an Varianten oder Modulen hervorzurufen.
Für diese Fragen und für die Auswahl und Einführung eines passenden Redaktionssystems unterstützen wir Sie gerne: Systemeinführung & Hosting · ARAKANGA GmbH