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)

Wartungsplan

Ein Informationsprodukt oder Teil einer Anleitung, die regelmäßige Wartungsarbeiten sowie deren Intervalle und Verantwortlichkeiten beschreibt, um den Betrieb und die Langlebigkeit eines Geräts sicherzustellen.

Meist nach Wartungsintervallen geordnet, z.B.: täglich, monatlich, alle 100 Std.

Doku -1 - (von 30)

Tätigkeits­beschreibung

Methoden, die geeignete sind, einem Nutzer eine Tätigkeit so zu vermitteln, dass er sie ohne fremde Hilfe ausführen kann, z.B.:

  • Schritt-für-Schritt-Anleitung
  • Handlungsanweisung
  • Regeln zur Handlung
  • Erklärung der Bedienelemente (Wirkung, Möglichkeiten) Abbildungen

Doku -2 - (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 -3 - (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 -4 - (von 30)

Microcopy

Alle kurzen verbalen Hinweise und Beschriftungen, die die

Bedienung eines User Interfaces erleichtern oder erst ermöglichen.

Doku -5 - (von 30)

Tabellen­verzeichnis

(automatisch erzeugte) Liste aller in der Dokumentation eingebundenen tabellarischen Objekte.

Doku -6 - (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 -7 - (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 -8 - (von 30)

Gamification

Einbinden von spielerischen Ansätzen und Reizen, um die Effizienz und Effektivität von Tätigkeiten zu verbessern, um Zusammenarbeit zu stimulieren und Innovationen anzuregen.

Doku -9 - (von 30)

Barrierefreiheit

Gebrauchstauglichkeit eines Produktes, einer Dienstleistung, einer Umgebung oder einer Einrichtung für eine in Bezug auf ihre Fähigkeiten möglichst weit gefasste Gruppe von Menschen.

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

Dokumenten­management

Datenbankgestütztes Verwalten von elektronischen oder elektronisch erfassten Dokumenten, das z. B. das Finden über Metadaten, das Verwalten von Textmodulen und deren Versionen und Varianten, Archivierung, Freigabeprozesse und Erzeugen von Ausgabeinstanzen Single Source Publishing) beinhaltet.

Doku -12 - (von 30)

Dokumentations­struktur

Strukturierung aller Dokumente.

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

Doku -13 - (von 30)

Schritt

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

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

Sicherheitskapitel

Kapitel am Anfang des Informationsproduktes mit Hinweisen zur Sicherheit

  • Warnung vor allgemeinen Gefahren
  • Muss vom Nutzer vor der Nutzung gelesen werden und behalten werden
  • Aufbau eines Sicherheitsbewusstseins
  • Richtiges Verhalten - Begründung
  • Warnung - Richtiges Verhalten

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

Datenblatt

Ein Dokument, das detaillierte technische Spezifikationen zu einem Produkt oder einer Komponente enthält und häufig in der Technik- und Hardwaredokumentation verwendet wird.

Doku -22 - (von 30)

Anleitung zur Anleitung

Kapitel in einer Anleitung, dass die Systematik der Ordnung erklärt oder Tipps zur Benutzung der Anleitung gibt.

Normalerweise sollte dieses Kapitel nicht notwendig sein, die Ordnung sollte selbsterklärend sein.

Bei besonderen Systematiken oder neuen Anordnungen kann das Kapitel sinnvoll sein.

Doku -23 - (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 -24 - (von 30)

Technische Dokumentation

Gesamtheit aller notwendigen und zweckdienlichen Informationen über ein Produkt und seine Verwendung, die in strukturierter Form – sei es auf Papier oder als elektronische Medien – festgehalten sind.

Doku -25 - (von 30)

Software­funktions­beschreibung

Geräteorientierte Darstellung, die eine Softwarefunktion als Ganzes erklärt (im Gegensatz zur handlungsorientierten Darstellung).

Beschreibt eine Softwarefunktionen als Angebot einen Zweck zu erfüllen und zeigt Varianten (Handlungsmöglichkeiten) auf.

Doku -26 - (von 30)

Schritt-für-Schritt-Anleitung

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

Doku -27 - (von 30)

Technische Unterlagen

Informationen, die während der Konstruktion eines Geräts erstellt werden.

Dazu gehören Konstruktionszeichnungen, Schaltpläne, Ersatzteillisten, und Serviceunterlagen.

Diese sind für Fachleute bestimmt und enthalten keine Anweisungen für Endbenutzer.

Doku -28 - (von 30)

Topic

In sich abgeschlossener Inhaltsblock, der durch Überschrift und Inhalt bestimmt wird, eine Kernaussage mit den vollständigen Informationen zu einem Thema enthält und ohne weiteren Kontext gelesen und verstanden werden kann.

Kriterien nach Mark Baker #EPPO:

  • self contained
  • Specific + Limited Purpose
  • Conform to a Type
  • Establish their context
  • Assume the Reader is Qualified
  • Stay on one Level
  • Link Richly

Doku -29 - (von 30)

iiRDS

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

Doku -30 - (von 30)