Ich arbeite derzeit an der Entwicklung einer Webanwendung als Abschlussprojekt und verwende dafür den Tech-Stack MySQL, Node.js, Express.js und React. Bei den Projektdokumentationen, die ich mir zur Inspiration angeschaut habe, ist häufig ein UML-Klassendiagramm enthalten. Allerdings weiß ich nicht, wie ich ein solches Diagramm sinnvoll in meiner Anwendung abbilden kann, da JavaScript und TypeScript traditionell nicht unbedingt klassisch objektorientiert mit Klassen strukturiert arbeiten. Stattdessen werden ja oft andere Muster wie Funktionen und Module verwendet. Die Datenbankmodelle und das MVC Pattern habe ich bereits abgebildet.

Seit ECMAScript 6 (ES6) unterstützt JavaScript die class-Syntax, die eine verständliche Möglichkeit bietet, Klassen zu definieren. Das war vor 9 Jahren.

Habe damals auch mein Abschlussprojekt mit React und Electron gebaut. Habe alle Komponenten etc. als Klasse in einem UML gezeichnet, wurde auch so von den Prüfern akzeptiert. Geht also alles 😄 

vor 4 Stunden schrieb hellerKopf:

Seit ECMAScript 6 (ES6) unterstützt JavaScript die class-Syntax, die eine verständliche Möglichkeit bietet, Klassen zu definieren. Das war vor 9 Jahren.

Das ist mir durchaus bewusst, jedoch wird in JavaScript traditionell eher funktional programmiert und ich will ungern meinen ganzen Code umschreiben. Um meine Frage anders zu formulieren: Muss ich in meiner Projektdokumentation ein UML-Klassendiagramm vorlegen?

vor 4 Minuten schrieb Daniel Beutner:

Muss ich in meiner Projektdokumentation ein UML-Klassendiagramm vorlegen?

Nein, musst du nicht. Du kannst die Punkte auch einfach liegen lassen.

vor 21 Minuten schrieb Daniel Beutner:

Muss ich in meiner Projektdokumentation ein UML-Klassendiagramm vorlegen?

Auf einem Bewertungsbogen ( IHK Köln) zur Projektarbeit steht der Punkt
- normgerechte Darstellung mit etwa 8% der möglichen Gesamtpunkte

Das ist also eine Möglichkeit(!) zu Punkten zu kommen, wenn man es richtig macht.
Macht man nichts, kann es wohl auch keine Punkte geben.
Wenn du Darstellung auf andere Weise den Prüfer überzeugt, muss nicht zwanghaft ein Klassendiagramm dabei sein. Aber ein einfacher Weg wäre es schon.


 

Du könntest vielleicht mit einem Sequenzdiagram verdeutlichen, wie der Nachrichtenfluss innerhalb der Anwendung aussieht. Ich würde es aber nur machen, wenn es dem Leser hilft das Projekt zu verstehen. UML um UMLswillen ist hier glaube ich fehl am Platz. 

UML besteht nicht nur aus einem Klassendiagramm. Es existieren in der UML Welt eine Vielzahl verschiedener Diagrammtypen und "irgendeins" wird immer passen. Ich kenne viele FI:AE - Prüfer die es sehr begrüßen, wenn Diagramme und co. vorhanden sind.

Es ist also nie von Nachteil welche zu haben, kann aber von Nachteil sein keine in der Doku zu verwenden. Dasselbe gilt für Mockups. Schadet seltenst (wenn es das Projekt hergibt), sehen mit wenig Aufwand ganz ansehnlich aus und Prüfer lieben Bildchen ... 😅 (mich eingeschlossen).