amitrahman1026
commented
1 year ago Team's Response
We believe that the diagrams as provided in the developer guide are meant to assist readers in their understanding of YAMOM. The diagrams are meant to provide a comprehensive overview of the inner working of YAMOM in different context (as the relevant parts for a particular command might involve different subset of the components). The diagrams were added where we felt appropriate for all readers, regardless of competency level and prior experience, to contribute to the code base.
Duplicate status (if any):
--
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 developer guide contains too many diagrams that dive too deep into each class that is implemented within the project. I believe that the overall philosophy for most of the integrations was the same and most of the diagrams were also extremely similar across the different levels of commands. I believe that talking about the overall philosophy behind the implementation of the commands and one interconnected diagram that explains how each command class is accessed would be enough.
[original: nus-cs2113-AY2223S1/pe-interim#732] [original labels: severity.Low type.DocumentationBug]