Viele der erforderlichen technischen Informationen, die die Menschen heute kennen, sind häufig in Computersoftware, verschiedenen Werkzeugen und elektronischen Geräten enthalten. Technische Kommunikation ist wichtig, um Informationen auszutauschen und den Benutzern zu helfen, die Technologie oder das Produkt besser zu verstehen. Es braucht Zeit, um darauf zu kommen technische Information und zusätzliche Zeit für die Übersetzung des Inhalts.
Die Art und Weise, wie Hersteller ihr Wissen weitergeben, ist durch technische Dokumentation.
Definition der technischen Dokumentation
Wie bereits erwähnt, erstellen Hersteller technische Dokumentationen, um Endbenutzern zu helfen, die Architektur und Arbeitsdynamik des von ihnen verwendeten Gadgets oder Produkts zu verstehen. es ist ein detaillierte Beschreibung der Produkte und einem Guide zur Verwendung des Artikels.
Teile eines technischen Dokuments
Die Teile eines technischen Dokuments variieren je nach Dokument selbst und seinem Zweck. Im Großen und Ganzen, a Anleitungsdokumentation besteht 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 kommt das Kapiteltitel und die Seitenzahlen. Ziehen Sie die Abschnittstitel und die Seitenzahlen ein. Ziehen Sie auch die Unterabschnitte ein. Alle Einträge im Inhaltsverzeichnis sollten eine Seitenzahl haben, auf der der Benutzer die jeweiligen Informationen finden kann.
Fügen Sie nach den Titeln die ein Abbildungsverzeichnis und die Seitenzahlen, Liste der Tabellen und die Seitenzahlen, andere Listen (z. B. Autoren), gefolgt von der Glossar, Nachtrag, Anhang und Indextitel.
Das Glossar enthält normalerweise zwei Spalten für den Artikel und die Beschreibung und enthält die im Inhalt enthaltenen Fachbegriffe, Abkürzungen und Akronyme.
3. Rückseite
Die Rückseite enthält die Firmenlogo, Alles Unternehmenskontaktinformationenund der Copyright-Erklärung und Datum.
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 Fachwissen und eTranslation Services kann Ihnen gerne einen Experten zur Seite stellen. Unsere Übersetzer sind Muttersprachler und verfügen über die jahrelange Erfahrung, die für die Übersetzung technischer Dokumente in über 200 Sprachen erforderlich ist. Sie können uns eine E-Mail senden an Kontakt@etranslationservices.com oder rufen Sie uns noch heute unter (800) 882-6058 an, um ein unverbindliches Angebot oder weitere Informationen zu erhalten.
