LinkedIn-Newsletter
Cut Complexity — Create Clarity
Technical Writing is Complexity made clear
Mein Newsletter auf LinkedIn darüber, wie die Technische Redaktion Komplexität strukturiert: Denkmodelle, Informationsdesign, Maschinendokumentation, Sicherheitskommunikation und strukturierte Inhalte.
Die Ausgaben erscheinen in englischer Sprache. Neue Ausgaben erscheinen samstags um 21 Uhr mitteleuropäischer Zeit.
Archiv
Alle Ausgaben
Jede Karte zeigt den Originaltitel, eine kurze Einordnung für diese Seite und die Fachgebiete, zu denen die Ausgabe gehört. Die Links führen zu den Ausgaben auf LinkedIn.
Nach Fachgebiet filtern
Keine Ausgabe passt zu diesem Fachgebiet.
-
Before you draw: how to choose the right model for technical information
Bevor eine Infografik entsteht, müssen die Beziehungen verstanden sein, die sie zeigen soll. An einem fiktiven Sensorbeispiel zeigt die Ausgabe, wie Pfeile zwei unabhängige Zustände zu einer falschen Ursachenkette machen und wie die Technische Redaktion Elemente, Bedingungen und Beziehungen vorher klärt.
-
Rated for what? Understanding machine limits in Technical Documentation
Eine Maschinenspezifikation beschreibt eine Fähigkeit unter festgelegten Bedingungen. An einem fiktiven CNC-Beispiel und mit dem Wissensdreieck von Tom Johnson zeigt die Ausgabe, wie aus veröffentlichten Grenzwerten wie dem Verfahrweg einer Achse eine Anleitung wird, die bei der konkreten Entscheidung hilft.
-
Why Technical Writers need to understand IT, OT, and IoT
IT, OT und IoT beantworten unterschiedliche Fragen und überschneiden sich in der Praxis. Die Ausgabe bietet der Technischen Redaktion ein Arbeitsmodell der drei Begriffe auf Grundlage der NIST-Definitionen und zeigt, wie es hilft, Systemgrenzen, Handlungen und deren Folgen klar darzustellen.
-
The AI has feelings — please submit a ticket
Eine satirische Besprechung, in der vier getrennte Fragen zum Bewusstsein von KI zu einer einzigen Grundsatzerklärung werden. Die Szene hat Notion AI auf Grundlage der Context Card „Claims about AI consciousness: four questions that get merged“ von AI TechDoc Knowledge geschrieben; die Satire zielt auf administrative Gewissheit, nicht auf die Forschung.
-
How documentation takes shape in the writer's head and works in the reader's mind
Eine korrekte Anleitung kann im Moment der Nutzung trotzdem scheitern. Die Ausgabe verbindet zwei Blueprints von AI TechDoc Knowledge, „Thinking models for technical writers“ und „Cognitive psychology for technical communication“, und betrachtet den Writer’s Stack, der das Dokumentationsproblem strukturiert, und den Reader’s Stack, die kognitive Arbeit der Person, die das Dokument nutzt.
-
Every page is page one for online machine documentation
Eine Online-Betriebsanleitung muss nicht von der ersten Seite an gelesen werden. Ausgehend von Mark Bakers Konzept „Every Page is Page One“ beschreibt die Ausgabe einen vollständigen Informationsraum mit mehreren gültigen Wegen, etwa über einen QR-Code an der Maschine, einen Fehlercode oder ein bestimmtes Teilsystem.
-
Prioritizing user needs makes user manuals better
Betriebsanleitungen werden klarer, wenn sie den Tätigkeiten der Nutzer folgen statt dem Aufbau des Produkts. Die Ausgabe beschreibt Aufgabenorientierung als Grundprinzip und zeigt, wie Produktlogik Komplexität erzeugt und Risiken von den Handlungsschritten trennt, in denen sie wichtig sind.
-
Beyond DITA: How AI is redrawing the structured content market
Die Diskussion über DITA klingt oft nach einer Entscheidung zwischen Ja und Nein. Die Ausgabe unterscheidet drei Ansätze für strukturierte Inhalte – die XML- und CCMS-Welt, semantisches Content Engineering und Docs-as-Code – und zeigt, welche Unterschiede KI zwischen ihnen sichtbar macht.
-
Research skills for Technical Writers
In entwicklungsgetriebenen Unternehmen fehlt selten Information, aber oft strukturierte und nachvollziehbare Information. Die Ausgabe beschreibt Recherchekompetenzen für interne Entwicklungsquellen und Lieferantendokumentation, einschließlich KI-Werkzeugen, organisatorischer Systematik und Recherche-Logs.
-
Where documentation responsibility ends
Bei verketteten Maschinenanlagen ist die Betriebsanleitung eine Abgrenzungsaufgabe. Die Ausgabe zeigt, wo die Dokumentation der Hersteller der Einzelmaschinen maßgeblich bleibt, was der Hersteller der Gesamtanlage ergänzt, welche Pflichten beim Betreiber liegen und dass eine CE-Kennzeichnung der Gesamtanlage die Dokumentationsgrenzen der einzelnen Maschinen nicht aufhebt.
-
Operating modes in machinery user manuals
Sicherheitsinformationen in Betriebsanleitungen für Maschinen müssen dem tatsächlichen Betriebskontext folgen. Die Ausgabe verbindet das Bedienkonzept je Lebensphase mit dem Sicherheitskonzept je Betriebsart: Personenprofil, Arbeitsplatz, wirksame Schutzeinrichtungen, Verantwortungsgrenze und Restrisiko.
-
The Technology Lens Model
Das Technology-Lens-Modell unterscheidet deterministische Technik, entscheidungsgesteuerte Steuerungslogik und die Betriebsart, in der beide wirken. Die Ausgabe zeigt, wie diese Unterscheidung der Technischen Redaktion hilft festzulegen, was erklärt wird, wovor gewarnt wird und wohin sicherheitsrelevante Information in der Anleitung gehört.
-
Hazard thinking in Operating Instructions
Ein Warnhinweis ist das sichtbare Ergebnis einer tieferen Analyse. Die Ausgabe stellt einen strukturierten Ansatz für Gefährdungen in Betriebsanleitungen vor: bestimmungsgemäße Verwendung, Restrisiken, vernünftigerweise vorhersehbare Fehlanwendung, verbotene Handlungen und Gefährdungen aus der Umgebung der Maschine.
-
Mental models for better context
Technisches Schreiben beginnt mit dem Verstehen, nicht mit dem Text. Die Ausgabe beschreibt, wie mentale Modelle helfen, verstreute Informationen aus Entwicklung, Risikobeurteilungen, Normen und Altdokumentation zu strukturieren, bevor geschrieben wird.
-
Thinking Models for Technical Writers
Viele Dokumentationsprobleme entstehen durch unklares Denken, nicht durch Werkzeuge. Die erste Ausgabe stellt fünf Denkmodelle vor, darunter Komponenten-, Varianten- und Metadatendenken, die in jeder Werkzeuglandschaft tragen, vom CCMS bis zum Netzwerkordner.
LinkedIn zeigt auf Artikelseiten eigene Empfehlungen an, auch Beiträge anderer Personen. Sie gehören nicht zu diesem Newsletter.
Mein anderer Newsletter auf LinkedIn: Write it Safe. Prove it Safe.