Sollten Anleitungsvideos geplant werden, ist auch hier der Grundsatz "nur so lang wie nötig". Die gewählten Mittel sollten für die Zielgruppe verständlich sein. Das bezieht sich sowohl auf die gewählte Sprache und auf die Illustrationen, aber auch auf grafische Symbole und die Navigationsmethoden. Redaktionshandbuch vs. Gummibändel – Technische Dokumentation. Auch hier findet sich, mal wieder, die Zielgruppe im Fokus. Und das ist genau das, was uns Technische Redakteure so einzigartig macht: wir sind in der Lage, uns in die jeweilige Zielgruppe hineinzudenken und können entscheiden, welche Informationen relevant sind und welche dann ggf. dem Minimalismus Prinzip zum Opfer fallen dürfen.
© hadjanebia / AdobeStock Stücklisten, Schaltpläne, Prüfberichte und Wartungsanleitungen: Die Fülle an technischen Unterlagen ist enorm, die Hersteller mit jeder neuen Maschine an ihre Kunden übermitteln. Wird die Dokumentation auch digital zur Verfügung gestellt, stehen Hersteller häufig vor der Frage: Wie kann die Vielzahl an Dateien in einer sinnvollen und nutzbaren Struktur an den Betreiber übergeben werden? Bislang war es üblich, dass die Hersteller die Dateipakete nach einem individuellen Vorgehen – oft entsprechend den spezifischen Anforderungen des Betreibers – zusammengestellt haben. Das Problem hierbei: Die fehlende Einheitlichkeit beim Dateien-Management mindert den Nutzen der digitalen Dokumentation erheblich. Redaktionsleitfaden technische dokumentation pdf from unicef irc. So werden Zugriff und Einordnung der übermittelten Dokumente unnötig erschwert. Häufig muss jedes einzelne Dokument aufwendig aus einem unübersichtlichen Ordnersystem herausgesucht und händisch in die Struktur des Betreibersystems überführt werden. Wie geht es besser?
404 - Hier scheint nichts zu sein!
Für jedes Dokument werden die einzelnen Dateien nun in einem ZIP-Container zum sogenannten Dokumentcontainer zusammengefasst. Die Gesamtdokumentation besteht somit aus vielen einzelnen ZIP-Containern. Diese Einzelcontainer werden wiederum in einem eigenen ZIP-Hauptcontainer abgelegt. Redaktionssystem einführen. Dieser enthält auf erster Ebene zusätzlich ein Hauptdokument, das sich wie die anderen Dokumente aus einer PDF/A-Datei und der zugehörigen Metadatendatei zusammensetzt. In der PDF/A-Datei ist eine für den Menschen lesbare Auflistung der einzelnen Dokumente enthalten. Die XML-Datei wiederum referenziert alle Unterdokumente anhand ihrer Dokument-ID. Mit diesem Vorgehen lassen sich im Übrigen auch die Herstelleranleitungen der einzelnen Subsysteme einer Anlage schnell und einfach in die Gesamtdokumentation integrieren. Dateiformat Die Technische Dokumentation von Maschinen und Anlagen muss langfristig lesbar und durchsuchbar sein. Daher schreibt die VDI 2770 das speziell für die Langzeitarchivierung digitaler Dokumente entwickelte Format PDF/A vor.
Auch welche Schriften, Farben und Logos überhaupt verwendet werden dürfen. Die Konstruktions- bzw. Entwicklungsabteilung hat Angaben dazu welche Normen und Richtlinien bei der Entwicklung neuer Produkte zum Einsatz kommen. Oder in welchen Formaten Zeichnungen zur Verfügung stehen und wie man diese dann in der Technischen Dokumentation nutzen kann. Auch wie und nach welchen Regeln neue Funktionen und Produkte benannt werden. Die Abteilung des Kundenservice liefert Meldungen aus der Produktbeobachtung aus der man Rückschlüsse für zukünftige Dokumentationen ziehen kann, die dann in den Redaktionsleitfaden einfließen können. Das eingesammelte Material kann dann auf dem Rechner gespeichert werden. Redaktionsleitfaden technische dokumentation pdf model. Nutzen Sie eine Datenstruktur mit unterschiedlichen Verzeichnissen, um ihre Materialsammlung systematisch zu ordnen. Dann können die gesammelten Informationen aufbereitet werden und für jedermann in Form eines Redaktionsleitfaden zugänglich gemacht werden. Wie das geht, werde ich in der kommenden Folge genauer erläutern.
Durch deren Fähigkeiten und Einsatz gelingt es uns, aktuelle Technologien und Qualitätsstandards umzusetzen. Auf unserer Homepage finden Sie weitere Informationen über das Unternehmen, unsere Produkte und unsere Werte.
Das Erstellen eines Redaktionsleitfadens (RLF) ist in vielen Technischen Redaktionen auf Grund von Ressourcenmangel sehr oft problematisch. Jedoch ergibt sich mit dem Implementieren von TIM die Möglichkeit, das Thema Redaktionsleitfaden parallel zu starten und zumindest einen ersten Entwurf zu erstellen. Folgende Situation treffe ich oft bei Interessenten an: Ja, es gibt einen Redaktionsleitfaden und wir arbeiten bereits auch danach. Ja, es gibt einen Redaktionsleitfaden, aber der ist veraltet und nicht aktuell. Nein, es gibt noch keinen Redaktionsleitfaden. Situation 1 ist natürlich die optimale Antwort. Die häufigste Situation, die ich allerdings antreffe, ist jedoch Situation 3. Von dieser Situation gehen wir auch in diesem Beitrag aus. Redaktionsleitfaden technische dokumentation pdf in online. Vorteile und Nutzen eines Redaktionsleitfaden In einem Redaktionsleitfaden steckt jede Menge Arbeit und Wissen von verschiedenen Personen aus Ihrem Unternehmen. Diese Arbeit ist wertvoll und steigert nachweislich die Qualität Ihrer Informationsprodukte.