nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

User guide description uses the default AB3 User Guide blurb #318

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

UG states

SpleetWaise builds on AddressBook Level 3 (AB3) – a desktop app for managing contacts, optimized for use via a Command Line Interface (CLI) while still offering the benefits of a Graphical User Interface (GUI). SpleetWaise makes it easy for students to record transactions with contacts saved in the address book. If you can type fast, SpleetWaise lets you handle your contact and transaction management tasks more efficiently than traditional GUI apps.

This description makes the app sound like an address book AB3, rather than the monetary transaction address book that it is. A regular reader reading this wont form any association with money (transactions is a very general term)


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

SeeYangZhi commented 1 week ago

Team's Response

Thank you for your feedback. We appreciate the tester’s observation regarding the UG’s introduction. We would like to clarify the phrasing in the description that includes AB3 is intended: the dash (“AddressBook Level 3 (AB3) – a desktop app for managing contacts…”) was used to acknowledge and clarify what AddressBook Level 3 (AB3) is, as it is the base framework our application is built on. The inclusion of this explanation does not imply that SpleetWaise is solely an address book but rather highlights its heritage and builds upon its functionality (as seen by the sentence immediately after – “SpleetWaise makes it easy for students to record transactions with contacts saved in the address book.”).

Furthermore, the description intended to broadly explain the app’s functionalities, and the term “transactions” was chosen deliberately to cover a wide range of use cases with the exact definition clarified under the Glossary as – “Transaction: A Transaction represents a record of a financial interaction between the user and another party (another contact)”. Therefore, we deem that the tester’s explanation of “A regular reader reading this wont form any association with money (transactions is a very general term)” is invalid. However, we do acknowledge that this might pose an issue for future readers who have difficulty in comprehension and will consider rephrasing and therefore, classify this as response.NotInScope.

Cheers, The SpleetWaise Team

Duplicate status (if any):

--