Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #22

Open
Aztek3 opened this issue Mar 30, 2022 · 3 comments
Open

Documentation #22

Aztek3 opened this issue Mar 30, 2022 · 3 comments

Comments

@Aztek3
Copy link
Collaborator

Aztek3 commented Mar 30, 2022

Here is a first version of the uml class diagram for this application (needs still some improvements, contains open questions):
klassendiagramm_alpha_v1

editable file, if needed: klassendiagramm.zip

some questions regarding correct style (might need extra consultation with tutor):

  • imported libraries needed for UML? --> No, only classes that we created
  • some Objects are created by JS internally, they are always just instances of Object. Is it okay to give them names just for the UML even though that is not entirely accurate?
  • usually an entry point of an application is the main() or run() method (I believe), is it ok to pretend the existence of such just for UML?
  • stick to exact structure of JS objects (public variables of object) or pretend that there are actual getters/setters and design UML accordingly? --> Indication of getters setters would be preferable, just having a public attribute without explanation in UML is bad practice
  • what name is best for the numerical variables? float,double,number...?
@stolsky stolsky pinned this issue Apr 3, 2022
@stolsky
Copy link
Owner

stolsky commented Apr 3, 2022

That's my version. I used the JavaScript data types. The JavaScript modules behave like a Singleton class.
klassendiagramm
klassendiagramm v2.zip

@Aztek3
Copy link
Collaborator Author

Aztek3 commented Apr 3, 2022

This was something i came up in the meantime...
klassendiagramm_v3

Yours is visually definetly more appealing, though.
In my opinion the lines from Index.js should be "-->" indicating dependency rather than association

@Aztek3
Copy link
Collaborator Author

Aztek3 commented Apr 3, 2022

Manual to the program
Bedienungsanleitung.pdf
Bedienungsanleitung.docx

Hope at least, thats ok. If not, let me know so I can improve on that

@stolsky stolsky unpinned this issue Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants