search

AY2122S2-CS2113T-T09-3 / tp

0 stars 5 forks source link

[DG review] T09-3 #170

Closed slewyh closed 2 years ago

slewyh commented 2 years ago

  1. How about making the colour scheme and font size consistent across diagrams?

    The architecture diagram and sequence diagram below do not look similar in style.
    Screenshot 2022-04-04 at 1 03 01 PMScreenshot 2022-04-04 at 1 03 09 PM

  2. Class diagram notation

    a. Remove non-standard syntax - icons next to class name. b. Replace accessor icons as +, -, or #.

    Screenshot 2022-04-04 at 1 06 51 PM

  3. Class diagram usage

    How about drawing meaningful associations between the following classes? Screenshot 2022-04-04 at 1 10 43 PMScreenshot 2022-04-04 at 1 10 37 PMScreenshot 2022-04-04 at 1 10 19 PMScreenshot 2022-04-04 at 1 10 14 PM

  4. Sequence diagram notation To edit:

    Return arrows as dashed lines. Omit entity boxes below lifeline Redraw self-invocation

    Screenshot 2022-04-04 at 1 15 15 PM

Parameter for method call should be enclosed with () not []. Redraw constructor call arrow.

Screenshot 2022-04-04 at 1 19 01 PM
  1. To fill in missing sections

    Include version number

    Screenshot 2022-04-04 at 1 27 05 PM

Design considerations in Implementation section

  1. Reformatting required

    Replace the markup below:

    Screenshot 2022-04-04 at 1 26 35 PM

  2. Manual testing section

    Screenshot 2022-04-04 at 1 32 16 PM

    The manual testing section could include both valid and invalid parameters as test cases, showing the expected outputs. The UG on the other hand, tends to omit the special cases. Refer to an AB3 example here.

shxr3f commented 2 years ago

Changes contribute be everyone in respective PRs