Stefan Kreckwitz, CEO bei unserem Partner Congree, beschreibt in seinem Gast-Blogbeitrag die Hilfsmittel, mit denen die Erstellung eines Informationsraums am besten gelingt.

Lösungen wie COSIMA und TopicPilot von DOCUFY revolutionieren die Technische Dokumentation. Sie legen die Grundlage für einen Informationsraum, der den gesamten Produktzyklus überspannt. In diesem können Informationen von der Entwicklung über Marketing und Vertrieb, Installation, Betrieb, Wartung und schließlich Entsorgung verankert werden.

Grundlage dieses virtuellen Raums sind Informationsbausteine, auch Topics genannt. Mit ihnen lassen sich die gewünschten Informationen bei Bedarf flexibel und für den konkreten Anwendungsfall zusammenstellen und veröffentlichen. Dafür müssen die Topics in sich geschlossen und mit Metadaten versehen sein.

Stabile Informationsräume bauen

Doch wie lässt sich mit den Bausteinen in Form von Topics ein ganzer Raum bauen? Reichen die Anforderungen „Abgeschlossenheit“ und „Metadaten“ aus, um ein festes, sinnvolles Gebilde zu kreieren? Um diese Frage zu beantworten, können wir sie auf das Maurerhandwerk übertragen.

Für einen aus Steinen gemauerten Raum benötigt man – neben den Steinen selbst – mindestens:

  • Das Wissen, wie diese zu verbauen sind (= Expertenwissen)
  • Einen Bauplan 
  • Mörtel
  • Hilfsmittel

Diese Elemente lassen sich wunderbar auf die Informationswelt übertragen.

Expertenwissen

Um einen stabilen Raum mauern zu können, müssen Maurer eine fachspezifische Ausbildung durchlaufen. Hier erwerben sie das benötigte Expertenwissen: Welche Steine sich für welches Bauvorhaben eignen, wie sie miteinander kombiniert und verbunden werden. Auch Autoren Technischer Dokumentation benötigen dieses Expertenwissen. Sie müssen wissen, welche Arten von Informationseinheiten in ihrem Unternehmen existieren. Die Konzepte von Kohäsion, Kohärenz und Konsistenz müssen ihnen vertraut sein, wie dem Maurer der Mörtel … denn diese drei Elemente sind relevant, um Topics passend aneinanderzufügen (dazu später mehr).

Der Redaktionsplan und -leitfaden: Ein Bauplan für die Textarbeit

Ohne Bauplan kann auch aus den hochwertigsten Bausteinen kein solider Raum entstehen. Diese Regel aus der Bauwelt gilt auch für die Textarbeit. Der Bauplan kann als Äquivalent zu Redaktionsplan und Redaktionsleitfaden gelesen werden. Während der Redaktionsplan definiert, welche Textprodukte geschaffen werden, gibt der Redaktionsleitfaden Hinweise zur praktischen Umsetzung der Textprodukte. Er definiert die Baustellen-Regeln des entstehenden Informationsraums. 

Maschinenlesbare Zusatzinformationen – Die Metadaten

Wenn eine Palette Steine geliefert wird, ist diese häufig mit Produktdaten bedruckt, anhand derer ein Maurer genau sagen können, wo sie zu verbauen sind. Auch hierzu gibt es ein Äquivalent in der Informationswelt: die Metadaten. Mit ihnen lassen sich Topics maschinenlesbar mit Zusatzinformationen anreichern. Diese Zusatzinformationen können nach dem Schreiben der Topics unter anderem verwendet werden, die Topics mehr oder weniger automatisiert zu einem großen Ganzen zu verbinden.

Kohäsion, Kohärenz, Konsistenz – der sprachliche Mörtel nicht nur in der TechDok

Natürlich kann man Steine einfach stapeln, ebenso, wie man Topics einfach aneinanderreihen kann. Jedoch entstehen auf diese Weise weder stabiles Mauerwerk noch solide Informationsräume. Maurer verwenden Mörtel, um aus Steinen eine Mauer zu bauen. Autoren nutzen als Mörtel für ihren Informationsraum die folgenden drei Mittel:

  • Kohäsion: Mit Kohäsion wird ein syntaktischer Zusammenhang zwischen zwei Sätzen erkennbar gemacht – mit anderen Worten: Sie werden mit bestimmten Wörtern zusammengeklebt, damit der Leser sie automatisch in Verbindung setzt. Typische Mittel zur Kohäsion sind Konjunktionen wie „und“, „aber“ und „denn“. Auch Pronomen wie „er“, „sie“ oder „es“ werden oft verwendet. Bei Topics ist es wichtig, dass die Kohäsionsmittel nicht auf etwas verweisen, das außerhalb des jeweiligen Topics liegt.
  • Kohärenz: Kohärenz bezeichnet den inhaltlichen Zusammenhang zwischen zwei Textbausteinen oder Topics.
  • Konsistenz: Man spricht von einem konsistenten Text, wenn dieser sprachlich, stilistisch und inhaltlich denselben Regeln und Normen folgt. Mit anderen Worten ist dies der rote Faden, der den Leser durch die Anleitung führt. In topic-orientierten Texten muss darauf geachtet werden, dass der rote Faden nicht verloren geht.

