Context Card
Context Cards
Kurze, in sich geschlossene Erklärungen der technischen Zusammenhänge hinter den Nachrichten: eine Frage, eine direkte Antwort, die wichtigsten Punkte und die Glossarbegriffe, auf denen sie aufbaut. Auf US-Englisch, britischem Englisch und Deutsch.
Die Glossare erscheinen auf US-Englisch.
How to read a context cardContext CardÜbergangsthema
Kognitive Belastung und geteilte Aufmerksamkeit: warum Abbildung, Beschriftung und Text zusammengehören
Was sagt die Cognitive Load Theory über die Verbindung von Abbildung und Text in Anleitungen, und was folgt daraus für die Technische Dokumentation?
Cognitive Load Theory: Getrennte Abbildung und Text, die zusammengehören, kosten Arbeitsgedächtnis. Beschriften Sie in der Abbildung.
Symbol · Safety information readability · Usability · DITA task · Instructions for use (IFU) · Safety sign
Zur CardContext CardÜbergangsthema
Mentale Modelle und Konzeptinformation: warum Leser wissen müssen, wie etwas funktioniert, bevor sie handeln
Wie stützt die Forschung zu mentalen Modellen, dass Konzeptinformation in der Technischen Dokumentation vor der Handlungsinformation steht?
Leser handeln nach einem mentalen Modell aus dem Systembild, Dokumentation eingeschlossen. Konzeptinformation vor Handlungen hilft beim Vorhersagen.
Mental model · DITA concept · DITA task · Human-machine interface (HMI) · Instructions for use (IFU) · Operating mode · Mental model (thinking tool)
Zur CardContext CardÜbergangsthema
Fehlerarten und Fehlersuche: von Patzern, Aussetzern und Irrtümern zu Informationen für die Behebung
Wie helfen die Fehlerarten von James Reason und Jens Rasmussens fertigkeits-, regel- und wissensbasiertes Verhalten bei der Gestaltung von Fehlersuche- und Behebungsinformationen?
Patzer, Aussetzer und Irrtümer brauchen andere Hilfe: Konstruktion, Checklisten, Tabellen mit Symptom, Ursache und Abhilfe und Systemmodelle.
Human error · Troubleshooting · DITA troubleshooting topic · Reasonably foreseeable misuse · Risk assessment · Alarm management · Mental model
Zur CardContext CardÜbergangsthema
Kognitionspsychologie in der technischen Kommunikation: Theorie, Anwendung und die Brücken dazwischen
Worin unterscheidet sich Kognitionspsychologie als Theorie von ihrer Anwendung in der Dokumentation, und wie hängen beide zusammen?
Theorie beschreibt, wie Leser wahrnehmen, behalten und entscheiden; Anwendung macht daraus Dokumentationspraxis. Brücken machen jeden Schritt prüfbar.
Mental model · Human error · Warning message · Safety information usability · Usability · Risk assessment · Instructions for use (IFU) · DITA concept · DITA task
Zur CardContext CardÜbergangsthema
Aufmerksamkeit und die Platzierung von Warnhinweisen: von selektiver Aufmerksamkeit und Gewöhnung zum richtigen Ort
Was sagt die Forschung zu Aufmerksamkeit und Warnhinweisen darüber, wo und wie Warnhinweise in Anleitungen stehen sollten?
Ein Warnhinweis wirkt nur, wenn er bemerkt, gelesen, verstanden und befolgt wird. Er steht direkt vor dem Schritt mit der Gefährdung.
Warning message · Safety information usability · Safety information readability · Safety sign · Warning (HMI message) · Alarm flooding · Risk assessment · Residual risk
Zur CardContext CardÜbergangsthema
Arbeitsgedächtnis und Handlungsschritte: warum „sieben plus minus zwei“ die falsche Regel ist
Rechtfertigt die Forschung zum Arbeitsgedächtnis eine feste Höchstzahl von Schritten in einer Handlungsanweisung, etwa sieben plus minus zwei?
Miller (1956) setzte keine Schrittgrenze, Cowan nennt etwa vier Chunks. Schritte stehen auf der Seite: Gestalten Sie jeden Schritt, nicht die Anzahl.
DITA task · Instructions for use (IFU) · Usability · Safety information usability · Mental model
Zur CardContext CardÜbergangsthema
Wie sich First Principles Thinking entwickelt hat: eine Abwandlung vieler Abwandlungen
Woher kommt First Principles Thinking, und wie hat es sich auf dem Weg ins technische Schreiben verändert?
Von Aristoteles über Euklid, Descartes, Boyd und Musk zu mentalen Modellen: Die Fassung für Technische Redakteure ist eine weitere Abwandlung.
First principles thinking · First principle (philosophy) · Socratic questioning · Axiomatic method · Analysis and synthesis (method) · Cartesian method · First-principles calculation · Destruction and creation (John Boyd) · Reasoning by analogy · Mental model · Latticework of mental models · Five whys · Risk assessment · Assumption (systems engineering)
Zur CardContext Card
Vorhersehbare Fehlanwendung dokumentieren, ohne sie zur Option zu machen
Wie beschreibt eine Anleitung vernünftigerweise vorhersehbare Fehlanwendung, ohne sie als Art der Verwendung darzustellen?
Vorhersehbare Fehlanwendung wird als klare Grenze mit Begründung formuliert, getrennt von bestimmungsgemäßer Verwendung, nie wie ein Bedienschritt.
Reasonably foreseeable misuse · Intended use · Residual risk · Risk assessment · Information for use · Machinery Regulation (EU) 2023/1230 · ISO 12100 · Warning message
Zur CardContext Card
Betriebsarten in der Technischen Dokumentation
Warum verändern Betriebsarten, was die Dokumentation einer Maschine sagen muss?
Jede Betriebsart ändert, wer wo arbeitet, welche Schutzeinrichtungen wirken und welche Gefährdungen bleiben – jede braucht eigene Dokumentationsentscheidungen.
Operating mode · Operating-mode management · Residual risk · Reasonably foreseeable misuse · Safeguard · Enabling device · Lockout/tagout (LOTO) · Personal protective equipment (PPE) · Qualified person · Machinery Regulation (EU) 2023/1230 · ISO 12100
Zur CardContext Card
Wohin eine Warnung gehört: Sicherheitskapitel oder vor die Handlung
Gehört eine Warnung ins Sicherheitskapitel oder direkt vor den Schritt, den sie betrifft?
Allgemeine Sicherheitsinformationen gehören ins Sicherheitskapitel; eine Warnung zu einer bestimmten Handlung direkt vor diese Handlung.
Warning message · Safety chapter · Residual risk · Risk assessment · Information for use · DITA hazard statement · Three-step method · Safety information usability
Zur CardContext Card
Betriebsanleitung: ein Handbuch oder ein Satz von Informationsprodukten?
Ist mit „Gebrauchsanleitung“ ein einzelnes Handbuch gemeint oder eine Sammlung von Dokumenten?
Eine Gebrauchsanleitung kann ein Handbuch oder ein Satz von Informationsprodukten sein; er wird übergeben und bleibt auch in den technischen Unterlagen.
Instructions for use (IFU) · Information for use · Operating manual · Maintenance manual · Technical file · Labeling and instructions for use (MDR and IVDR)
Zur CardContext Card
Betriebsanweisung: ein Wort, viele Betreiberdokumente
Was ist eine Betriebsanweisung, und wie unterscheidet sie sich von der Betriebsanleitung des Herstellers?
Die Betriebsanweisung ist die verbindliche Anweisung des Arbeitgebers, nicht die Betriebsanleitung des Herstellers. Firmen nutzen das Wort vielfältig.
Ordinance on Industrial Safety and Health (BetrSichV) · Ordinance on Hazardous Substances (GefStoffV) · Operating manual · Instructions for use (IFU) · Personal protective equipment (PPE) · Lockout/tagout (LOTO)
Zur CardContext Card
Aufgabenanalyse in den Disziplinen der Dokumentation
Wer nutzt die Aufgabenanalyse, und in welche Dokumente fließt sie ein?
Sicherheit, Regulatory, Qualität, Entwicklung, Redaktion, Rollout und Betreiber nutzen die Aufgabenanalyse – für verschiedene Dokumente und Zielgruppen.
Risk assessment · ISO 12100 · IEC 62366-1 · Training needs analysis · Quality documentation · Product lifecycle management (PLM)
Zur CardContext Card
Aufgabenanalyse: eine Aufgabe, drei Blickwinkel
Ist die Aufgabenanalyse eine Methode – oder sind technische, kollaborative und kognitive Aufgabenanalyse verschiedene Dinge?
Hierarchische, Team- und kognitive Aufgabenanalyse betrachten dieselbe Aufgabe: Schritte und Pläne, Übergaben zwischen Rollen und das Denken dahinter.
Usability · DITA task · Task allocation · Human error · RACI matrix · Training needs analysis
Zur CardContext Card
Interne und externe Technische Dokumentation: was „extern“ wirklich heißt
Heißt „externe Dokumentation“, dass die Dokumentation veröffentlicht wird?
„Extern“ heißt: verlässt den Hersteller – nicht unbedingt öffentlich. Funktion, Zielgruppe, Verfasser und Zugang bestimmen, was ein Dokument ist.
Technical documentation · Technical file · Information for use · Instructions for use (IFU) · Operating manual · Machinery Regulation (EU) 2023/1230
Zur CardContext Card
Produktkategorien des CRA: Standard, wichtig und kritisch
Welche CRA-Produkte brauchen eine notifizierte Stelle, und wie viele Produkte fallen in die strengeren Kategorien?
Die meisten CRA-Produkte gehören zur Standardkategorie mit Selbstbewertung; Anhang III und IV listen die wichtigen und kritischen Ausnahmen.
Cyber Resilience Act (CRA) · Conformity assessment · Notified body (MDR and IVDR) · Harmonized standard · Presumption of conformity · Declaration of Conformity · CE marking
Zur CardContext Card
Die Funkanlagenrichtlinie: wenn Sektorrecht Aspektanforderungen aufnimmt
Warum schafft der Cybersicherheitsteil der Funkanlagenrichtlinie parallele Konformitätswege?
Die RED ist Sektorrecht mit Aspektanforderungen; ihr Cybersicherheitsteil doppelte den CRA bis zur Aufhebung zum 11. Dezember 2027.
Cyber Resilience Act (CRA) · Low Voltage Directive · Electromagnetic compatibility (EMC) · Harmonized standard · Presumption of conformity · CE marking
Zur CardContext Card
Maschinenverordnung und CRA: gekoppelt über Normen, nicht über Verweise
Warum können Maschinenverordnung und Cyber Resilience Act nicht einfach aufeinander verweisen?
Die MVO setzt Sicherheitsziele, der CRA Cybersicherheitsziele; die Anwendungsbereiche differieren, Konsistenz entsteht über Normen, nicht über Verweise.
Machinery Regulation (EU) 2023/1230 · Cyber Resilience Act (CRA) · Harmonized standard · Safety-security convergence · Safety-security interface · IEC 62443 · Presumption of conformity
Zur CardContext Card
EN 50742: Safety-Related Security Levels und IEC 62443 im Zusammenspiel
Zeigt die EN 50742, dass Gesetzgeber Technisches nicht verstehen, und widersprechen ihre SRSL der IEC 62443?
Die EN 50742 ist eine CENELEC-Norm, kein Gesetz: SRSL setzen den Schutzbedarf einer Sicherheitsfunktion, IEC 62443 liefert die Maßnahmen.
Machinery Regulation (EU) 2023/1230 · IEC 62443 · Security level (SL) · Safety-security convergence · Tamper resistance · Harmonized standard · Presumption of conformity · Risk assessment
Zur CardContext Card
Die SBOM nach BSI TR-03183-2: ein Inventar, kein Schwachstellenbericht
Was verlangt die BSI TR-03183-2 von einer Software-Stückliste, und wie hängt das mit dem CRA zusammen?
Die BSI TR-03183-2 legt Format, Felder und Tiefe der SBOM fest; die SBOM inventarisiert Komponenten und enthält nie Schwachstelleninformationen.
Software bill of materials (SBOM) · Cyber Resilience Act (CRA) · Supply chain security · License management · Security advisory · Common Vulnerabilities and Exposures (CVE) · Vulnerability management
Zur CardContext Card
Schwachstellenmeldungen annehmen nach BSI TR-03183-3: Meldung, Benachrichtigung, Sicherheitshinweis
Was erwartet die BSI TR-03183-3 von einem Hersteller, bevor die erste Schwachstellenmeldung eintrifft?
Die BSI TR-03183-3 richtet die Annahme von Schwachstellenmeldungen ein: security.txt, PSIRT und CSIRT, CVD-Richtlinie, Fristen und Offenlegung.
Coordinated vulnerability disclosure (CVD) · Vulnerability disclosure · Security advisory · Common Vulnerability Scoring System (CVSS) · Vulnerability management · Cyber Resilience Act (CRA)
Zur CardContext Card
Modul H nach dem CRA: BSI TR-03183-H baut die umfassende Qualitätssicherung auf ISO/IEC 27001 auf
Wie kann ein Hersteller die CRA-Konformität über seine Prozesse statt Produkt für Produkt nachweisen, und was ergänzt die BSI TR-03183-H?
Die BSI TR-03183-H zeigt, wie ein Modul-H-System nach CRA auf ISO/IEC 27001 aufbauen kann – auditiert von einer notifizierten Stelle, produktbezogen.
Conformity assessment · Notified body (MDR and IVDR) · Information security management system (ISMS) · Quality management · Security development lifecycle (SDL) · Harmonized standard · Presumption of conformity · Cyber Resilience Act (CRA)
Zur CardContext Card
BSI-Leitlinien zum CRA: kontextabhängig, nicht widersprüchlich
Wenn zwei Empfehlungen des BSI zum Cyber Resilience Act unvereinbar wirken – ist die Leitlinie widersprüchlich?
Die BSI TR-03183-1 knüpft jede Kontrolle an ein Risikoszenario; scheinbare Konflikte löst die Risikobewertung, unvereinbar sind sie nicht.
Cyber Resilience Act (CRA) · Security risk assessment · Harmonized standard · Presumption of conformity · Software bill of materials (SBOM) · State of the art
Zur CardContext Card
Das Explosionsschutzdokument nach einem Umbau
Wann muss das Explosionsschutzdokument aktualisiert werden?
Das Explosionsschutzdokument muss jeder maßgeblichen Veränderung der Anlage folgen; Erweiterung oder versetzte Kabine gehören dazu (§ 6 GefStoffV).
Explosion protection document · Hazardous area classification (Ex zones) · Ordinance on Hazardous Substances (GefStoffV) · Grandfathering (work equipment) · Management of change (MOC) · Explosion protection · Retrofit
Zur CardContext Card
BetrSichV oder GefStoffV: Welche Verordnung trägt die Pflicht?
Kommt die Pflicht, das Explosionsschutzdokument aktuell zu halten, aus der BetrSichV oder aus der GefStoffV?
Das Explosionsschutzdokument hängt an § 6 GefStoffV, nicht an der BetrSichV – gleiches Ergebnis, andere Anspruchsgrundlage, häufig verwechselt.
Ordinance on Industrial Safety and Health (BetrSichV) · Ordinance on Hazardous Substances (GefStoffV) · Explosion protection document · Presumption effect (technical rules) · Adaptation to the state of the art (work equipment) · Grandfathering (work equipment)
Zur CardContext Card
Bestandsschutz gilt für die Bauart, nie für die Akte
Schützt der Bestandsschutz eine bestehende Anlage und ihre Dokumentation?
Kein allgemeiner Bestandsschutz für Arbeitsmittel: Ältere Bauarten dürfen bleiben, wenn sicher – veraltete Beurteilungen und Dokumente nie.
Grandfathering (work equipment) · Ordinance on Industrial Safety and Health (BetrSichV) · Adaptation to the state of the art (work equipment) · Presumption effect (technical rules) · As-built documentation · Explosion protection document · State of the art
Zur CardContext Card
Retrofit und wesentliche Veränderung nach der Maschinenverordnung
Wann macht ein Retrofit den Betreiber zum Hersteller einer Maschine?
Ein Retrofit macht nur bei wesentlicher Veränderung zum Hersteller; jedes Retrofit braucht die Gefährdungsbeurteilung, die darüber entscheidet.
Retrofit · Retrofit under the Machinery Regulation · Substantial modification · Machinery Regulation (EU) 2023/1230 · Machinery Directive 2006/42/EC · Assembly of machinery · Stop controls of an assembly of machinery (1.2.4.4) · Ordinance on Industrial Safety and Health (BetrSichV) · Technical file · Safety PLC · Remote software update · Configuration management
Zur CardContext Card
Topicbasierte vs. aufgabenorientierte Dokumentation
Ist topicbasierte Dokumentation dasselbe wie aufgabenorientierte Dokumentation?
Topicbasierte Dokumentation legt die Inhaltseinheit fest, aufgabenorientierte, welche Inhalte nötig sind. Beides ist verschieden und wird oft kombiniert.
DITA topic · DITA task · DITA concept · DITA reference · DITA map · DITA information typing
Zur CardContext Card
Minimalismus und strukturiertes Schreiben
Wie wirken Minimalismus und strukturiertes Schreiben zusammen?
Minimalismus bestimmt, was Inhalte für Nutzer leisten, strukturiertes Schreiben ihre Form. Inhaltsmodelle machen minimalistische Grundsätze zu Regeln.
Schema (data) · Schema validation · DITA (Darwin Information Typing Architecture) · DITA task · DITA specialization · Information for use
Zur CardContext Card
Every Page is Page One vs. semantische Dokumentation
Ist Every Page is Page One eine Form semantischer Dokumentation?
EPPO ist ein Schreibmodell für eigenständige Seiten, semantische Dokumentation macht Bedeutung maschinenlesbar. Zwei Modelle, die sich stärken.
DITA topic · Metadata · Taxonomy · Ontology · Information model · iiRDS Topic · Knowledge graph
Zur CardContext Card
Sechs Modelle der Technischen Dokumentation im Vergleich
Worin unterscheiden sich topicbasierte, aufgabenorientierte, EPPO-, semantische, minimalistische und strukturierte Dokumentation?
Sechs Dokumentationsmodelle beantworten sechs Fragen – Einheit, Auswahl, Eigenständigkeit, Bedeutung, Handeln, Form – und werden meist kombiniert.
Technical documentation · DITA (Darwin Information Typing Architecture) · DITA topic · DITA task · Metadata · Information model · Schema (data)
Zur CardContext Card
Vier SDK-Typen im Vergleich
Was unterscheidet Developer-, Publishing-, Plattform- und Hardware-SDKs?
Developer-, Publishing-, Plattform- und Hardware-SDKs teilen eine Idee – ein Baukasten –, unterscheiden sich aber in Ziel, Artefakten, Nutzern und Steuerung.
Software development kit (SDK) · Application programming interface (API) · DITA (Darwin Information Typing Architecture) · Device driver · Firmware · Software library · Compiler
Zur CardContext Card
Wie die vier SDK-Typen zusammenwirken
Wo treffen Developer-, Publishing-, Plattform- und Hardware-SDKs in der Praxis aufeinander?
Hardware-, Developer-, Plattform- und Publishing-SDKs treffen sich an Gateways, APIs, Erweiterungen und Doku-Pipelines – verbunden durch Verträge und Formate.
Interoperability · Interface contract · Serialization format · JSON · Distributed tracing · Observability · IoT gateway · Digital twin · Software bill of materials (SBOM)
Zur CardContext Card
Erweiterungspunkte einer Plattform
Wie erlaubt ein Plattform-SDK fremdem Code, eine Host-Anwendung zu erweitern?
Ein Plattform-SDK öffnet eine Host-Anwendung an benannten Erweiterungspunkten; ein Manifest nennt Beiträge und Rechte, der Host behält die Kontrolle.
Software framework · Application programming interface (API) · Authorization · Interface contract · Backward compatibility · Deprecation path · Low-code/no-code platform
Zur CardContext Card
Stufen einer Publishing-Pipeline
Was geschieht mit strukturiertem Content in einem Publishing-SDK?
Ein Publishing-SDK löst auf, validiert, filtert, transformiert und verpackt strukturierten Content – aus einer Quelle entstehen HTML, PDF und mehr.
DITA (Darwin Information Typing Architecture) · DITA map · DITA topic · DITA conditional processing · DITA content reference (conref) · DITA key · Schema validation · Metadata
Zur CardContext Card
SDK vs. API
Was ist der Unterschied zwischen einem SDK und einer API?
Eine API ist der Vertrag zwischen zwei Programmen; ein SDK ist der Baukasten aus Bibliotheken, Werkzeugen und Beispielen, der diesen Vertrag nutzbar macht.
Software development kit (SDK) · Application programming interface (API) · REST API · Software library · Authentication · Interface contract · Semantic versioning
Zur CardContext Card
Schichten eines Hardware-SDK
Welche Schichten liefert ein Hardware-SDK zwischen Anwendungscode und Gerät?
Ein Hardware-SDK stapelt Toolchain, Treiber, Abstraktionsschicht, Laufzeit und Bibliotheken zwischen Anwendungscode und Gerät, dazu Debug-Werkzeuge.
Device driver · Firmware · Microcontroller (MCU) · Real-time operating system (RTOS) · Compiler · Debugging · Abstraction · Application binary interface (ABI) · Embedded software
Zur CardContext Card
Kontrollpunkte für KI-Agenten
Wer kontrolliert, was ein KI-Agent tun darf?
Ein KI-Agent handelt über Identitäten, Rechte, Gateways und Protokolle. Die Kontrollpunkte, die ihn begrenzen, und was die Dokumentation dazu festhält.
AI agent · Model Context Protocol (MCP) · Role-based access control (RBAC) · Principle of least privilege · Audit trail · Human in the loop · Logging
Zur CardContext Card
KI vs. klassische Automatisierung
Worin unterscheidet sich KI von klassischer Automatisierung?
Klassische Automatisierung führt festgelegte Regeln aus, KI leitet Verhalten aus Daten ab. Warum man beides kombiniert und wie KI begrenzt wird.
Artificial intelligence (AI) · Automation · Machine learning (ML) · Programmable logic controller (PLC) · Robotic process automation (RPA) · Human in the loop
Zur CardContext Card
MQTT vs. OPC UA: Transport und Bedeutung
Was ist der Unterschied zwischen MQTT und OPC UA?
MQTT verteilt Nachrichten über einen Broker, OPC UA ergänzt Informationsmodell, Dienste und Sicherheit. Unterschiede und warum man beide kombiniert.
MQTT · OPC Unified Architecture (OPC UA) · Publish-subscribe pattern · Message broker · Information model · OPC UA PubSub
Zur Card