Missing Implementation section in DG

[laurenlhy]

The section detailing the implementation of the product within the Developer Guide is poorly done with no elaboration or diagrams.

The section also makes no sense and has no context.

[nus-pe-bot]

Team's Response

Admittedly, there was a lack of diagrams, however, there was a brief explanation of the flow of the commands coupled with reference to previous command sequence diagrams and architecture diagrams, a sufficient intrepretation of the find command can be derived

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Medium] Originally [severity.High]

• [x] I disagree

Reason for disagreement: Implementation section in DG could have included details such as how it was implemented, why it was implemented that way and alternatives considered, as seen from the textbook.

However, the Implementation section in this DG did not provide much information for other developers and it is difficult to understand the implementation of the 'find' feature by simply inferring from this brief explanation. For instance, we would not be able to infer the alternative designs considered for the feature. Furthermore, the only sequence diagrams provided previously were both for the 'delete' command, and we cannot assume that the sequence diagram would be identical for the 'find' command. There is also no elaboration for the implementation of any other commands in the app. This is a high severity bug because the lack of elaboration and diagrams in this section defeats the purpose of documentation for developers who want to later maintain or evolve the code.

---