Zu wenig Kohäsion, Kohärenz und Konsistenz führen dazu, dass die Topics nicht richtig miteinander verknüpfbar bzw. verbunden sind. Und auch, wenn der „sprachliche Mörtel“ zwar „angerührt“, dabei aber eine oder zwei Komponenten vergessen werden, können keine stabilen Informationsräume entstehen.

Hilfsmittel: Kelle, Leiter, Terminologie-Tool

Ein Experte, ein Bauplan, Steine, Mörtel, all das ist wichtig, um Räume und schließlich Häuser zu errichten. Allerdings sollten die Hilfsmittel nicht unterschätzt werden, die die Arbeit mit den Materialien erst möglich machen: Kelle, Wasserwaage, Leiter, um nur drei zu nennen. Genauso verhält es sich mit dem Schreiben. Software für die Sprachprüfung, Satzwiederverwendungsmechanismen, Terminologie-Tools oder ähnliches helfen den Autoren im Informationsraum, möglichst hochwertig und effizient ihre Content-Mauern „hochzuziehen“.

Nicht zuletzt unterstützen Hilfsmittel, wenn es gilt, Herausforderungen zu meistern. Jeder Mensch hat andere Kenntnisse, andere Arbeitsweisen und einen anderen Stil. Mit der Zeit verändern sich Teams, Mitarbeiter kommen und gehen. Aber Arbeitstechniken, internes Know-how und Team-Werte müssen beständig weitergegeben werden, um Kontinuität zu wahren. Auch Methoden unterliegen dem Wandel der Zeit, Menschen müssen sich an neues Wissen anpassen und ggf. alte Vorgehensweisen verwerfen, einfach, weil es neue Erkenntnisse zum Thema gibt. Solche Herausforderungen kommen auf dem Bau ebenso vor wie in der Dokumentationserstellung – die Hilfsmittel sorgen dafür, dass Normen und Regeln eingehalten werden und die Qualität damit sichergestellt werden kann.

Von Containern und Wohnzimmern

Wenn wir uns ausschließlich auf die funktionalen Anforderungen konzentrieren, entsteht ein zweckmäßiger Raum; ein Container. Stabil und mit glatten, schmucklosen Wänden. Aber ist das die Atmosphäre, die wir für den Benutzer erzeugen möchten? Wie lässt sich der Informationsraum als Wohnzimmer einrichten?

Wer den Informationsraum abteilungsübergreifend versteht, wird auch die Anforderungen des Marketings berücksichtigen müssen. Content ist ein wichtiger Markenbotschafter – das heißt, dass Sprache die Werte eines Unternehmens repräsentieren und die Marke somit stärken kann. Wenn die Produkte eines Unternehmens beispielsweise für Präzision stehen, dann lässt sich dies in der Sprache auf vielen Ebenen abbilden. Der so genannte „Tone of Voice“ sorgt mithilfe von Sprache in den Köpfen der potenziellen Kunden für das passende „Bild“ eines Unternehmens. Ebenso, wie Farben, Stoffe, Dekoration aus einem Raum ein persönliches, gemütliches Wohnzimmer machen, drückt Tone of Voice die Werte, den „Vibe“ eines Unternehmens über Sprache aus. Ein interessantes Beispiel, wie ein firmenübergreifender „Tone of Voice“ Einzug in die Technische Kommunikation gehalten hat, ist der Style Guide von Microsoft.  Zusammenfassend beschreibt Microsoft seinen Tone of Voice: „[…] Microsoft’s modern approach to voice and style: warm and relaxed, crisp and clear, and ready to lend a hand.“[1] Das klingt schon eher nach Wohnzimmer als nach Container, oder?

 


[1] https://docs.microsoft.com/en-us/style-guide/welcome/