Eine Information auf Reisen – wie entsteht eigentlich Produktdokumentation?

Eine Information auf Reisen – wie entsteht eigentlich Produktdokumentation?

Ohne eine verständliche Bedienungsanleitung lassen sich IT-Produkte nicht optimal nutzen. Doch welchen Weg nehmen eigentlich Informationen zu einer neuen Produktfunktion, um aus dem Kopf des Entwicklers zum Anwender zu gelangen? Hier erfahren Sie es!

Bevor ich hier den Weg einer Information aus der Produktentwicklung in ein Handbuch beschreiben kann, muss ich kurz erklären, wer diese Information aufnimmt, aufbereitet und anschließend weiterverbreitet. Hier kommt jemand ins Spiel, der normalerweise eher im Hintergrund agiert: Der Technische Redakteur.

Der Technischer Redakteur als Reisebegleiter der Information

Es gibt grundsätzlich mehrere Wege, den Beruf des Technischen Redakteurs zu erlernen. So gibt es in diesem Berufsfeld ziemlich viele Quereinsteiger. Wenn man aber so wie ich noch relativ am Anfang seines Berufslebens steht, kann man beispielsweise den Studiengang Technische Kommunikation oder Technische Redaktion belegen. Der Studiengang vermittelt unter anderem Kenntnisse über mündliche und schriftliche Sprachbeherrschung in Deutsch und Englisch mit Fokus auf Technische Dokumentation, Informationsbeschaffung, Usability und technisches Grundwissen in verschiedenen Bereichen. Er befähigt den Studierenden, technische Dokumentation (Handbücher, Readmes, Broschüren, Datenblätter) inhaltlich korrekt, verständlich und zielgruppengerecht zu schreiben. Im Idealfall auch noch mehrsprachig.

Da genua komplexe technische Produkte herstellt, wird natürlich auch bei uns verständliche, aktuelle und auf die Bedürfnisse unsere Benutzer angepasste Dokumentation benötigt. Als Technischer Redakteur bin ich bei genua für die Erstellung, Pflege und Bereitstellung von Produkthandbüchern, Releasenotes und Patch Readmes für zwei Produkte verantwortlich.

Wie es nun eine Information zu einer neu entwickelten Funktion in ein Handbuch schafft, möchte ich in den folgenden Absätzen etwas genauer erklären.

Schritt 1: Aus dem Entwickler-Kopf in meinen Kopf

Zunächst befindet sich die Information zu einer neuen Funktion noch im Kopf eines Entwicklers. Damit die Information irgendwann einmal in einem Handbuch landet, muss sie zunächst aus dem Kopf des Entwicklers befreit werden. Genau zu diesem Zweck nehme ich regelmäßig an Meetings mit der Produktentwicklung, der Qualitätssicherung und dem Product Owner teil, bei denen neue Funktionen per Live-Demonstration vorgestellt werden. In diesen Meetings werden meist sehr viele Informationen sehr schnell ausgetauscht, sodass ich höllisch aufpassen muss, dass die für mich (und damit auch für meinen Handbuchleser) wichtige Information auch bei mir ankommt und meist in Form von einer Notiz in ihrer rohen, meist sehr "mickrigen Gestalt" festgehalten wird.

IT-Sicherheitslösungen benötigen eine verständliche Anleitung, um korrekt konfiguriert zu werden

Nach dem entsprechenden Meeting muss ich versuchen, mir aus diesen Notizen einen Reim zu machen und ich muss entscheiden, ob die aufgefangene Information für mich aussagekräftig genug ist. Ansonsten suche ich das Vier-Augen-Gespräch mit einem Entwickler, um bestimmte Details zu erfragen oder noch einmal den vom Benutzer auszuführenden Workflow durchzusprechen.

Falls nötig, investiere ich anschließend noch ein wenig Zeit in Hintergrundrecherchen zu bestimmten komplexeren technischen Sachverhalten. Diese können mir entweder dabei helfen, meine noch sehr rohe und knappe Information besser zu verstehen oder weitere Zusatzinformationen für meine Handbuchleser liefern.

Schritt 2: Aus meinem Kopf in den Computer

Wenn ich der Meinung bin, die Information lange genug in meinem Kopf herumgewälzt, erweitert, mit anderen Informationen verknüpft oder um neue Informationen angereichert zu haben, gehe ich daran, sie das erste Mal in Form von geschriebenen Worten zu materialisieren. In einem ersten Schritt tue ich dies gern tatsächlich mit Stift und Papier, da ich hier einfach Ergänzungen oder Streichungen besser nachverfolgen kann.

Hat die Idee eine erkennbar logische Gestalt angenommen, übertrage ich meine handschriftliche Ausarbeitung in meine Arbeitsumgebung auf dem Rechner. Dort nimmt die Information ihre endgültige Form als möglichst vollständiger und verständlicher Text an.

Um Layout und Textgestaltung kümmert sich dabei eine hinterlegte Layout-Definition, sodass ich den Textinhalt getrennt vom Textlayout eingeben kann. Das erleichtert es mir, Layout-Änderungen am gesamten Handbuch vorzunehmen.

Schritt 3: Aus dem Computer zurück in den Kopf des Entwicklers

Wenn die Information in einem für den Leser angenehm und leicht zu verarbeitendem Text vorliegt, gebe ich den entsprechenden Handbuchabschnitt zurück in die Entwicklung. Hier kann nun festgestellt werden, ob die ursprüngliche Information noch inhaltlich bzw. fachlich korrekt enthalten ist. Wenn aus der Entwicklung keine Einwände kommen, übersetze ich sie ins Englische, damit unsere nicht deutschsprachigen Kunden auch etwas mit der Information anfangen können. Diese englischsprachige Information wird dann abschließend von einem Muttersprachler-Kollegen geprüft.

Schritt 4: Endlich vereint

Nachdem die Information durch die verschiedenen Stufen der Verarbeitung und Prüfung gewandert ist, kann sie nun in das Handbuch integriert werden.

Hier endet die Reise der Informationen erst einmal. Das bedeutet aber nicht, dass sie (einmal im Informationsgeflecht des Handbuchs abgelegt) nie wieder angefasst und verändert wird. Die Produkte von genua sind einer stetigen Weiterentwicklung unterzogen und mit jeder für den Endbenutzer relevanten Änderung muss auch die entsprechende Information im Handbuch neu überdacht, überarbeitet oder manchmal auch (da veraltet) aus dem Dokument entfernt werden.

Alle in diesen Handbuch enthaltenen Informationen sollen zu jedem Produkt-Release ein aktuelles, fachlich korrektes und möglichst leicht verständliches Informationsprodukt bilden. Nur so wird der Anwender bei der Bedienung bestmöglich unterstützt.

Weiterführende Links

 

Bildquelle: © macrovector - Fotolia.com


Lesen Sie auch

Diskutieren Sie mit

Sie können diesen Artikel sofort ohne Registrierung als Gast-User kommentieren.

Registrieren Sie sich jetzt! Mit einem User Account genießen Sie Vorteile:
Ihr Kommentar wird sofort im genublog veröffentlicht und Sie werden über Reaktionen auf Ihre Kommentare informiert.

Bereits registrierte User gelangen hier zum Login.



Registrieren Sie sich jetzt! Mit einem User Account genießen Sie Vorteile:
Ihr Kommentar wird sofort im genublog veröffentlicht und Sie werden über Reaktionen auf Ihre Kommentare informiert.

Bereits registrierte User gelangen hier zum Login.