search

weijianwong / pe

0 stars 0 forks source link

Missing the use case for edit #15

Open weijianwong opened 2 weeks ago

weijianwong commented 2 weeks ago

The edit command is a feature that has many possible extensions and so it is definitely a use case that is worthy of documenting. However, it is missing from the developer guide.

nus-pe-script commented 1 week ago

Team's Response

We accept this as VeryLow severity because it doesn't affect out app's behaviour

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

No use cases for important commands

Like cattag, especially since it has a lot of possible errors that can happen

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I disagree with the severity assigned to this issue. While I agree that this issue can be marked as a duplicate of the other issue regarding the missing cattag use case, both are significant documentation problems because they pertain to essential features that are not explained in the Developer Guide. According to Prof. Damith, a documentation bug can indeed be labeled as severity high if the explanation is unclear, as evidenced by Prof. Damith’s recent reply on the forum, which I have screenshotted below: ![image.png](https://raw.githubusercontent.com/weijianwong/pe/main/files/14eed98e-0a25-4abb-aa2e-b0a9bca17050.png) If the absence of clear explanations can qualify as a high-severity bug, wouldn’t the complete omission of such explanations for key features be an even bigger issue? In this case, the absence of the edit and cattag use cases from the Developer Guide creates significant inconvenience for developers since the developer guide is meant for developers. These features are not documented in any other section of the guide, forcing developers to read and analyze the code to guess how these features work and what their requirements are. This is the whole point of use cases, they allow developers to quickly understand system requirements and identify points of failure to better design the feature. This lack of documentation undermines the usability of the Developer Guide for future developers as they would be unclear of what the edit command achieves and how to enhance it in subsequent iterations. Therefore, I believe the absence of use cases for both the cattag and the edit commands constitutes a **severity High** documentation bug, as it involves missing use cases for essential features. However, since my original bug report specifically addressed only the edit use case, I think that my original label as **severity medium** is indeed more accurate and fair.