Confusing remarks for phone number field

[weiliann]

Issue: Contradicting terms used in contact add in the user guide

Rationale: In the user guide under contact add, it states that phone number can must be a non-negative integers. As a new user reading the user guide for the first time, such typo confuses me significantly as can and must convey completely different meanings. A new user might be left wondering what exactly is required of the phone number field? It hinders the readability of new users, as they rely heavily on the user guide to learn the application. such typos might even deter an impatient user from using the app completely and could potentially warrant a higher severity. However, i believe that a low severity is justified and should allow us to reach a consensus to improve the user experience when reading the user guide together.

Image taken from user guide:

[soc-se-bot]

Team's Response

Thank you for your concern.

An oversight when writing the User Guide. However as mentioned in the textbook, severity of typo in documentation, is purely cosmetic and it's severity is very low. Therefore, we concur the severity to be updated to very low.

Items for the Tester to Verify

:question: Issue severity

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

• [x] I disagree

Reason for disagreement: A very minor typo that does not hinder readability can be assigned a VeryLow severity, the issue in this case is not trivial, as highlighted in my original report. The difference in meaning between "can" and "must" is significant, and this discrepancy creates confusion for readers, who are left uncertain about the correct requirement for the phone number field.

For example, "Phone number can be a non-negative integer": This implies that entering a phone number as a non-negative integer is optional, and other formats might also be acceptable (e.g., alphanumeric or negative numbers). "Phone number must be a non-negative integer": This explicitly states that the only acceptable format for the phone number is a non-negative integer

This ambiguity disrupts the readability of the user guide and could lead to misinterpretation, making it more than a cosmetic issue. Therefore, I maintain that the severity should be at least low, as it causes inconvenience and could hinder users from effectively using the application.

---