User guide description uses the default AB3 User Guide blurb

[shotnothing]

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)

[nus-se-bot]

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

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

• [x] I disagree

Reason for disagreement: Hi! Thank you for your response!

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)”.

Regarding this, I feel that since the glossary is in the developer guide, the typical user should not need to go in there to figure out what the introduction paragraph (the first thing they see) of the user guide about this unusually strict definition.

The typical user, on opening the user guide after downloading the app, will not and should not be expected to know about your strict definition in the developer's guide glossary. The average person can be expected to refer to the commonly understood English meaning of transaction.

The Merriam-Webster dictionary states:

As a user, I, upon reading the UG intro, did not understand what this app was for and why I would use it until figuring it out myself by looking at the command examples and piecing it together. I don't think I will be alone in this, I doubt a typical user will feel very differently either.

If anything, non-AB3-developers (i.e. the vast majority) may have an even harder time interpreting this as they are not already familiar with the AB3 boilerplate commands.

As per the textbook:

I don't think the current introduction properly explains what problem does the product solve.

Based on the TP grading guidelines for what is a UG bug, I think that the value proposition is not stated clearly.

I feel that a sensible alternative would be to explain the context of financial transactions, or provide examples e.g. tracking debts, in the introduction. As it stands, it looks like the AB3 introduction with the word transaction duct-taped on it, with no additional context or coherence.

pose an issue for future readers who have difficulty in comprehension

I feel that this is unnecessarily rude/condescending, and potentially dismissive of genuine feedback. I believe, as the TP grading guidelines do, that clarity is important.

In retrospect think that this issue warrants a change to severity.Low, as it provides an inconvenience to anyone reading the user guide and trying to figure out what this app is used for, which is the whole point of having a user guide.

---