2017-03-02 4 views
1

HintergrundWelcher UML-Dokumenttyp sollte verwendet werden, um die rabbitmq-Nachrichtenschicht in meiner Anwendung zu dokumentieren?

ich eine Anwendung, die RabbitMQ Messaging für die Kommunikation zwischen den Komponenten verwendet. Es gibt eine anständige Anzahl von Austausch-, Warteschlangen- und Routing-Schlüsseln und vier Hauptkomponenten, die entweder als Herausgeber, Conusmer oder beide agieren. Ich möchte ein Dokument bereitstellen, das die Messaging-Struktur des Systems zeigt, aber selbst auf der Rabbitmq-Site selbst keine Beispiele finden konnte. Der offensichtliche Kandidat ist das UML-Sequenzdiagramm, aber ich möchte sicher sein, dass die Austausche, Routing-Schlüssel, Warteschlangen, Warteschlangen und DLQ klar dargestellt werden. Nicht, dass es wirklich wichtig wäre, aber ich benutze Plantuml, um die Diagramme zu erstellen.

Frage

Welche Art von UML-Dokument verwendet werden soll, ein Messaging-System zu dokumentieren und gibt es Beispiele kann ich überprüfen?

aktualisieren

ich von Workflows über die Erfassung der Informationen des Herausgebers/Consumer-Beziehung und auch den Fluss von Nachrichten durch das System, wie vorsichtig sein soll. Ich denke, es sollten wahrscheinlich zwei verschiedene Diagramme sein.

+1

Ein weiterer offensichtlicher Kandidat sind [UML Activity Diagrams] (http://www.uml-diagrams.org/activity-diagrams-examples.html) – xmojmr

+2

Es hängt von Ihrer Zielgruppe ab. Von einem einfachen Klassendiagramm bis zu fast allem, was UML bietet, ist es möglich. Abgesehen davon: Es ist keine "Stil" Frage in irgendeiner Weise. Es gibt keinen "UML-Stil". –

+0

@ThomasKilian Ich habe den Titel aktualisiert und Stil entfernt, ich denke, was ich bekam, ist, welche der Diagrammvorlagen traditionell verwendet wird, Sequencing, Aktivität usw. Die Zielgruppe ist das Team (Entwickler, Tester, Analysten) und Kunden (Produkteigentümer) /Technik). – Graham

Antwort

0

Vielleicht könnte eine Mischung eine Antwort sein: 1 - Aktivitätsdiagramm zum Detail des Workflow 2 - Sequenzdiagramm vielleicht mehr Implementierung Detail zeigen asynchronen Pfeil mit

1

So wie in den Kommentaren diskutiert gibt es niemanden, Beantworten Sie dies, und der Schlüssel zum Erstellen eines nützlichen Diagramms besteht darin, die Zielgruppe für das Diagramm, das Sie erstellen, richtig zu verstehen. In meinem Fall habe ich beschlossen, ein einzelnes Diagramm zu erstellen, das die Topologie des Messagingsystems zeigt und dann Sequenzdiagramme trennt, die zeigen, wie bestimmte Routen für bestimmte Workflows verwendet werden.

Verwandte Themen