Terms-Karussell
nur Test!

Bereich: Doku (30)

Terms der Technischen Kommunikation

  • max 30 von 30 Begriffen
  • zufällige Auswahl
  • zum Durchblättern


unfertig
Stand: 18.01.2025
Quellen: tekom terms und D. Juhl

Doku -1 - (von 30)

Informations­beschaffung

Tätigkeit, die darauf gerichtet ist, Informationsquellen zu erschließen und auszuwerten, z.B.

  • Sichtung bestehender Unterlagen
  • Recherche
  • Interviews

Doku -1 - (von 30)

Modul

Ein Modul ist eine Informationseinheit (meist Text und Bild), die bei Bedarf immer wieder und unverändert eingesetzt werden kann.

Module sind besonders bei der Arbeit mit Redaktionssystemen wichtig.

Module werden zentral erstellt und bearbeitet und unverändert in unterschiedlichen Zusammenhängen verwendet (Single Source Publishing).

Doku -2 - (von 30)

Pfad / Inhaltspfad

Ein visueller oder textbasierter Hinweis, der zeigt, in welchem Teil der Dokumentation sich der Leser gerade befindet.

  • Beispiel: Kapitel- oder Abschnittsüberschriften.
  • Beispiel: Bedienung > Normalbetrieb > Ein-Auschalten

Doku -3 - (von 30)

Bedienelemente

Elemente oder Schnittstellen, die von Benutzern bedient werden können, um eine Maschine, ein Gerät oder ein System zu steuern. Beispiele sind Tasten, Schalter, Drehknöpfe oder Touchscreens.

Doku -4 - (von 30)

Sicherheitshinweis

Sicherheitsbezogene Informationen, die nach einem sinnvoll organisierten System in einem Dokument oder Abschnitt eines Dokuments gesammelt oder gruppiert sind, um Sicherheitsmaßnahmen zu erklären, Sicherheitsbewusstsein zu erhöhen und eine Grundlage zur sicherheitsbezogenen Schulung der Personen zu schaffen.

Doku -5 - (von 30)

Handlungsanweisung

Information zur schrittweisen Ausführung einer Tätigkeit.

Von Juhl geprägter Begriff, der die Schritt-für-Schritt-Anleitung strukturiert und mit weiteren Elementen anreichert.

Elemente:

  • Überschrift
  • Ziel der Handlung
  • ggf. Voraussetzungen
  • Schritt für Schritt
  • Handlungsergebnis
  • Ausblick

Doku -6 - (von 30)

Konstruktions­unterlagen

Dokumente, die die vorgesehene Konstruktion so festlegen, dass ein Dritter sie bauen kann oder spezifische Informationen entnehmen kann.

Technische Details zur Konstruktion, wie Zeichnungen, Schaltpläne und Stücklisten.

Die Konstruktions­unterlagen müssen aktuell sein.

Doku -7 - (von 30)

Handlungsziel

Beschreibt das erwartete Ergebnis und erklärt ggf. wann und warum diese Handlung ausgeführt werden soll.

  • steht meistens am Anfang einer Handlungsanweisung
  • Wiederholt die Überschrift und führt sie weiter aus.

Doku -8 - (von 30)

Orientierungselemente

Strukturelle Elemente in einer Dokumentation, die den Lesern helfen, sich schnell zurechtzufinden.

Dazu gehören bei Print:

  • Inhaltsverzeichnis, Überschriften, lebende Kolumnentitel

Bei Digital:

  • Inhaltsverzeichnis (meist in Explorertechnik), Kapitelpfad

Doku -9 - (von 30)

Leistungs­beschreibung

Beschreibt Zweck und Nutzen eines Geräts.

Umfasst:

  • Produktkategorie
  • Normalleistung
  • Besonderheiten
  • technische Details
  • Erweiterungsmöglichkeiten.

Definiert den bestimmungsgemäßen Gebrauch.

Doku -10 - (von 30)

Funktionsweise 1

Informationen welche Komponenten und Abläufe verwendet werden, um technisches Ziel zu erreichen.

Meistens mit Bild der Funktionseinheit und einer schrittweisen Erklärung mit gutem Bild-Textbezug.

Didaktisch kann es sinnvoll sein, zuerst die Normal-Funktionsweise zu beschreiben und andere Fälle anschließend zu erklären.

Beispiel: Funktionsweise des 4-Takt-Motors

Doku -11 - (von 30)

Veränderungshinweis

Text, der darauf hinweist, dass das Produkt möglicherweise in Teilen verändert / verbessert wurde und die Anleitung sinngemäß gilt, z.B.:

Technische Änderungen vorbehalten

Doku -12 - (von 30)

Sicherheits­dokumentation

Enthält Informationen zu den Sicherheitsprotokollen, Verschlüsselungsmethoden, Authentifizierungsverfahren und anderen Sicherheitsmaßnahmen, die in einem System oder Produkt vorhanden sind.

Doku -13 - (von 30)

Produkthandbuch

Synonym zu Nutzungsinformation.

