search

yuzhongng / pe

0 stars 0 forks source link

The picture should attach to a appendix at the end of the Documentation guide #12

Open yuzhongng opened 2 years ago

yuzhongng commented 2 years ago

Linking the picture to a website is a good idea. But you can attach the picture to an appendix at the end of the guide too. In case there are people who do not like opening a new link. Security and privacy issue

image.png

nus-pe-script commented 2 years ago

Team's Response

The class diagram is too big and link will give a much detailed class diagram.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

DG - Class Diagram not in PDF

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.

image.png

Class diagram is inserted as link to the website's copy rather than shown in DG PDF.

[original: nus-cs2113-AY2122S2/pe-interim#638] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

The class diagram was too big, since it included every class used in the application. As such, inserting it into the Developer Guide would have not been of good usage either (it is too big, and contains too much information). It was meant to just show all the classes used.

As such, the team decided that it would be best to link it outside the document. Additionally, there are also other class diagrams within the developer guide that are more specific and useful for their individual sections.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I understand that the class diagram will be too big and too detailed for the class diagram section in the developer guide. This is why I suggested linking the picture to an appendix section. There is a lot of security reason for the user to use an untrusted hyperlink connecting to a website. You may intentionally use the hyperlink as a phishing website. PDF itself will prompt and warn the user if they would like to open the link in a new website for security reasons mentioned above. The module website also states that only the PDF file should be considered and not the online version.

image.png

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: The severity of this issue may increase depending on the preference of the user. If the user is highly security conscious as the number of phishing links has increased by a lot over the years. The user may outright reject to open the link in another website which will hinder the user or developer from accessing key information of the application which is showing how the component of the application interacts with one another in the form of a class diagram.

My original stance of the severity remains the same which is low. However, it can be classified as medium too as only the PDF version is considered and not the online version or the user is reluctant to open the link in the new website.