NOLEJADOCUMENTATION SOLUTIONS
Projekte und Arbeitsproben

Technisches Wissen.
Klare Dokumentation.

Reale Projekte und eigens erstellte Arbeitsproben zu Industriemaschinen, Software und Gebäudetechnik.

Ausgewählte Projekte

Technische Dokumentation aus der Praxis

Diese Projektberichte beschreiben meine Arbeit, ohne die Auftraggeber zu nennen oder ihre Unterlagen zu veröffentlichen.

Industriemaschinen · Betriebs- und Wartungsanleitungen

Fachwissen der Ingenieure in verständliche Anleitungen übertragen

Ein Hersteller von Industriemaschinen verließ sich lange darauf, dass seine Ingenieure die Anlagen bei der Installation erklärten. Die Mitarbeiter vor Ort hielten diese Erklärungen in eigenen Notizen fest. Als das Unternehmen Aufträge in Europa und weiteren Märkten gewann, benötigte es formelle Betriebs- und Wartungsanleitungen.

Ich wertete Anforderungsunterlagen und technische Zeichnungen aus. Außerdem besuchte ich Fabriken, beobachtete die Maschinen im Betrieb und befragte die Ingenieure, die sie am besten kannten.

Dabei musste ich ihr Vertrauen gewinnen. Die Ingenieure hatten jahrelange Erfahrung mit den Maschinen, während ich mich noch einarbeitete. Ich erklärte ihnen, dass die Anleitungen ihr Wissen an die Anwender weitergeben sollten. Meine Aufgabe war es, dieses Wissen zu ordnen und verständlich zu vermitteln.

Ich verband die schriftlichen Quellen, meine Beobachtungen und das praktische Wissen der Ingenieure zu Betriebs- und Wartungsanleitungen. Ich schrieb für Menschen ohne formale technische Ausbildung und erklärte Fachbegriffe, ohne ihren Sinn zu verändern.

Software · Zentrale Dokumentation

Eine gemeinsame Wissensgrundlage für Softwareteams schaffen

Die Niederlassungen eines internationalen Unternehmens hatten keine offizielle Dokumentation für dessen Softwareprodukt. Wenn ein Kunde ein Problem meldete, nahm ein dafür zuständiger Ingenieur in der Zentrale den Anruf entgegen und leitete die Anfrage an den passenden Fachingenieur weiter. Lösungen und Verbesserungen aus einem Land erreichten die anderen Niederlassungen nicht regelmäßig.

Meine Aufgabe war es, eine Dokumentation zu erstellen, die Teams weltweit nutzen konnten. Ich brachte die Länderteams zusammen, damit sie ihr Wissen austauschten. Außerdem besprach ich das Produkt mit Softwarearchitekten und brachte mein Fachwissen in Besprechungen zur Softwareterminologie ein.

Ich erstellte die zentrale Dokumentation von Grund auf und baute eine eigene Terminologiedatenbank auf. Mit der gemeinsamen Dokumentation benötigte das Unternehmen keinen Ingenieur mehr, der den ganzen Tag Anrufe entgegennahm und weiterleitete.

Eigens erstellte Beispiele

Arbeitsproben

Diese Arbeitsproben beschreiben fiktive Produkte mit erfundenem Betriebsverhalten. Sie zeigen Methoden der technischen Redaktion und sind keine Anleitungen für reale Geräte. Es werden keine Kundendokumente oder Projektdaten wiedergegeben.

HLK · Kurzanleitung

Raumregler

Eine dreiseitige Anleitung zum Einstellen eines vorübergehenden Temperatursollwerts, zur Rückkehr zum Zeitprogramm und zur Behebung häufiger Bedienprobleme.

Das Beispiel zeigt: aufgabenorientierte Abläufe, eindeutige Prüfschritte und die klare Unterscheidung zwischen gemessener Temperatur und gewünschtem Sollwert.

Raumregler-Beispiel lesen (PDF)

PDF herunterladen · 3 Seiten · Deutsch

Software · Schritt-für-Schritt-Anleitung

Belegungszeiten planen

Eine dreiseitige Anleitung zum Erstellen eines wöchentlichen Belegungszeitplans, zum Ergänzen eines Schließtags und zum Veröffentlichen und Überprüfen der Änderungen.

Das Beispiel zeigt: Softwareabläufe, Entwurfs- und Veröffentlichungszustände, Ausnahmeregeln und die Fehlerbehebung anhand beobachtbarer Ergebnisse.

Software-Beispiel lesen (PDF)

PDF herunterladen · 3 Seiten · Deutsch