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)

Sicherheits­vorschriften

Oberbegriff: Rechtliche Anforderungen

Merkmale:

  • Beinhalten Warnhinweise und Maßnahmen zur Unfallvermeidung.
  • Wichtiger Bestandteil von technischen Dokumentationen.

Beispiele: Maschinenrichtlinie, spezifische Warnungen für Messgeräte​.

Doku -1 - (von 30)

Fehlersuchtabelle

Eine Tabelle, die typische Fehler, deren mögliche Ursachen und geeignete Maßnahmen zur Fehlerbehebung auflistet. Sie dient als Hilfsmittel zur schnellen Problemlösung.

Vorzugsweise geordnet nach Auftrittswahrscheinlichkeit (häufige Fehler zuerst).

Doku -2 - (von 30)

Style Guide

Eine Reihe von Standards für das Schreiben und Formatieren von Dokumenten, die eine einheitliche Sprache, einen einheitlichen Ton und eine einheitliche Darstellung gewährleisten.

Doku -3 - (von 30)

Überschrift

Herausgehobener Absatz am Anfang eines Kapitels.

  • meist größer formatiert
  • klare Aussage zum Kerninhalt des Kapitels
  • als Orientierung für den Nutzer, ob das Kapitel für seine momentane Frage relevant ist

Doku -4 - (von 30)

Abbildung der Handlung

Möglichkeit mit einer Abbildung zu einer Handlung anzuleiten, z.B.:

  • ein Bild mit Nummern und grafischer Gestaltung der Arbeitsschritte
  • mehrere Bilder mit jeweils einem Arbeitsschritt

Doku -5 - (von 30)

Informations­beschaffung

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

  • Sichtung bestehender Unterlagen
  • Recherche
  • Interviews

Doku -6 - (von 30)

Leserlichkeit

Eigenschaft der eindeutigen Erkennbarkeit eines einzelnen Zeichens oder Symbols, das ohne Kontext dargestellt wird.

Doku -7 - (von 30)

Microcopy

Alle kurzen verbalen Hinweise und Beschriftungen, die die

Bedienung eines User Interfaces erleichtern oder erst ermöglichen.

Doku -8 - (von 30)

Sicherheits- und Warnhinweise

Informationen in einer Nutzungsinformation, die der Sicherheit des Nutzers bei der Verwednung und der Erreichung eines sicheren Ergebnisses dienen.

  • Sicherheitshinweise: Hinweise zu allgemeinen Gefahren und deren Vermeidung beim Umgang mit dem Produkt am Anfang der Nutzungsinformation
  • Warnhinweise: Warnung vor Gefahren bei einer Handlung

Doku -9 - (von 30)

Schritt-für-Schritt-Anleitung

Text, der zur Erreichung eines Zieles konkrete Vorgaben für jeden einzelnen Schritt macht.

Doku -10 - (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 -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)

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 -13 - (von 30)

Anhang

Ergänzungen zum Haupttext am Ende eines Dokuments, die

Anmerkungen, statistische Tabellen oder andere Informationen enthalten

Doku -14 - (von 30)

Minimalismus

Prinzip, dass Nutzungsinformationen kritische Informationen und die kleinstmögliche Menge anderer erforderlicher Informationen enthalten, um vollständig zu sein.

Doku -15 - (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 -16 - (von 30)

Sicherheitsbezogene Information

Informationen, die vor allem der Sicherheit des Nutzers vor Verletzungen dienen.

Doku -17 - (von 30)

Informations­entwicklung

Prozess der Entwicklung, Strukturierung und Präsentation von Informationen.

Doku -18 - (von 30)

Funktionsbeschreibung

Bei Software nach Juhl:

Erklärung einer Softwarefunktion als Ganzes und in Teilen, um den Nutzer per Verständnis handlungsfähig zu machen.

Dabei werden der Zweck der Gesamtfunktion erklärt und Handlungsmöglichkeiten aufgezeigt und illustriert.

Doku -19 - (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 -20 - (von 30)

barrierefreie Dokumentation

Dokumentation, die Menschen mit Behinderung Zugriff auf alle Informationen erlaubt (z. B. Textalternativen für visuelles Material, Farbgestaltung, einfache Sprache).

Zumeist beschränkt man dies auf die Bedarfe von Menschen mit physischen Behinderungen.

Doku -21 - (von 30)

Aufbau und Funktion

Kapitel, dass das Produkt aus technischer Sicht beschreibt.

  • Funktionseinheiten
  • Bedienelemente
  • bediente Teile

Doku -22 - (von 30)

Gerätebeschreibung

Beschreibt Aufbau und Funktion eines Geräts meist mit:

  • Abbildung des Produkts
  • Name und Funktion der Teile
  • Erklärung der Zusammenhänge

Dient einem Nutzer als erste Information und Kennenlernen der verwendeten Bezeichnungen von Bedienelementen und bedienten Produktteilen.

Doku -23 - (von 30)

Dokumentations­struktur

Strukturierung aller Dokumente.

Regelt die Aufteilung, Anordnung und Gestaltung von Dokumentationsinhalten. Ermöglicht eine logische und benutzerfreundliche Navigation.

Doku -24 - (von 30)

Redaktionsleitfaden

Sammlung verbindlicher Vorgaben innerhalb eines Unternehmens für das Erstellen von Technischer Dokumentation.

Doku -25 - (von 30)

Kurzanleitung

Eine Kurzanleitung ist eine zusätzliche Anleitung, die die Schritte jeder Handlung gekürzt darstellt, meistens als Bild und Kurztext.

Sie soll dem eingearbeiteten Nutzer als Gedächtnisstütze bei der Ausführung von Handlungen dienen.

Doku -26 - (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 -27 - (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 -28 - (von 30)

System­dokumentation

Dokumentation, die erklärt, wie ein System funktioniert, einschließlich seiner Komponenten, Konfiguration und Verwendung.

Doku -29 - (von 30)

mobile Technische Dokumentation

Technische Dokumentation, die technisch und von der Darstellung so ausgeführt ist, das sie auf mobilen Endgeräten benutzt werden kann.

  • Smartphones, Tablet-PCs und tragbaren Displays aller Art

Häufig ist die TD responsiv ausgeführt, so dass sie auf unterschiedlichen Devices gut dargestellt wird.

Teilweise wird das Mobile-First Prinzip angewendet:
Dabei ist die Darstellung auf Smartphones optimiert aber andere Devices möglich (ggf. nicht optimal).

Doku -30 - (von 30)