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

Review comments on your DG #202

Open
okkhoy opened this issue Nov 2, 2024 · 1 comment
Open

Review comments on your DG #202

okkhoy opened this issue Nov 2, 2024 · 1 comment

Comments

@okkhoy
Copy link

okkhoy commented Nov 2, 2024

  1. Image issues
    image
    a. don't use yellow color, not visible on low contrast screens
    b. we don't allow database; from what I understand, your DB is a json file - you can mention it as Json data instead of database
    c. database doesn't have a description in the component description that follows
  2. consider using neutral colors (or no colors), in all the diagrams
    image
  3. notation
    image
  4. simplify image
    image
    a. consider splitting the diagram to 3 images as suggested
    b. make text in each diagram bigger so that it is clearly visible
  5. notation
    image
  6. notation
    image
  7. incorrect; call to sout is not a self invocation
    image
  8. throw: though there is no standard notation, it may be better to show the throw as a call to exception object or a control return rather than self invocation
    image
@louisjoety louisjoety pinned this issue Nov 2, 2024
@okkhoy
Copy link
Author

okkhoy commented Nov 2, 2024

  1. missing else
    image
  2. no need to input code here; can specify condition in plain english
    image
  3. better to be stating just the condition; e.g., EMAIL_KEY, NUMBER_KEY and Invalid; the check for variable is assumed to be done.
    image
  4. This can be extracted as a SD on its own, and the reference given in add courses.
    image
  5. "Sequence Diagram on PlantUML"??
  6. missing diagram
    image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant