Häufig gestellte Fragen
Auf dieser Seite finden Sie kompakte Antworten auf häufig gestellte Fragen zur Technischen Dokumentation und zur Zusammenarbeit mit der ZINDEL AG.
Falls Ihre Frage hier nicht beantwortet wird, sprechen Sie uns gerne direkt an.
Technische Dokumentation umfasst alle schriftlichen, grafischen und multimedialen Informationsprodukte, die zu einem technischen Produkt gehören.
Man unterscheidet die interne Technische Dokumentation, mit allen Konstruktionsdaten, Dokumentationsnachweisen und Entwicklungsinformationen (wie z. B. Risikobeurteilung und Testprotokolle), die in der Regel beim Hersteller verbleiben, und die externe Technische Dokumentation, mit den Informationen und Unterlagen, die bei der Auslieferung an den Kunden oder Nutzer mitgegeben werden.
Zusammengenommen sind dies die Nutzungsinformationen. Sie berücksichtigen alle Lebensphasen des Produkts, vom Transport über die Installation, die Inbetriebnahme, den Betrieb, die Wartung und die Fehlerbehebung bis zur Stillsetzung und Entsorgung. Darüber hinaus sind die Sicherheitshinweise sowohl für den Gebrauch des Produkts, als auch aus rechtlicher Sicht von zentraler Bedeutung.
Die Nutzungsinformationen dienen dazu, Anwender und Betreiber in die Lage zu versetzen, das Produkt sicher, effektiv und im Sinne der einschlägigen Normen und Richtlinien zu verwenden.
Die Technische Dokumentation ist wesentlich für Aspekte wie Produkthaftung, Normenkonformität und Anwenderzufriedenheit, sowie zur Vermeidung von Rückrufaktionen und Sicherheitsrisiken. Bei ZINDEL sorgen wir dafür, dass Ihre Dokumentation qualitativ zu Ihren hochwertigen Produkten passt. Dies bedeutet: Verständlichkeit, Gebrauchstauglichkeit und Rechtskonformität aller Unterlagen.
Mit Technischer Dokumentation bezeichnet man zunächst sämtliche Produkte, die Informationen technisch korrekt aufbereiten und darstellen: Handbücher, Bedienungsanleitungen, Ersatzteilkataloge, Visualisierungen, Videos, Online-Hilfen etc. Darüber hinaus meint der Begriff den Fachbereich der Planung und Erstellung von Technischen Dokumenten.
Technische Redaktion ist die konkrete, handwerkliche Umsetzung der Technischen Dokumentation: Fachautoren und Redakteure gliedern Inhalte, formulieren verständlich, wählen Layouts, Grafiken und Medien und überarbeiten und pflegen Dokumente. Zudem recherchieren sie Normen, verwalten Übersetzungstools, erstellen Verzeichnisse und betreuen Redaktionssysteme.
Technische Kommunikation meint übergreifend die kommunikativen Mittel und Strategien in der Technischen Dokumentation. Sie umfasst visuelle, digitale und interaktive Kanäle sowie Content-Strategie und Anwenderkommunikation, und setzt linguistische und konzeptionelle Erkenntnisse in praktische Handlungsweisen um.
Der gemeinsame Kern aller drei Begriffe ist das Bemühen und der Anspruch, Technik und Produkte dem Nutzer so zu vermitteln, dass er sie gefahrlos und effektiv nutzen kann.
Damit Ihre Technische Dokumentation gut aufgestellt ist, braucht es Knowhow in der Technischen Kommunikation und eine professionelle Technische Redaktion, um die Kommunikationsprodukte bestmöglich umzusetzen.
Die Bedienungsanleitung richtet sich meist an Endnutzer oder Konsumenten. Sie beschreibt die sichere, effektive und bestimmungsgemäße Nutzung eines Produkts. Dies umfasst die Verwendungsarten des Produkts, Sicherheitshinweise, Bedienfunktionen, das Ein- und Ausschalten, Instandhaltung und Fehlerbehebung etc.
Die Betriebsanleitung bezieht sich in der Regel auf Anlagen und Maschinen, die im industriellen Rahmen eingesetzt werden, und wendet sich an den Betreiber und das Bedien- und Wartungspersonal. Neben der Sicherheit werden Hauptaspekte und Lebensphasen wie Betriebszustände und -überwachung, Installation, Inbetriebnahme, Instandhaltung und Demontage beschrieben.
In beiden Dokumenten geht es um die Erfüllung der Instruktionspflicht, die einem Hersteller bzw. dem für das In-Verkehr-Bringen eines Produkts Verantwortlichen obliegt; beide Anleitungstypen müssen in Übereinstimmung mit den relevanten Normen und Richtlinien stehen und die sicherheitsrelevanten Aspekte gemäß den normativen Anforderungen wie z. B. dem Verfahren der Risikobeurteilung und der CE-Konformität erfüllen. (Anmerkung: In vielen Sprachen wird zwischen Betriebs- und Bedienungsanleitung begrifflich nicht unterschieden.)
1. In einem Erstgespräch vor Ort oder online ermitteln wir gemeinsam Ihren individuellen Bedarf. Dabei konzentrieren wir uns voll auf Ihre individuelle Situation. Begleitend arbeiten wir mit Checklisten, um die wichtigsten Punkte Ihres Bedarfs abzusprechen. Welche Informationsprodukte müssen erstellt werden, wie sieht Ihre Produktpalette aus, wo hakt es aktuell, was sind Ihre Ziele?
2. Lösungsvorschlag & Angebot: Wir erarbeiten auf Basis der Informationen und mitgeschickter Dokumente einen Lösungsvorschlag und bieten diesen als Angebot an. Oft umfasst das Angebot als erstes eine Recherche und Konzeptphase an, in der alle Weichen für das Projekt gestellt werden. Dadurch lassen sich im weiteren Projektverlauf viele Kosten einsparen.
3. Erstellung & Redaktion: In unserem Erstellungsprozess kommen viele verschiedene redaktionelle Handwerksmittel zum Einsatz wie zum Beispiel Gliederung, Zielgruppenanalyse, Terminologiearbeit, Inhalte schreiben, Illustrationen/Grafiken integrieren. Wir arbeiten nach unserem Redaktionsleitfaden und spezifischen Kundenanforderungen. Außerdem ist bei uns in der Regel immer ein ganzes Team im Einsatz, bestehend aus Projektleiterinnen, Redakteuren, Grafikerinnen und Übersetzungsmanagern.
4. Qualitätssicherung und Kundenreview: Vor der Lieferung durchläuft das Informationsprodukt bereits unseren internen Qualitätssicherungsprozess. Danach ist der Kunde gefragt, der uns Feedback zu den Inhalten gibt und insbesondere die technischen Details prüft.
5. Bereitstellung & Pflege: Veröffentlichungsweg (digital oder als gedruckte Anleitung), Updates bei Produktänderungen, Revisionen, wenn Normen oder Gesetze sich ändern.
Bei ZINDEL übernimmt unser Team sämtliche Aufgaben rund um Technische Dokumentation: von der Konzeption, über Implementierung von geeigneten Prozessen in der Zusammenarbeit, bis zur Erstellung und normgerechten Übersetzung. Wir stellen sicher, dass Ihre Anleitungen aktuell, konsistent in Terminologie, qualitativ hochwertig und normenkonform sind. Sie erhalten Transparenz durch Projektstandberichte und regelmäßige Meetings. Außerdem haben Sie mit unserem digitalen Projektstatus-Tool jederzeit den Überblick über alle Projekte. Zudem können wir Ihnen den Zugriff auf die Terminologiedatenbank und die Redaktionssysteme anbieten; sowie ein Kundenportal, über das alle Dokumente zentral zur Verfügung stehen.
Das hängt ab vom Umfang (z. B. Anzahl der Module, Komplexität des Produkts), der Zielgruppe, den Medien (print, online, digital) und davon, ob eine Übersetzung oder Multimedia-Inhalte (z. B. Grafiken, Videos) benötigt werden. Kleinere Bedienungsanleitungen können in wenigen Wochen erstellt werden, größere Betriebs-Anlagendokumentation oder komplexe Software-Hilfen können oft mehrere Monate. Bei ZINDEL wird in der Projektplanung individuell ein Zeitplan abgestimmt, der alle relevanten Faktoren berücksichtigt. Ein wesentlicher Faktor sind dabei immer auch der Stand der Entwicklung des Produkts und die Änderungen, die sich während des Erstellungsprozesses ergeben. Diese können Zeitplanung und Kosten stark beeinflussen.
Die Kosten variieren stark je nach Produktkomplexität, Zielgruppe, Normanforderungen, Übersetzungsbedarf, Grafik-/Videoanteil und Medium (digital vs. Print). Einfache Bedienungsanleitungen kosten deutlich weniger als umfangreiche Betriebsanleitungen mit vielen Sicherheits- und Wartungshinweisen. Bei ZINDEL erhalten Sie ein maßgeschneidertes Angebot nach Bedarfsanalyse – mit transparenten Kostenkomponenten. Für die Kalkulation erstellen wir ein Mengengerüst, das bereits die geplante Kapitelstruktur mit den geschätzten Seitenzahlen angibt. Dieses Mengengerüst stimmen wir mit unseren Kunden ab, so dass sich alle einig sind, was geleistet wird und welche Aufwände entstehen.
Redaktionssystem (CCMS):
Die Softwareumgebung ermöglicht es, Anleitungen effizient modular zu organisieren.
Jedes Modul behandelt eine abgeschlossene Informationseinheit und kann in verschiedenen
Anleitungen wiederverwendet werden. Redaktionssysteme erleichtern das Verwalten
der Informationen, das Versionieren und den Übersetzungsprozess.
Terminologiemanagementsystem:
In einer Datenbank sind Informationen zu allen relevanten Fachbegriffen abgelegt.
Neben den Definitionen und bevorzugten Fachwörtern sind auch Synonyme hinterlegt,
die nicht in den Texten auftauchen dürfen, sowie die fremdsprachigen Äquivalente. Auf
diese Weise kann die Redaktion sicherstellen, dass in den Anleitungen nur bevorzugte
Fachwörter vorkommen.
Translation-Memory-System:
Wichtigster Bestandteil des Programms für die computergestützte Übersetzung ist der Übersetzungsspeicher.
Das Programm zerlegt einen Text in einzelne Satzteile. Bei der Übersetzung
werden diese Satzteile mit den fremdsprachigen Entsprechungen verknüpft.
Bei weiteren Übersetzungen, in denen bereits bekannte Satzteile vorkommen, liefert das
Programm automatisch die vorhandene Entsprechung aus dem Übersetzungsspeicher.
– Erstellung von Technischen Dokumentationen gehörtbei den meisten Unternehmen nicht zum Kerngeschäft. Durch das Outsourcing wird das interne Team entlastet und kann sich voll auf wertschöpfende Tätigkeiten konzentrieren.
– Zugriff auf spezialisiertes Fachwissen, aus vielen anderen und ähnlichen Projekten.
– Höhere Qualität, Konsistenz und Verlässlichkeit, besonders bei komplexen Produkten und internationalen Märkten.
– Wir übernehmen die Verantwortung, dass Ihre Technische Dokumentation den neuesten rechtlichen Anforderungen entspricht.
– Wir setzen genau so viel Manpower ein, wie für die aktuelle Aufgabe erforderlich ist – das kann ein halber Mitarbeiter sein oder auch vier Mitarbeiter.
– Wir sind da, wenn wir gebraucht werden. Typische Personalnebenkosten fallen nicht an (Recruiting, Einarbeitung, Weiterbildung, dauerhafte Auslastung, Ausfallschutz bei Urlaub, Krankheit oder Kündigung).
– Wir setzen unsere Systeme (Redaktionssystem, Terminologiedatenbank, Translation-Memory-System) für viele Projekte und Kunden ein. Dadurch verteilen sich die Kosten. Unsere Kunden zahlen nur ihren Anteil; nicht aber die Anschaffungskosten und den Wartungsaufwand.
– Einsatz ausgebildeter Technischer Redakteure und Spezialisten für Illustration, Übersetzung etc.
– Nutzung unseres internen Schreibleitfadens.
– Bearbeitung durch mindestens zwei Redakteure pro Projekt, so dass man sich gegenseitig unterstützen kann.
– Anwendung relevanter Normen (z. B. DIN EN 82079-1, ANSI Z535.6) und Qualitätsstandards wie ISO 9001 und ISO 17100.
– Umfangreicher Qualitätssicherungsprozess.
– Konsistente Terminologie und konsistenter Stil durch Redaktionsleitfäden und Terminologiedatenbanken.
– Regelmäßige Sitzungen unserer Technischen Redaktion, in denen wir Projekte vorstellen, nachschulen und gemeinsam neue Regeln festlegen.
