nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Missing Use Cases & User Stories for Event Management in Developer Guide #3039

Open nus-pe-bot opened 3 days ago

nus-pe-bot commented 3 days ago

Description

Use Cases The DG lacks detailed use cases for various event management functionalities like editing and searching for events, despite these being key features of the app. This critical omission implies that the documentation does not fully cover all necessary actions that users can perform on events, which is essential for a complete understanding of the app's functionality.

In addition, the use case 7 has been deleted, and the index of DG was not arranged and the separator still remains. image.png

Event-related functionalities, especially editing and searching, are the core features for managing events effectively within the app, their absence in the DG leads to an incomplete understanding for future developers.

User Stories Also, the DG lacks user stories related to event management functionalities, such as adding, editing, and deleting events. While other features like participant management are covered, the absence of these user stories creates a significant gap in the document. this actually causes the developer/user to not have an understanding of the app’s capabilities and objectives, especially for readers attempting to evaluate or extend event-related features.

image.png


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

bryanjhc commented 2 days ago

Team's Response

Thank you so much for catching this!

We indeed realise that there are missing use cases for the event management and a missing use case for add event. However, the rest of the event user stories can be found in our dg as seen here:

image.png

As such based on the definition of the severity labels, we believe that the severity should be of severity.Medium as it is a flaw that causes occasional inconvenience to some users but they can continue to use the product using the command format and user stories as attached above and not a flaw that affects most users and causes major problems for users.i.e., makes the product almost unusable for most users.

Thank you again for the good catch!

Duplicate status (if any):

--