search

alwayshuizhen / pe

0 stars 0 forks source link

DG: Missing sections #10

Open alwayshuizhen opened 4 years ago

alwayshuizhen commented 4 years ago

Missing components:

image.png

nus-pe-bot commented 4 years ago

Team's Response

Thank you for bringing this up. The guidelines for the developer guide did not state that an introduction was required. Additionally, we have a design section, and the architecture section was optional. Please see the screenshot below that indicates the sections we are required to have.

Screen Shot 2020-04-15 at 4.22.35 PM.png

Also, one Design&Implementation section is allowed:)

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thanks for the clarification. Let me explain why the multiple issues observed for this issue:

  1. Introduction - Despite not being part of the grading requirement, thinking from the user's perspective, the potential developer would not know what the application is and what is the purpose of the document.

  2. Design components are missing - It is strange that the team did not find the need to explain the program's architecture (i.e. the purpose of the classes and what it is responsible for) before introducing the implementation and the architecture together with the command. (found in search reservation and list stock) . The attached description of the class diagram was much more fitting for a sequence diagram and it simply tells the developer the program flow without providing an explanation as to how these components work together to fufil their purpose.

image.png

:question: Issue severity

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

Reason for disagreement: This issue was tagged with severity.High as the document was heavily inconsistent. There were sequence diagrams and class-diagrams in search stock, search reservation and list stock command while search dish had no diagrams