search

Smanmos / pe

0 stars 0 forks source link

add command DG too small #13

Open Smanmos opened 2 years ago

Smanmos commented 2 years ago

add command dg.png Too many low level details are provided (i.e. contact details), making it too small to read when unzoomed

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

[DG] Words in this diagram are too small I can't read them at all

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.

Screenshot 2021-11-12 at 5.28.22 PM.png

[original: nus-cs2103-AY2122S1/pe-interim#4647] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

Expected outcome.

It is resolved using image URLs.

In the second sentence of https://ay2122s1-cs2103-t14-3.github.io/tp/DeveloperGuide.html#design. In the Design segment of the DG, we stated in sentence 2:Tip 2: Each of the following class, sequence and activity diagram can be enlarged by CLICKING on the respective images!` in anticipation of this issue.

image.png

If read carefully and the respective images on the PDF document is clicked, an expanded version of the diagram would be opened on the browser allowing users to view a large version of the diagram.

image.png

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: The tip is easy to miss. Developers quickly scanning the document to find the appropriate diagram may miss the tip, especially if they navigate to the diagram directly from the contents page. Additionally, there are no visual cues that diagrams can be clicked to open a bigger diagram in another webpage.

Furthermore, the AddJobCommand diagram is still too small even when viewed on a browser. It can only be read clearly when zoomed in when in the browser.

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]