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

tp DG review #108

Open
2 of 7 tasks
bdthanh opened this issue Apr 2, 2023 · 0 comments · Fixed by #115
Open
2 of 7 tasks

tp DG review #108

bdthanh opened this issue Apr 2, 2023 · 0 comments · Fixed by #115
Assignees
Labels
documentation Improvements or additions to documentation priority.Medium Nice to have severity.Medium type.Chore Something that needs to be done, but not a story, bug, or an epic.
Milestone

Comments

@bdthanh
Copy link

bdthanh commented Apr 2, 2023

Hi W13-4! Please find below some suggestions I have. For convenience, I have made a checklist:

  • Missing colon for entities in sequence diagrams

image

  • Consider adding labels and multiplicities for associations in class diagrams

image

  • Consider remove the parameter names in methods, and keeping the types of that params only and removing some unimportant method from class diagrams to reduce complexity.

image

  • Consider following the UML standard notation for class diagrams (removing the circle next to class names, using + - ~ for visibilities,...)

  • Consider adding more diagrams to show the architecture, as well as the different components of your application and how they interact with one another.

  • Consider adding the activation bar for sequence diagrams

image

  • Consider adding an architecture diagram to explain the high level structure/architecture of your application.

Hope this helps! Feel free to contact me if you have any questions.

@WilsonOh WilsonOh self-assigned this Apr 3, 2023
@WilsonOh WilsonOh added this to the v2.1 milestone Apr 3, 2023
@WilsonOh WilsonOh linked a pull request Apr 3, 2023 that will close this issue
@WilsonOh WilsonOh added documentation Improvements or additions to documentation type.Chore Something that needs to be done, but not a story, bug, or an epic. priority.Medium Nice to have severity.Medium labels Apr 3, 2023
@WilsonOh WilsonOh reopened this Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority.Medium Nice to have severity.Medium type.Chore Something that needs to be done, but not a story, bug, or an epic.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants