coregano / pe

0 stars 0 forks source link

Appendixes missing #5

Open coregano opened 1 year ago

coregano commented 1 year ago

Taken from cs2113 module website:

image.png

Team's DG is missing: Appendix C: Non Functional Requirements Appendix D: Glossary Appendix E: Instructions for Manual Testing (more details below)

soc-pe-bot commented 1 year ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

This issue contains multiple points but is all included in other issues of the same nature. (#2557 and #2556)

The 'Original' Bug

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

Missing Glossary

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.


[CS2113-T15-4][Clanki]DG.pdf

The DG is missing glossary.


[original: nus-cs2113-AY2223S2/pe-interim#2339] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

Thanks. We decided that glossary was unnecessary, as there were no terms that need explicit explanation, considering the target users. For example, "flashcard" might be a term worth explaining, but since this application is for users learning languages/etc. using flashcards and spaced repetition, they likely already know what this term means. And even if they don't, considering that it's pretty clear throughout the UG that flashcards have questions and answers, they should be able to see how it works pretty easily...

... is what we decided, but now after re-thinking I think you made a point here. Thanks!

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 reason]


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your reason]