Für die Erstellung eines Redaktionsleitfadens ist vor allem der Fachbereich für die Technische Dokumentation verantwortlich. Aber komplett eigenständig kann er diesen auch nicht erstellen. In dem Redaktionsleitfaden werden Prozesse angesprochen bzw. festgelegt, für die nicht nur „Technische Redakteure“ verantwortlich sind. Diese Prozesse müssen mit den jeweiligen Fachbereichen gemeinsam festgelegt werden.
Der Redaktionsleitfaden ist das “Gesetzbuch” für die Technische Redaktion. Der Redaktionsleitfaden soll dem Ersteller einer Dokumentation eine wirkliche Hilfestellung geben er zeigt ihm, wie er in einem realen Projekt vorgehen muss, um die Inhalte zu definieren, die in die Dokumentation gehören, um die so definierten Inhalte in ein Dokument umzusetzen.
In der Theorie ist der geeignete Zeitpunkt einen Redaktionsleitfaden zu erstellen, wenn Sie bspw. ein Redaktionssystem einführen. Bevor Sie ein Redaktionssystem einführen, ist es wichtig zu wissen, welche Anforderungen es erfüllen soll. Insofern haben Sie im Vorfeld Entscheidungen getroffen, die den „Sollzustand“ der zu erstellenden Technischen Dokumentation entsprechen soll. Dieser „Sollzustand“ wird in einer sogenannten … Weiterlesen
Die Zielgruppe des Redaktionsleitfadens sind in erster Linie Personen, die Dokumente erstellen also Technische Redakteure. Aber nicht nur Technische Redakteure sind am Erstellungsprozess von Dokumenten beteiligt. Darüber hinaus gehören auch Lektoren und Übersetzungsmanager zur Zielgruppe des Redaktionsleitfadens. Es ist also wichtig, auch für diese Zielgruppen in dem Redaktionsleitfaden anzusprechen.
Ein Redaktionsleitfaden ist unternehmenspezifisch. Das Bedeutet, jeder Redaktionsleitfaden ist anders. Im Wesentlichen sollten aber die folgenden Punkte in einem Redaktionsleitfaden abgedeckt sein: – Angaben zum Erstellungsprozess – Angaben über die Dokumente – Angaben über die Tools mit denen gearbeitet wird Mehr Informationen darüber, wie ein Redaktionsleitfaden … Weiterlesen
Der Erstellungsprozess in einem Redaktionsleitfaden gibt Auskunft darüber, wie eine Dokumentationserstellung gestartet wird und welche Arbeiten notwendig sind bis hin zur Auslieferung der Dokumente. Im Erstellungsprozess ist definiert, wer der Auftraggeber ist und welche Prozess ein Dokument durchlaufen muss, bevor es ausgeliefert werden kann. Mehr Informationen darüber, wie ein Redaktionsleitfaden aufgebaut ist können Sie in … Weiterlesen
Im Redaktionsleitfaden ist definiert, wie Dokumente zu Benennen sind und wie deren Inhalt aufgebaut sein soll. Darüber hinaus macht der Redaktionsleitfaden Vorgaben über die Strukturierung der Dokumente sowie zum Layout. Weiterhin ist auch definiert, wie die die Dokumente zu verwalten sind. Mehr Informationen darüber, wie ein Redaktionsleitfaden aufgebaut ist können Sie in unserer Checkliste erfahren: … Weiterlesen
Im Redaktionsleitfaden werden Angaben darüber gemacht, welche Tools bei der Dokumentationserstellung zum Einsatz kommen und wie mit diesen Tools gearbeitet werden soll. Es werden bspw. Regeln zum Editieren von Texten getroffen oder zur Grafikbearbeitung. Mehr Informationen darüber, wie ein Redaktionsleitfaden aufgebaut ist können Sie in unserer Checkliste erfahren: Redaktionsleitfaden ‘b7 ARAKANGA GmbH einsehen.
Der Redaktionsleitfaden ist eine Art „Gesetzbuch“ für den Ersteller einer Technischen Dokumentation. Er definiert die Gestaltung und das Layout, beschreibt Zielgruppen, legt Dokumententypen und Ausgabemedien fest. Er ist somit von großer Bedeutung für jede Redaktionsabteilung. Weitere Informationen zum Redaktionsleitfaden findet Ihr hier: https://arakanga.de/arawiki/technische-dokumentation/redaktionsleitfaden/.
Ein Redaktionsleidfaden in der Technischen Dokumentation ist ein wertvolles Hilfsmittel. Er ist ein „Gesetzbuch“ für Technische Redakteure und stellt sicher, dass Inhalte redaktionell und einheitlich aufbereitet werden. Somit trägt er wesentlich zur Qualität der technischen Dokumente bei. Weitere Informationen zum Redaktionsleitfaden in der Technischen Dokumentation und welche Themen ein Redaktionsleitfaden unbedingt beinhalten sollte, erfahrt Ihr … Weiterlesen