search

javinchua / pe

0 stars 0 forks source link

Invalid command format #17

Open javinchua opened 8 months ago

javinchua commented 8 months ago

Does not indicate extension for invalid command format when adding.

image.png

nus-se-bot commented 8 months ago

Team's Response

Thanks for raising this up.

We intentionally omitted any extensions for invalid command format since it would be a trivial extension (user inputs invalid format --> ModCraft shows invalid format message). We feel that it has similar qualities to a power failure or a system crash extension, which are omitted. The extension would also be repeated many times for every use case as it would applicable for every single one, and only serve to unnecessarily lengthen the DG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for your response to the issue regarding the omission of an extension for invalid command formats. I understand your concern about brevity in documentation; however, I would like to offer a different perspective that considers user experience and software best practices.

User experience is enhanced when potential errors are anticipated and clearly addressed within the system documentation. For new users or in educational contexts, knowing the expected behavior when an invalid command is entered can be crucial. It prevents confusion and ensures that they understand how to rectify their input without unnecessary trial and error.

Moreover, error handling is not merely a trivial aspect of system operation but a core component of robust software design. Consistent and comprehensive documentation of all possible errors, including those from invalid command formats, contributes to the software's reliability and maintainability. It also aligns with industry standards, where detailed error handling is considered a best practice.

Therefore, I propose that we include a specific extension for invalid command formats in our documentation. This would not only complete our documentation but also serve as an educational guide for users, helping them understand the system's expected behavior, leading to a more favorable user experience.