search

team-propra / roommate

A project created as part of the module "Programmierpraktikum 2" at Heinrich Heine University Düsseldorf
2 stars 0 forks source link

architecture documentation #91

Closed nighoge closed 8 months ago

nighoge commented 9 months ago

Architekturdokumentation für RoomMate-Implementierung

Entwickeln Sie eine Architekturdokumentation zu Ihrer RoomMate-Implementierung unter Verwendung der arc42-Vorlage. Denken Sie unbedingt daran, dass Sie kein Formular ausfüllen, sondern konzentrieren Sie sich auf die Dinge, die besonders wichtig sind. Kapitel, die keinen Inhalt haben, müssen entfernt werden.

Wichtiger Hinweis: Niemand liest seitenweise Dokumentation! Fassen Sie sich kurz! 3-5 Seiten sollen mehr als genug sein.

Überlegen Sie sich, welche Informationen Sie selbst sehen wollen würden, wenn Sie neu in das Projekt kommen. Erstellen Sie auf jeden Fall eine Kontextabgrenzung und ein Diagramm der Komponentenstruktur. Wenn Sie ein UML-Diagramm zur Absicherung mit ArchUnit verwenden, können Sie dieses Diagramm hier wiederverwenden.

themassiveone commented 9 months ago

its gonna be 2 more weeks from now on until arc42 is gonna be relevant test-wise. Sounds really interesting though. #51 is related