Skip to content

DG Comments #220

@jothipillay

Description

@jothipillay
  1. Section 2 - Entire section needs to be updated, its still the AddressBook version.
  2. Sequence diagram 3.1.1 - please take a look at Command History Storage again, subtle errors and inconsistencies with rest of diagram.
  3. Class diagram 3.1.1.- why only partial multiplicities -> also try to give a more detailed class diagram.
  4. When discussing Design Considerations, I would recommend the following format for the table to increase readability. For example,

image

The design consideration forms the right most column of your table and it can be anything you want. The purpose of the structuring it this way is so that you make a direct comparison of a particular design consideration for both Design A and B. This suggestion is for the table only.

The discussion looks pretty alright!

  1. Class Diagram 3.2. - please more detail -> eg enums can be shown clearly

  2. Sequence Diagram 3.2. - haha really alot of mistakes -> please look through carefully and redo

  3. Design Consideration format try follow tips above -> i think discussion can also be more in depth and you can talk about how the various inputs are validated.

  4. 3.3 - Maybe definition and explanation of ambiguous vs uambiguous can be thrown into a table.

  5. 3.5 - Still got mention of Address Book here and there.

  6. 3.5 - Discussion is alright, maybe can refine your class diagrams.

  7. 3.5 For Design Cons table, same advice as above.

  8. 3.7 Class Diagram -> can be more detailed, missing multiplicities.

  9. 3.7 Design Cons, can consider talking about Separation of Concerns, coupling, cohesion. I think you did sort of discuss it but make the words and key terms clearer so that you are making a clear reference back to the syllabus.

  10. Discussion is alright! (IMPORTANT) But this "feature" could use more depth I feel, think of ways on how to enhance the use of this.

General Comments:

  1. Each one of you try to have like 3 unique kinds of UML diagrams (typically one class, one sequence, one activity) or so. Check each other's diagrams to ensure errors.
  2. Include small code snippets at certain places to help reader understand what youre talking about.
  3. Table for design considerations can be improved and standardized for all.
  4. Label diagrams like Figure 1, Figure 2 etc. Same for Tables...Table 1, Table 2 etc
  5. Maybe consider having a glossary.
  6. Standardize point forms bullets -> some are dots, some are numbers.

Overall good job guys! I know time was limited so just continue working on it!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions