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)

Advance Organizer

Text am Anfang eines Kapitels, der den Leser auf den Inhalt einstimmt.

  • Meist als Vorstrukturierung des Inhalts, Einstimmung und Motivation.
  • Oft grafisch hervorgehoben.

Doku -1 - (von 30)

Leserlichkeit

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

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)

Microcopy

Alle kurzen verbalen Hinweise und Beschriftungen, die die

Bedienung eines User Interfaces erleichtern oder erst ermöglichen.

Doku -4 - (von 30)

Lesehinweis

Text, häufig auf dem Titelblatt, das den Nutzer auffordert, die Anleitung zu lesen.

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

System­dokumentation

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

Doku -7 - (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 -8 - (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 -9 - (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 -10 - (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 -11 - (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 -12 - (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 -13 - (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 -14 - (von 30)

Bedienungsanleitung

eine vom Hersteller mitgelieferte Information zur richtigen Verwendung eines Produkts.

Doku -15 - (von 30)

Schritt-für-Schritt-Anleitung

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

Doku -16 - (von 30)

Garantie

Eine durch den Verkäufer oder Hersteller freiwillig eingeräumte Einstandspflicht dafür, dass innerhalb eines bestimmten Zeitraumes kein Mangel an einer Sache auftritt.

Doku -17 - (von 30)

Lieferumfang

Gesamtheit der vom Hersteller eines Produkt bereitgestellten Produktbestandteile und Dokumente.

  • Meist als Bild des Produkts mit allen Teilen
  • Tabelle der Teile, mit Bezug zum Bild.

Dient dem Nutzer zur Prüfung auf Vollständigkeit.

Doku -18 - (von 30)

Schaltplan

Grafische Darstellung der Schaltung einer elektrischen Einrichtung, eines elektrischen Geräts mithilfe von Schaltzeichen.

Schaltpläne eignen sich in der TD ggf. auch als Information zur Reparatur.

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

Minimalismus

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

Doku -21 - (von 30)

Schritt

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

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

Makroskopische Betrachtung

Überblick über die Funktion eines Systems oder Geräts, ohne ins Detail zu gehen.

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

Impressum

Kapitel meist am Anfang eines Informationsprodukts, das Verwaltungsinformationen zum Dokument enthält.

  • Stand: Verion und Datum
  • Herstelleradresse
  • Veränderungshinweis
  • Copyright
  • Vervielfältigungsverbot

Doku -28 - (von 30)

Gesamtdokumentation

Doku -29 - (von 30)

Variantenmanagement

Methode zur spezifischen bzw. individualisierten Anpassung von Informationen zu einem Produkt/einer Produktserie.

Doku -30 - (von 30)