[DG] Figure 22, 58: Diagrams contain lower-level details

[nus-pe-bot]

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

---

The point of Figure 22 seems to be more of converying the overall processing of the Logic component, and should abstract away the inner workings of the Model component. Although it is stated that this diagram covers both, it feels like the resultant diagram is somewhat inconsistent in terms of the level of details it is trying to cover.

Similarly, for Figure 58, it may be better to separate the workings of the parsing, and the workings of the handleStatistic method, since it feels like they belong to different level of abstractions.

---

_{[original: nus-cs2103-AY1920S2/pe-interim#2488]}

[fatin99]

Team's Response

For figure 22 (Aakanksha's figure), as mentioned in the DG, the aim of the sequence diagram was to show the interactions between the Logic and Model components. Furthermore, the model interactions are not very complicated and it makes sense to include them in the same diagram so that the reader can get a complete idea of the functioning of the command, which was the intended use of the diagram.

For figure 58(Haoyi's figure), we wanted to depict the entire workings of the report command which is why we begin from when the command is entered up to where the window is shown. We believe that it is easier for developers to get an overall picture of the inner workings of the command through this diagram. We believe that the alternative of having 2 separate diagrams for each different level of abstraction is not necessary, and might in fact over-complicate things for the developer.

The decisions for both were intentional. In our opinions, and the fellow tutorial mates who had helped review our DG before submission, the diagrams aren't too complicated and are easy enough to understand. From our experience as developers, we know that unless the diagram is too complicated or cluttered, developers would prefer to see all the information in one place. We firmly believe that the diagrams contain relevant information without being complicated and therefore it was international to include those details.

Duplicate status (if any):

--