search

ianyong / pe

0 stars 0 forks source link

User Guide: Searches only account for full words #11

Open ianyong opened 3 years ago

ianyong commented 3 years ago

On page 11 of the user guide PDF,

Searches only account for full words, e.g. Deploy will not match Deployment but Stand-up will match Up button and Laptop stand.

Hyphenated words are typically considered to be full words. The example provided is contradictory.

nus-se-bot commented 3 years ago

Team's Response

A hyphen is a punctuation mark that is used to join words together. As such, although the hyphenated word is one word, it joins two words. That is why stand-up is made up of 2 full words i.e. stand, up. Thus matching Up button and Laptop stand

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: > A hyphen is a punctuation mark that is used to join words together. As such, although the hyphenated word is one word, it joins two words. That is why stand-up is made up of 2 full words i.e. stand, up. Thus matching Up button and Laptop stand

The presence of the hyphen changes the meaning of the word such that its meaning is different if the hyphen is not there. This means that 'stand-up' and 'stand up' cannot be used interchangeably, and that 'stand-up' is 1 full word on its own, rather than merely being the conjunction of 2 words.

In addition, most, if not all, popular text editors with word counts consider hyphenated words to be a single word. This is established behaviour and it is reasonable for the user to treat hyphenated words as single words.

Demonstration in Microsoft Word:

image.png

image.png

Demonstration in Google Docs:

image.png

image.png

Demonstration in Vim:

image.png

image.png

If Productive does not consider hyphenated words to be a single word, then this behaviour should be explicitly stated in the user guide.

:question: Issue severity

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

Reason for disagreement: The definition of severity.VeryLow is as follows:

A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage.

Given everything mentioned above in the issue response, I disagree that the flaw is purely cosmetic. At the very least, this flaw should be severity.Low as it causes a minor inconvenience to the user.

Definition of severity.Low:

A flaw that is unlikely to affect normal operations of the product. Appears only in very rare situations and causes a minor inconvenience only.