Viele der heute benötigten technischen Informationen sind üblicherweise in Computersoftware, verschiedenen Tools und elektronischen Geräten enthalten. Technische Kommunikation ist unerlässlich, um Informationen auszutauschen und den Nutzern ein besseres Verständnis der Technologie oder des Produkts zu ermöglichen. Die Erstellung technischer Informationen und deren Übersetzung erfordern Zeit.
Die Hersteller geben ihr Wissen über technische Dokumentationen weiter.
Definition der technischen Dokumentation
Wie bereits erwähnt, erstellen Hersteller technische Dokumentationen, um Endnutzern das Verständnis der Architektur und Funktionsweise der verwendeten Geräte oder Produkte zu erleichtern. Es handelt sich dabei um eine detaillierte Produktbeschreibung und eine Anleitung zur Verwendung des jeweiligen Produkts.
Teile eines technischen Dokuments
Die Bestandteile eines technischen Dokuments variieren je nach Dokumentart und dessen Zweck. Im Allgemeinen besteht ein Anleitungsdokument aus drei wesentlichen Teilen:
- Inhaltsverzeichnis
- Tatsächliche Anweisungen
- Index oder Glossar
Elemente eines technischen Dokuments
In jeder Hauptkomponente gibt es viele Unterkomponenten, sodass für das Verfassen technischer Dokumente ein Experte erforderlich ist.
1. Vordere Abdeckung
- Titel
- Dokumentnummer
- Dokumentversion
- Titel des Produkts
- Produktversion
- Veröffentlichungsdatum des Dokuments
- Eine Urheberrechtserklärung, ein Datum oder andere geschützte Texte zum geistigen Eigentum
- Das Produktbild oder die Grafik
- Firmenlogo
- Markenerklärung für die verschiedenen im technischen Dokument genannten Marken
- Unternehmensinformationen, Kontaktnummern, Website-URL usw.
- Haftungsausschluss- und Offenlegungstexte
Hinweis: Sie fügen der Titelseite keine Seitenzahl hinzu
2. Inhaltsverzeichnis
Bei der Erstellung des Inhaltsverzeichnisses (TOC) beginnen Sie in der Regel mit der Seitenzahl in Kleinbuchstaben. Normalerweise beginnen Sie mit „iii“ oder der römischen Ziffer „3“, da die Titelseite normalerweise zwei Seiten umfasst.
Als Nächstes folgen die Kapitelüberschriften und Seitenzahlen. Die Abschnittsüberschriften und Seitenzahlen werden eingerückt. Auch die Unterabschnitte werden eingerückt. Alle Einträge im Inhaltsverzeichnis sollten eine Seitenzahl enthalten, auf der der Benutzer die jeweilige Information finden kann.
Nach den Titeln folgen das Abbildungsverzeichnis mit Seitenzahlen , das Tabellenverzeichnis mit Seitenzahlen, weitere Verzeichnisse (z. B. Autorenverzeichnis), gefolgt von Glossar , Anhang, Extras und Index.
Das Glossar besteht üblicherweise aus zwei Spalten für den Artikel und die Beschreibung und enthält die im Inhalt verwendeten Fachbegriffe, Abkürzungen und Akronyme.
3. Rückseite
Auf der Rückseite befinden sich das Firmenlogo , alle Kontaktdaten des Unternehmens sowie der Copyright-Vermerk und das Erscheinungsdatum.
10 Tipps zur Verbesserung der technischen Schreibfähigkeiten
Forscher und Ingenieure erstellen in der Regel technische Dokumente. Sie müssen über Kommunikationsfähigkeiten verfügen, um sicherzustellen, dass Benutzer verstehen, was sie vermitteln möchten. Oftmals verfügen sie jedoch nicht über die Schreibfähigkeiten, um technische Dokumente zu erstellen, die der Endbenutzer auf jeden Fall zu schätzen weiß, da ihr Verständnisniveau unterschiedlich ist.
Wenn Sie sich auf technisches Schreiben spezialisiert haben, verfügen Sie über die Fähigkeit, funktionale Dokumente zu erstellen, und verfügen über ein hohes Maß an technischem Fachwissen und Verständnis sowie eine kohärente, prägnante und klare Art, Informationen auszudrücken.
Hier finden Sie einige Hinweise, wie Sie Ihre Fähigkeiten im technischen Schreiben verbessern können.
- Denken Sie an die Zielgruppe
Technisches Schreiben hat eine bestimmte Zielgruppe. Sie sollten darüber nachdenken, wer sie sind und was sie wissen und tun müssen. Stellen Sie dem Leser eine Reihe logischer Schritte zur Verfügung und erklären Sie, was er bei jedem Schritt tun muss.
- Kennen Sie das Produkt in- und auswendig
Sie müssen das Produkt gründlich kennen, damit Sie komplexe Ideen und Konzepte in einfachen Worten vermitteln können. Holen Sie alle Informationen vom Kunden ein, führen Sie zusätzliche Recherchen durch, konsultieren Sie Experten und lesen Sie relevante Informationen. Tun Sie dies, bis Sie bereit sind, den Inhalt genau, aber in einer leicht verständlichen Sprache zu erklären.
- Denken Sie an die richtige Struktur
Erstellen Sie eine logische Struktur für die Bereitstellung von Informationen. Überlegen Sie, was die Benutzer tun müssen, wenn sie auf ein Problem stoßen. Denken Sie an alles, was schief gehen kann, und erklären Sie es genau. Stellen Sie sicher, dass die Ideen frei und natürlich fließen. Verwenden Sie Übergänge, wenn mehrere Abschnitte vorhanden sind, um die Lesbarkeit zu verbessern.
- Gestalten Sie den Text richtig
Das richtige Layout erleichtert die Navigation im Text. Das richtige Layout macht den Text verständlicher. Denken Sie daran, dass einige Leser das Dokument durchblättern und die wichtigen Punkte aufgreifen, die sie benötigen, während andere den gesamten Inhalt lesen möchten.
- Illustrationen hinzufügen
Illustrationen können die Monotonie des Lesens eines kontinuierlichen Textflusses unterbrechen. Zur Identifizierung der Teile des Produkts, beispielsweise eines Laptops, können Abbildungen erforderlich sein. Sie können Diagramme, Fotos, Illustrationen, Diagramme und Tabellen verwenden. Gehen Sie jedoch sparsam damit um und stellen Sie sicher, dass Benutzer beim Lesen verwandter Texte auf sie zurückgreifen können.
- Geben Sie Beispiele an
Beispiele verknüpfen die Informationen, die Sie haben, mit der Realität und verwandeln die Ideen in praktische Dinge. Das Hinzufügen von Bildern kann helfen, verschiedene Situationen zu erklären.
- Verbessern Sie die Durchsuchbarkeit
Stellen Sie sicher, dass der Leser relevante Informationen mithilfe des Inhaltsverzeichnisses oder des Index leicht finden kann. Das Inhaltsverzeichnis ist die Roadmap für das gesamte Dokument. Der Index ist auch hilfreich bei der Suche nach bestimmten Informationen.
- Vernetzen Sie sich mit den Lesern
Menschen werden Ihren Text verwenden, also verwenden Sie einen Konversationsstil. Schreiben Sie in der zweiten Person, was die Lesbarkeit Ihres Textes zusätzlich erhöht. Verwenden Sie so oft wie möglich die aktive Stimme und das Präsens. Bedenken Sie, dass die Leser unterschiedliche Verständnisniveaus haben, daher ist es sinnvoll, den Text zugänglich zu machen.
- Lesen und überarbeiten
Auch wenn Sie ein Fachexperte sind, lesen und überarbeiten Sie Ihren Text immer. Die Verwendung eines Lektors und Korrektors hilft dabei, das Dokument vor der Einreichung zu testen und Fehler darin zu finden.
- Holen Sie sich Feedback
Feedback wird Ihnen helfen, Ihre Fähigkeiten im technischen Schreiben zu verbessern. Sie werden wissen, ob Ihr Dokument hilfreich ist, ob sie die Botschaft verstehen oder ob ihre Fragen die Lösungen in Ihrem Text finden. Konstruktive Kritik und negatives Feedback geben Ihnen die Möglichkeit, Ihre Schreibfähigkeiten zu verbessern, da andere Menschen Fehler und andere unnötige Schreibmuster erkennen können, die Sie selbst nicht erkennen können.
Benötigen Sie Hilfe bei der Übersetzung technischer Dokumente?
Technische Dokumente erfordern Fachkenntnisse, und eTranslation Services stellt Ihnen gerne einen Experten zur Verfügung. Unsere Übersetzer sind Muttersprachler mit jahrelanger Berufserfahrung und übersetzen technische Dokumente in über 200 Sprachen. Kontaktieren Sie uns noch heute per E-Mail unter [email protected] oder telefonisch unter +1 (800) 882-6058 für ein unverbindliches Angebot oder weitere Informationen.
