K15t Blog
Woran erkenne ich ein gutes Redaktionssystem für die technische Dokumentation
Michael Rieger

Michael Rieger am 19. März 2018

Michael Rieger

Michael Rieger am 19. März 2018

Woran erkenne ich ein gutes Redaktionssystem für die technische Dokumentation

Überlegen Sie, ein Redaktionssystem für Ihre technische Dokumentation einzuführen? Das ist gut, denn ein gutes Redaktionssystem erleichtert die Abläufe im Alltag Ihrer technischen Redakteure. Doch das Angebot an Werkzeugen ist groß. Woran erkennen Sie also ein gutes Redaktionssystem für die technische Dokumentation?

Hier sind einige Punkte, auf die Sie unserer Erfahrung nach achten sollten.

Arbeiten im Team

Ein gutes Redaktionssystem hilft allen Beteiligten besser zusammenzuarbeiten.

Sammeln Sie Konzepte, Entwürfe und fertige Dokumentationen an einem Ort. So kann jeder Inhalte hinzufügen und editieren. Darüber hinaus ist eine Kommentarfunktion hilfreich, mit der Ideen und Änderungen direkt im jeweiligen Inhalt diskutieren werden können und für alle nachvollziehbar sind. Auf diese Weise arbeiten Sie transparent und es ist möglich nachzuvollziehen, wer wann was geändert hat und warum. Außerdem sparen Sie sich Meetings und E-Mails. 

enlite-redaktionssystem-zusammenarbeiten

Webbasiert

Mit einem webbasierten Redaktionssystem sind Sie unabhängig von Ort und Endgerät.

Von Vorteil ist die hohe Flexibilität bei der Wahl des Arbeitsplatzes: Die technische Dokumentation kann sowohl am Schreibtisch, als auch auf Geschäftsreise oder im Homeoffice bearbeitet werden. Auch ist es möglich, dass mehrere Personen gleichzeitig dieselben Inhalte bearbeiten und sehen, was der andere jeweils ändert.

Einfache Benutzeroberfläche

Legen Sie Wert auf eine benutzerfreundliche Bedienung. Eine klar strukturierte und gut gegliederte Benutzeroberfläche erleichtert nicht nur die Einarbeitung. Auch erfahrene Anwender arbeiten effizienter mit einer Software, die einfach zu bedienen ist.

Gute Redaktionssysteme verwenden einen integrierten Editor, in dem Texte, Tabellen, Grafiken und Links bearbeitet, formatiert und geteilt werden können. Wünschenswert wäre auch eine Funktionen, die Inhalte schon beim Schreiben auf Fehler in Grammatik, Ausdruck und Schreibstil überprüft.

Umfangreiche Suchfunktionen

Je stärker Ihr Fokus auf Teamarbeit liegt, umso mehr Nutzer tragen zur Dokumentation bei. Die Dokumentation wächst schneller in Struktur und Inhalt - daher ist eine Suche wichtig um schnell Inhalte zu finden. Ein gutes Redaktionssystem unterstützt Sie dabei, beispielsweise anhand von Metadaten oder in Form einer Volltextsuche.

Versionen, Varianten, Sprachen

Ein wesentlicher Bestandteil eines Redaktionssystems ist die Verwaltung von Versionen, Varianten und Sprache.

enlite-verschiedene-versions-an-einen-ort-verwalten

Erstellen Sie Produkte in unterschiedlichen Versionen und Varianten, sollten Sie Ihre technischen Dokumentationen einfach erstellen, verwalten und veröffentlichen können.

Liefern Sie diese in verschiedene Länder aus, erstellen Sie vermutlich Dokumente in mehreren Sprachen. Bei der Verwaltung Ihrer Dokumentation in unterschiedlichen Sprachen ist es von großem Nutzen, Inhalte exportieren zu können, um sie von einem externen Übersetzungssystem (TMS) bearbeiten zu lassen. Besteht zusätzlich die Möglichkeit, Inhalte direkt im Redaktionssystem zu übersetzen, können Sie außerdem kleinere Änderungen schnell und unkompliziert selbst umsetzen.

Kontinuierliche Verbesserung

Mit einem guten Redaktionssystem verkürzen Sie Ihren Korrekturzyklus und Releasezyklus und verbessern Ihre technische Dokumentation kontinuierlich.

Als sehr praktisch erweist es sich hier, wenn alle Beteiligten ihre Korrekturen direkt im Dokument speichern können. Ihr Redakteur kann somit Inhalte schnell aktualisieren, ohne die geänderten Textelemente umständlich zu exportieren und Änderungen manuell wieder einzupflegen. Auch Kundenfeedback sollte unkompliziert aufgenommen werden, um direkt zur Verbesserung der Inhalte beizutragen. 

Workflows und gut aufeinander abgestimmte Freigabeprozesse helfen dem gesamten Redaktionsteam. Ihr technischer Redakteur kann sich auf die Planung und Qualitätssicherung konzentrieren, und Ihren Kunden steht immer eine aktuelle Dokumentationsversion zur Verfügung. 

Dokumentationen veröffentlichen

Stellen Sie Ihren Kunden Ihre Dokumentation zur Verfügung – und zwar individuell im Stil Ihres Unternehmens und an dem Ort, an dem Ihr Kunde sie braucht: als Handbuch, integriert in ein Gerät oder als Online-Dokumentation.

enlite-dokumente-mit-einem-klick-online-veröffentlichen

Es ist wichtig, dass Sie Ihre technische Dokumentation nach den Vorgaben des Corporate Designs gestalten können. Verwenden Sie Logos, Grafiken und Unternehmensfarben. So erleben Ihre Kunden Kommunikation aus einem Guss. 

Doch bleiben Sie flexibel im Format. Denn jeder Anwender hat andere Bedürfnisse. Achten Sie darauf, dass Ihr Redaktionssystem die Formate erzeugen kann, die Sie für die Veröffentlichung Ihrer technischen Dokumentation benötigen: PDF, HTML oder andere.

Nutzen Sie die Möglichkeiten der Online-Dokumentation. Damit erreichen Sie, dass Sie alle Inhalte schnell auf den neuesten Stand bringen können. Ihr Kunde hat damit die Gewissheit, jederzeit auf aktuelle Inhalte zuzugreifen.

Lernen Sie Enlite kennen

enlite-redaktionssystem-technische-dokumentation

All diese Vorteile mit denen Sie flexibler und agiler in Ihrem Dokumentationsprozess werden können, sind bereits
heute im Redaktionssystem Enlite verfügbar.

Enlite ist das Redaktionssystem auf Basis von Atlassian Confluence, einer Plattform für bessere Zusammenarbeit im Unternehmen.

Das intuitive, webbasierte Redaktionssystem für die technische Dokumentation

Lernen Sie enlite kennen

Damit unsere Homepage gut funktioniert, wir unseren Service verbessern können und Ihnen die Nutzung erleichtern, werden Cookies gesetzt (u.a. Google Analytics). Informationen hierzu unter: unserer Datenschutzerklärung.
Ok