Wie dokumentiere ich eine allgegenwärtige Sprache?

14

Unser Unternehmen ist dabei, viele manuelle Geschäftsprozesse (und das damit verbundene institutionelle Wissen) in neue Unternehmenssoftware umzuwandeln. Das Projekt läuft sehr gut, aber im weiteren Verlauf ist klar, dass es sowohl auf der Geschäfts- als auch auf der Entwicklungsseite große Verwirrung hinsichtlich der Begriffe und Definitionen gibt.

Ich kenne Evans Argumente für die Bildung einer allgegenwärtigen Sprache schon seit einiger Zeit, aber dies ist das erste Mal, dass ich sie offiziell dokumentieren muss. Wenn ich mich umsehe und darüber nachdenke, wo und wie unsere UL-Bedingungen zu dokumentieren sind, bin ich irgendwie verloren.

Wie dokumentieren andere Unternehmen die allgegenwärtige Sprache? Ist das nur ein Wiki-Wörterbuch? Gibt es ein Tool, das für diesen Zweck vorgesehen ist?

doub1ejack
quelle
1
Dies ist ein guter Anfang: thepaulrayner.com/blog/2013/05/07/… . Diese Passage gefällt mir besonders: "Wichtig ist nicht, dass die Domain dokumentiert ist, dass sie verstanden wird und dass dieses Verständnis von allen geteilt wird, die mit der Entwicklung der Software zu tun haben."
Robert Harvey
Wow - was für eine tolle Frage. Wenn ich diese Frage hätte, würde ich in EventStorming nachsehen, ob es eine sinnvolle Möglichkeit gibt, die Ergebnisse dieses Prozesses zu dokumentieren.
VoiceOfUnreason

Antworten:

4

Sie können "allgegenwärtige Sprachdokumentation" als Software-Anpassungsprojekt behandeln: Sie müssen Software für das Dokumentationsmanagement verwenden und an Ihre spezifischen Anforderungen anpassen. In Softwareprojekten beginnen Sie normalerweise mit der Erfassung der Benutzeranforderungen, erstellen dann die Informationsarchitektur und die Entwurfslösung und fahren dann mit der Implementierung fort. Unten sehen Sie ein Beispiel für diesen Prozess.

Was braucht der Benutzer dafür? In einigen Organisationen möchten Personen mit unterschiedlichen Funktionen aus verschiedenen Domänen den Dialekt einer gemeinsamen Sprache verwenden, um ihre Probleme und Lösungen zu beschreiben. Dieser Dialekt wird ausschließlich durch sein Vokabular (Wörter und Zahlen der Sprache) definiert, da die Aussprache hier wahrscheinlich keine Rolle spielt und die Grammatik auf der literarischen Form der Sprache basiert. Um den Dialekt zu dokumentieren, müssen Sie eine Dokumentationsstruktur entwerfen, die sich am besten für die Verwaltung eines Vokabulars (Glossar von Begriffen) eignet.

Möglicherweise möchten Benutzer diese Dokumentation verwenden, um die Bedeutung des Wortes oder Akronyms zu lernen, anhand seines Synonym oder seiner Definition das richtige Wort zu finden oder alle Wörter zu lernen, aus denen sich die Domäne zusammensetzt.

Für diese Benutzeranforderungen ist Wiki in der Tat eine gute Wahl. Wie passt es In guten Wikisystemen wie Confluence oder MediaWiki ist es möglich:

  • Erstellen Sie für jeden Begriff einen Artikel.
  • Definieren Sie die allgemeine Struktur der Artikel in einer Vorlage, sodass sie einige allgemeine Abschnitte enthalten, die für die Aggregation verwendet werden können.
  • Fügen Sie einfach Links zu Termdefinitionen in anderen Wiki-Artikeln hinzu.
  • Erstellen Sie aggregierte Tabellen mit Termdefinitionen und binden Sie diese in andere Dokumentationen ein.

Derzeit verwende ich Confluence zur Dokumentation der Informationsarchitektur, und allgegenwärtige Sprachdefinitionen sind Teil davon. Höchste Ebene dieser Dokumentation sind Domain-Artikel. In jeder Anwendung gibt es mehrere Domänen, z. B. Sicherheit, Zahlungen usw. Diese Domänen werden durch eine Reihe von Interaktionen des Benutzers mit dem System definiert, die über eine allgegenwärtige Sprache beschrieben werden können. Daher füge ich Definitionen dieser Interaktionen in separate Unterseiten und Definitionen ein von Begriffen, die durch diese Interaktionen auf den Unterseiten von Interaktionsseiten eingeführt wurden. Ich habe übergeordnete Seiten mit aggregierten Tabellen versehen, damit Sie beispielsweise sehen können, aus welchen Szenarien die Domäne besteht und welche Begriffe darin definiert sind.

Wenn diese Dokumentationsstruktur fertig ist und ich zu detaillierteren Systemspezifikationen gehe, kann ich einfach auf die IA- und UL-Definitionen der Szenarien verweisen, z Z (UL-Verbindung) ".

Ivan Gammel
quelle