Beste Antwort
Wenn Sie UML (die am häufigsten verwendeten Diagramme) zum Erstellen verwenden möchten Ihre Softwarearchitektur Visual Paradigm Community Edition ist eine völlig kostenlose Lösung (für Privatpersonen und Nicht-Benutzer) -Commercial).
Unterstützt UML 2.5-Diagramme (hier ist eine MVC Framework-Softwarearchitektur mit Sequenzdiagramm)
Modellansicht-Controller ( MVC ) ist eines der am häufigsten verwendeten Software-Architektur-Frameworks für die Entwicklung von Benutzeroberflächen, das eine Anwendung in drei miteinander verbundene Teile (Modell / Ansicht und Controller) unterteilt. Dies geschieht, um interne Darstellungen von Informationen von der Art und Weise zu trennen, in der Informationen dem Benutzer präsentiert und von diesem akzeptiert werden.
Die MVC-Architektur entkoppelt diese Hauptkomponenten und ermöglicht eine effiziente Wiederverwendung von Code und eine parallele Entwicklung unter Verwendung des Konzepts von Trennung von Bedenken, die sowohl für Web- als auch für Desktop-Anwendungen geeignet ist.
Beispiel: JHispter ist das MVC-Framework (zusammen mit der REST-API) für Webanwendungen, während das beliebteste Framework Spring auch für alle Arten von Anwendungen zu MVC gehört.
In UML können Sie eine Sequenz verwenden Diagramm zur Darstellung Ihrer MVC-Softwarearchitektur. (Quelle: Visuelles Paradigma – MVC-Framework – Community Circle des visuellen Paradigmas )
- Entitäten sind Objekte, die Systemdaten darstellen: Kunde, Produkt, Transaktion, Warenkorb usw.
- Grenzen sind Objekte, die mit Systemakteuren verbunden sind: UserInterface, DataBaseGateway, ServerProxy usw.
- Steuerelemente sind Objekte, die zwischen Grenzen und Entitäten vermitteln.
Sie koordinieren die Ausführung von Befehlen von der Grenze kommen durch Interaktion mit Entität und Grenzobjekten. Steuerelemente entsprechen häufig Anwendungsszenarien und werden häufig durch ein Sequenzdiagramm dargestellt.
Sie können Stereotypen für die Lebenslinie im MVC-Sequenzdiagramm verwenden um visuell zu verdeutlichen, welche Art von Objekten Sie in der MVC verwenden
Erstellen eines MVC-Sequenzdiagramms mit dem kostenlosen UML-Tool
Erfahren Sie mehr über UML-Diagramme
Weitere Informationen zu Sequenzdiagrammen
Antwort
Der Ansatz auf hoher Ebene, den ich im Allgemeinen bei der Dokumentation von Architekturen (oder noch detaillierteren Entwürfen auf niedrigerer Ebene) verfolge, lautet:
- Identifizieren Sie die Entwurfsbeteiligten. Das Engineering- / Entwicklungsteam ist ein Stakeholder. Ihr Test- / Qualitätssicherungsteam, Ihr IT-Infrastrukturteam, Ihr Projektmanagement und möglicherweise auch Ihre Supportmitarbeiter sind möglicherweise ebenfalls Stakeholder des Systems und an verschiedenen Aspekten des Designs interessiert.
- Identifizieren Sie die Problembereiche in Ihrem System. Wenn Ihr System über eine Datenbank verfügt, ist die Datenbankstruktur ein Gesichtspunkt. Wenn Sie ein verteiltes System haben, sind die Systemadministratoren oder Kundendienstmitarbeiter möglicherweise daran interessiert, wo Komponenten installiert sind. Wenn Sie eine öffentliche Schnittstelle haben, interessieren sich externe Entwickler für diese Schnittstelle – Dateiformate, Datenformate usw. Wenn Sie viele komplexe Algorithmen haben, sind die Algorithmusdesigner / -betreuer an den Workflows und Algorithmusschritten interessiert. Jeder von Ihnen identifizierte Standpunkt ist ein spezifischer Satz von Bedenken.
- Wählen Sie für jeden Standpunkt, den Sie haben, eine geeignete Darstellung aus. Für Ihren Datenbankstandpunkt können möglicherweise Entitätsbeziehungsdiagramme und ein Datenwörterbuch hilfreich sein. Für öffentliche Schnittstellen können XML-Schemadokumente oder API-Dokumentation als Teil Ihrer Dokumentation enthalten sein. Berücksichtigen Sie bei komplexen Algorithmen UML-Aktivitäts- oder Interaktionsübersichtsdiagramme. Wenn Sie eine Notation auswählen, bevorzuge ich bekannte und genau definierte Notationen, damit ich meine Notation nicht jemand anderem erklären muss und sie einfach auf vorhandenes Referenzmaterial verweisen kann, wenn sie die verwendeten Symbole nicht kennen.
- Fügen Sie Textbeschreibungen und Rationalisierungen zu den Diagrammen hinzu. Erklären Sie nicht nur, welche architektonischen Entscheidungen Sie getroffen haben, sondern auch, was Sie dazu bewogen hat, diese Entscheidungen zu treffen.
Architektonische Frameworks wie das Zachman Framework, das Open Group Architectural Framework, die Abteilung für Das Defense Architectural Framework und andere Architectural Frameworks helfen dabei, wesentliche Gesichtspunkte und Ansichten zu definieren, die allgemein anwendbar sind.
Letztendlich ist die „beste“ Dokumentation die, die den Anforderungen der Stakeholder entspricht.Der erste Schritt besteht darin, herauszufinden, wer die Informationen benötigt und was genau sie benötigen.