Ein Glossar ist eine Sammlung von Fachbegriffen aus dem Geschäftsfeld im Unternehmen, in dem die Software zum Einsatz kommt. Das Glossar der Methode CARDS+ ist Teil des Wiki, Teil der Produktdokumentation. Das Glossar ist das “Wörterbuch” des Projektes. Es ist ein Mini-Lexikon, zugeschnitten auf das Produkt.

Begriffe

Ein Eintrag im Glossar ist in der natürlichen Sprache der Stakeholder und Nutzer geschrieben. Er enthält Erklärungen zum Begriff in der primären Sprache des Projektes. In einem internationalen Projekt nutzen wir das Glossar auch für Übersetzungen der Begriffe in anderen Sprachen.

Ein Glossar enthält

  • Begriffe, die sehr häufig verwendet werden.
  • Begriffe, die den Fachleuten besonders wichtig sind.
  • Unterschiedliche Begriffe mit gleicher Bedeutung.

Das Glossar besteht aus einer Seite je Begriff. Nur so können wir sehr schnell die Verlinkung in den Texten anderer Seiten im Wiki herstellen.

ktip In Confluence geht das quasi beim Schreiben des Textes. Um Links besonders schnell einzufügen, tippen sie das Sonderzeichen “[” und die ersten paar Buchstaben des Begriffes, den sie verlinken möchten. Die Link-Vervollständigung schlägt automatisch den Seitennamen vor und generiert einen Link im Text.

Die Seiten sind gruppiert nach dem Anfangsbuchstaben des Begriffes. Dieses seitenbasierte Stichwortverzeichnis ist die einfachste Form, um sich schnell einen Überblick über das Glossar zu verschaffen.

Stichworte

Stichworte bzw. Schlagworte als Zusatzinformation einer Seite im Wiki sind ein weiteres wichtiges Mittel für Autoren zur Verknüpfung von Inhalten. Stichwort (ein Begriff aus Titel oder Text der Seite) und Schlagwort (ein verwandter Begriff aus einem festen Vokabular) unterscheiden sich nicht in diesem Zusammenhang. Jedes Schlagwort wird als Begriff im Glossar erklärt und definiert so das Vokabular.

ktip Stichworte (englisch: label) geben uns in Confluence eine einfache Möglichkeit, verwandte Begriffe mit einem Makro zu generieren. Das Inhalte nach Labeln-Makro listet Seiten auf, die mit einem oder mehreren Stichworten versehen wurden. Das Makro für verwandte Label listet alle Stichworte anderer Seiten auf, die im engen Zusammenhang mit den Stichworten der gegenwärtigen Seite stehen.

Stichworte eröffnen weitere Möglichkeiten der Recherche im Wiki. Mit Stichworten lassen sich sehr schnell Zusammenhänge erkennen. Nutzen Autoren Stichworte in allen Seiten konsequent, dann ist eine stichwort-basierte Suche ein sehr mächtiges Werkzeug. Konsequent bedeutet, dass alle Autoren die gleichen Stichworte verwenden. Das Glossar spielt hier eine entscheidende Rolle für Qualität. In den Seiten des Wiki dürfen Autoren nur Stichworte verwenden, die auch als Eintrag im Glossar existieren. Dadurch schränken sich die Autoren automatisch auf allseits bekannte Begriffe ein. Die Begriffe sind im Projekt bekannt. Jeder Begriff wird für die Leser im Glossar erklärt.

Wörterbuch

Bereits bei der Projektinitialisierung legen wir das Glossar an. Wir erfassen alle wichtigen Begriffe, die Stakeholder bei der Abgrenzung des Projektes in den Topics erwähnen. Dadurch schaffen wir es, dass die Projektmitarbeiter gleich zu Beginn mit den korrekten Begriffen Kontakt haben. Mit dem Glossar haben Stakeholder und Product-Owner ein Werkzeug in der Hand, eine gemeinsame Projektsprache zu etablieren. Neue Projektmitarbeiter können mithilfe des Glossars die Projektsprache erlernen. Missverständnisse in der Kommunikation zwischen Stakeholdern, Fachleuten und Projektmitarbeitern können wir auf diese Weise vermeiden oder zumindest früh erkennen.

Fachbegriffe

Im Zusammenhang mit der Analyse der Anforderung pflegen wir unser Glossar der Fachbegriffe. Gerade bei Gesprächen mit Stakeholdern und anderen Fachleuten gibt es Situationen, in denen wir erkennen, ob ein Begriff wichtig genug ist, um im Glossar erfasst zu werden. In jeder Branche gibt es Fachbegriffe, die nicht jeder Projektmitarbeiter kennt. Diese Fachbegriffe sind besonders wichtig, weil mit einem einzelnen dieser Worte in dieser Branche sehr viel ausgedrückt wird. Es ist für das Projekt ein großer Vorteil, alle Fachbegriffe zu kennen und vor allem zu verstehen. Fachbegriffe sind eindeutig. Oder sie sollten es sein. Manchmal gibt es jedoch mehr als einen Fachbegriff.

Im Glossar gilt das Highlander-Prinzip: Es darf nur einen geben.

Im Zusammenhang mit dem Glossar klären wir insbesondere auch Begriffskonflikte. Am Ende legen wir einen Begriff als den “Richtigen” fest und beschreiben ihn als Eintrag im Glossar. Im Eintrag erfassen wir aber auch alle alternativen Begriffe, mit Herkunft und Erklärung, warum wir den Begriff im Projekt nicht verwenden. Das Glossar dokumentiert damit die Entscheidung für die Wahl eines bestimmten Begriffes im Projekt. Ein Product-Owner, der schon einmal mit einem neuen Stakeholder über Begrifflichkeiten diskutieren musste, wird den Wert solcher Einträge im Glossar schätzen.

Querverweise

Wichtig ist, dass die Verwendung der Begriffe aus dem Glossar im Projekt gefördert wird. Querverweise als Link zu einem Eintrag im Glossar sind ein sehr einfaches Mittel, um eine qualitativ hochwertige Produktdokumentation zu erschaffen. Durch einen Link verschaffen wir dem Leser einen sehr schnellen Zugriff auf weiterführende Informationen. Autoren müssen wichtige Begriffe nicht mehr im Text erläutern. Die Texte im Wiki werden sehr kompakt. Wir vermeiden mehrfache Beschreibungen eines Begriffes im Text selbst und reduzieren damit die Gefahr widersprüchlicher Beschreibungen. Durch Reviews stellen wir sicher, dass Autoren Querverweise als Links oder Stichworte ausreichend nutzen. Die Herausforderung ist die korrekte Verwendung der Begriffe. Das Glossar hilft dabei.

Lesbarer Code

Wichtig ist, dass auch in der Entwicklung die Verwendung der Begriffe aus dem Glossar gefördert wird. Lesbarer Code ist in der Methode CARDS+ Teil der Produktdokumentation. Lesbar bedeutet, dass Entwickler Code auch ohne zusätzliche Kommentare verstehen. Bezeichner von Klassen, Attribute oder Methoden, die wir aus den Begriffen des Glossars bilden, schlagen ohne weitere Erklärung sofort eine Brücke zwischen Code und Produktdokumentation. Bei der Durchführung von Code-Reviews stellen wir sicher, dass Entwickler Begriffe aus dem Glossar korrekt verwenden. Das Glossar gibt die primäre Sprache für die wesentlichen Elemente des Codes vor. Übersetzungen in andere Sprachen sind nicht vorgesehen. Das gilt auch für die englische Sprache, wenn es nicht die primäre Sprache im Projekt ist.

Fazit

Ein Glossar ist sehr wertvoll über den gesamten Lebenszyklus eines Projektes – und darüber hinaus. Es ist ein ganz wichtiger Teil der Produktdokumentation. Es ist nützlich für Stakeholder und Projektmitarbeiter. Schaffen wir es, dass die Begriffe im Glossar in der Kommunikation verwendet werden, haben wir ein großes Versprechen agiler Methoden erfüllt: Die gemeinsame Sprache.