search

AY2425S1-CS2103T-F14b-4 / tp

MIT License
1 stars 5 forks source link

[PE-D][Tester E] NFR in DG can be refined #213

Closed soc-pe-bot closed 5 days ago

soc-pe-bot commented 1 week ago

image.png

Problems with NFR

  1. "Should work on any mainstream OS as long as it has Java 17 or above installed."

Potential Issue: This is not a clear NFR because "mainstream OS" is vague and could vary over time (e.g., Windows, macOS, Linux). It may be hard to confirm compatibility with all such OSes. Suggestion: Specify which operating systems are explicitly supported (e.g., Windows 10, macOS Ventura, Ubuntu 22.04).

  1. "A user with above average typing speed for regular English text [...] should be able to accomplish most of the tasks."

Potential Issue: This is not a well-defined NFR because "above average typing speed" is subjective and varies across users. Suggestion: Replace with a more specific metric or example tasks and time frames, such as “User should be able to add or modify a contact within 5 seconds.”

  1. "The system should be able to handle storage of over 1000 contacts without a noticeable sluggishness in performance for typical usage."

Potential Issue: "Noticeable sluggishness" is subjective and hard to measure objectively. Suggestion: Define performance metrics, such as “Queries should execute within 1 second for up to 1000 contacts.”

Labels: type.DocumentationBug severity.VeryLow original: cshao02/ped#15

AlphaPyke commented 6 days ago

pt 1 is unnecessary as this is mainly to do with java's compatibility which is equally vague hence we have already made it as clear as possible via our glossary

rest are valid, good catch