Zusammenfassung des Meetings
Das Meeting drehte sich um die Überprüfung und Optimierung von technischen Dokumentationen, insbesondere hinsichtlich Verständlichkeit und Struktur. Die Teilnehmer diskutierten in einem interaktiven Workshop-Format folgende Kernthemen:
Einführung und Zielsetzung:
Dietrich Juhl leitete das Meeting ein, erläuterte, dass es um einen „Info Check“ geht – also darum, ob beschreibende Texte (etwa System- oder Funktionsbeschreibungen) ihr Ziel erreichen, also dem Nutzer ein mentales Modell und ein Verständnis des Systems zu vermitteln.
Unterscheidung zwischen beschreibenden und anleitenden Texten:
Es wurde betont, dass beschreibende Texte dazu dienen, Zusammenhänge und Funktionsweisen zu erklären, während anleitende Texte konkrete Handlungsanweisungen (mit Elementen wie Überschrift, Ziel, Voraussetzungen, Schritt-für-Schritt-Anleitung, Handlungsergebnis und Ausblick) geben.
Strukturierung und Gestaltung:
Diskutiert wurden klare Gliederungen, etwa durch Bulletlists und nummerierte Schritte, um die Lesbarkeit und Nachvollziehbarkeit zu verbessern.
Die Reihenfolge und Logik der einzelnen Abschnitte wurden thematisiert, ebenso wie die Bedeutung einer aussagekräftigen, aber nicht überladenen Überschrift.
Konkrete Beispiele und Praxisbezug:
Anhand von Beispielen wie der Beschreibung eines Nothalttasters im Maschinenbau oder der Online-Ausweisfunktion in der Bank wurden konkrete Herausforderungen und Lösungsansätze besprochen.
Es wurde erörtert, wie wichtig es ist, Handlungsaufforderungen konkret und verständlich zu formulieren (z. B. im Imperativ) und Feedback bzw. Handlungsergebnisse klar zu kennzeichnen.
Bilder und ergänzende Elemente:
Die Rolle von Abbildungen und Bildunterschriften wurde diskutiert. Es ging darum, dass Bilder den Text unterstützen, die im Text erwähnten Begriffe wiederfinden und dem Nutzer einen klaren Einstieg bieten.
Referenzinformationen und zusätzliche Dokumentationsbestandteile:
Abschließend wurde auf den Aufbau von Referenzinformationen wie Abbildungsverzeichnissen, Ersatzteillisten, Glossaren und bibliografischen Verweisen eingegangen, die dem Nutzer bei Bedarf vertiefte Informationen liefern.
Das Meeting endete mit der Feststellung, dass die Analyse und kritische Überprüfung der eigenen Dokumentationen sinnvoll ist – auch wenn die derzeitigen Unterlagen insgesamt gut seien, gibt es immer Verbesserungspotenzial, besonders im Umgang mit älteren Dokumenten. Die Teilnehmer einigten sich darauf, das Thema in der nächsten Woche weiterzuführen und ihre Erfahrungen sowie Verbesserungsvorschläge auszutauschen.