Ein umfassender Leitfaden, der die Einrichtung, Verwendung und Fehlerbehebung eines Produkts abdeckt.

Doku -14 - (von 30)

Anwender / Nutzer

Person, die ein Produkt benutzt, bedient und Nutzen daraus zieht.

Doku -15 - (von 30)

iiRDS

Standard für die intelligente Abfrage und Bereitstellung von Nutzungsinformation, der auf Metadaten basiert und unternehmensübergreifend funktioniert.

Doku -16 - (von 30)

Glossar

Eine Liste von Begriffen mit Definitionen, die sich in der Regel am Ende eines Dokuments befindet.

  • Alphabetisch sortiert, enthält Fachbegriffe, Fremdwörter und Abkürzungen mit Erklärungen.
  • Kann mit Informationen wie Herkunft, Merkmalen oder Nutzen ergänzt werden.

Doku -17 - (von 30)

Funktion

Das Wort "Funktion" ist im Deutschen mehrdeutig.

  • Funktion eines Bauteils = Zweck, dem das Bauteil dient - Funktion, als Teil einer Software, die eine bestimmte Aufgabe ausführt
  • Funktion als Vorgehensweise (ich weiss nicht, wie das Produkt funktioniert)
  • Funktion als Funktionsweise (z.B. des 4-Taktmotors).

Doku -18 - (von 30)

Lieferanten­dokumentation

Dokumentations-Dokumente zu Einzelteilen einer Anlage, die ein Anlagenhersteller zu seiner, von ihm erstellten Anlagendokumentation mitliefert.

Meistens wird diese Lieferanten­dokumentation als Original des Lieferanten unbearbeitet beigefügt und dient dem Betreiber als weitere Quelle bei technischen Fragen.

Probleme:

  • unterschiedliche Terminologie
  • Copyright des Lieferanten

Doku -19 - (von 30)

Hydraulikplan

Grafische Darstellung der Strömungen von Flüssigkeiten für Steuer-, Regel-, Antriebs- und Bremsvorrichtungen von Fahrzeugen, Flugzeugen oder Geräten, deren Kräfte mithilfe des Drucks einer Flüssigkeit erzeugt oder übertragen werden.

Doku -20 - (von 30)

Lesbarkeit

Kriterium für die Textverständlichkeit auf Grund der sprachlichen Gestaltung.

Doku -21 - (von 30)

Informations­architektur

Strukturelle und konzeptionelle Grundlage für die Ausrichtung, Aufteilung und Anordnung von Informationen.

Meist in mehreren Ebenen:

  • Aufteilung in Informationsprodukte
  • Gliederung
  • Aufteilung in Topics
  • Strukturierung der Topics
  • Frontend und Navigation 
  • digitale Abbildung

Doku -22 - (von 30)

Handlungs­orientiert

Eine handlungsorientierte Dokumentation konzentriert sich auf die Beschreibung von Arbeitsschritten und Verfahren, die ein Benutzer durchführen muss, um ein bestimmtes Ziel zu erreichen.

Anstatt technische Details und Spezifikationen zu betonen, wird hier der praktische Ablauf von Tätigkeiten, wie etwa die Bedienung oder Wartung eines Produkts, detailliert beschrieben.

Doku -23 - (von 30)

Schritt

Auszuführende Handlung, die der Nutzer als Einzelnes verstehen und handeln kann.

Doku -24 - (von 30)

Technische Daten

Meist tabellarisch zusammengestellte der technischen Parameter.

Technische Daten unterstützen den Nutzer bei der Auswahl und Prüfung der Leistungsfähigkeit.

Doku -25 - (von 30)

Kontext­sensitivität

Methode, um aus einer Nutzung direkt zur passenden Information zu gelangen.

Oder aus Programmierersicht:
Einbau eines Links in die UI zum passenden Topic.
Hierfür müssen Programmierer und TR kooperieren.

Möglichkeit, Informationen situations- und zielgruppengerecht zu filtern und damit genau passend zum aktuellen Informationsbedarf des Anwenders auszugeben.

Doku -26 - (von 30)

Gesamtdokumentation

Doku -27 - (von 30)

Konsistenz

Gleichförmigkeit in Wortwahl, Struktur und Darstellung.

In allen Informationsprodukten ist Konsistenz gefordert, damit der Nutzer sich an die Darstellung gewöhnt und immer besser zurecht findet.

Doku -28 - (von 30)

Aufbau und Funktion

Kapitel, dass das Produkt aus technischer Sicht beschreibt.

  • Funktionseinheiten
  • Bedienelemente
  • bediente Teile

Doku -29 - (von 30)

Zielgruppenanalyse

Analyse relevanter Merkmale der erwarteten Zielgruppe, vor allem in Bezug auf:

  • Vorwissen
  • Ausbildung
  • Erfahrung

Dabei gibt es unterschiedliche Verfahren zur Erhebung

  • Fragebogen oder Interview
  • #Zielgruppeneinschätzung

Doku -30 - (von 30)