search

woojiahao / pe

1 stars 0 forks source link

Duplicate section for "planned enhancements" in DG #26

Open woojiahao opened 12 months ago

woojiahao commented 12 months ago

One under User Stories and one under Appendix

nus-pe-bot commented 11 months ago

Team's Response

Thanks for point this out, but we the 2 "planned enhancements" sections differs, as the first instance of "planned enhancement" in the user story section and hence wording reflects the user story of the planned enhancement, and the other at the end of the dg to reflect how we would implement the planned enhancement.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While I understand the rationale, this does not remove the ambiguity and since there is no clarification on the differences between these sections, it is easy for developers reading the DG to be confused.

Additionally, since it was a required section for this module to specify, duplicating the section could be also make it harder for the readers to distinguish between the sections.

As a result, this IS something that can be better phrased and worded differently to clarify the differences, and as a result, it something that can be improved on in future iterations. There is no reason for this to be Rejected as the current state of the documentation is ambiguous.