nus-se-bot
commented
18 hours 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:
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!
Items for the Tester to Verify
:question: Issue severity
Team chose [severity.Medium]
Originally [severity.High]
- [x] I disagree
Reason for disagreement: [replace this with your reason]I would like to provide further justification for maintaining the severity of this issue as High. While I appreciate the acknowledgment of missing use cases and user stories, I must emphasize the criticality of this flaw in the documentation, especially given the central role event management plays in the functionality of the application.
First and foremost, while it is true that some user stories are included in the Developer Guide, but the compelete omission of event relevant commands in use cases, which is half of the app commands, and core features like editing and searching for events leaves a significant gap in understanding. These functionalities are fundamental to managing events effectively, and their absence directly impacts the ability of developers and maintainers to fully comprehend, debug, or extend the system. For an application designed for event management, such incomplete documentation fails to meet the expectations for core functionality coverage.
Additionally, the examples of user stories provided in the response, while helpful, do not compensate for the lack of clarity in outlining use cases for editing and searching events. The Developer Guide serves as a reference for developers to understand the workflow, inputs, outputs, and constraints associated with each feature. Missing such details for key functionalities undermines the usefulness of the guide and hinders the ability to ensure consistent implementation and maintenance.
The claim that this flaw causes only "occasional inconvenience to some users" underestimates the impact of incomplete documentation on both developers and the application’s future extensibility. In fact, these omissions can result in inconsistent feature behavior or even misalignment with user expectations, as developers may not have sufficient guidance to align their work with the intended functionality. Beyond that, that is marginally mentioning of the implementation, class relations, sequence relations of all the relevant event commands.
Moreover, the remaining issues highlighted in the report, such as the improperly arranged index, missing separators, and deleted use case remnants, further contribute to the lack of coherence and completeness in the documentation. This diminishes the guide's usability and imposes additional effort on developers to navigate and infer the intended design of event-related features.
Based on the definition of severity levels, High severity is appropriate when an issue affects most users and causes major problems, making the product almost unusable. Here, the "users" of the Developer Guide are the developers and maintainers, and the absence of critical documentation affects their ability to understand and implement key functionalities effectively. For an event management application, where editing and searching are core operations, such omissions create a significant barrier to usability and extendibility, aligning more closely with a High severity classification.
In conclusion, the incomplete documentation for event management in the Developer Guide significantly hinders the app's maintainability and extensibility, particularly for core features like editing and searching. This is not a minor inconvenience but a critical issue that impacts the app's functionality and reliability. I respectfully request that the severity classification be maintained as High to reflect the true scope and impact of this issue. Thank you for considering my explanation.
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.
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.