Bug: Inconsistent Date Format In OverBooked App & User Guide

by Admin 61 views
Bug Report: OverBooked App Date Format Inconsistency

Hey guys, we've got a bit of a snag with the OverBooked app and its User Guide (UG). It seems like the date formats aren't playing nice together, and it's causing some confusion. Let's dive into the details so we can get this sorted out!

Description

The User Guide shows that we should be able to use s/START_DATETIME and e/END_DATETIME when adding events. But guess what? When you actually try to use that format in the app, it throws a fit! It only seems to like st/ and et/. This is a problem because what you see in the UG isn't what you get in the app. This is a critical inconsistency that needs fixing. This inconsistency significantly impacts user experience as users rely on the user guide for accurate information, and encountering discrepancies can lead to frustration and wasted time. The primary goal of any user guide is to provide clear and accurate instructions, enabling users to effectively utilize the application's features. When the guide presents information that contradicts the application's behavior, it undermines its purpose and diminishes user confidence. This issue specifically affects the usability of the event creation feature, a core component of the application. Users who attempt to follow the guide's instructions will be unable to add events successfully, hindering their ability to manage their schedules and utilize the application as intended. Therefore, resolving this inconsistency is paramount to ensuring a seamless and intuitive user experience.

Steps to Reproduce

To see this in action, follow these simple steps:

  1. Fire up OverBooked.jar.
  2. Type this command into the command box:
    add-event en/CS2103T Demo ea/D1 s/2025-10-31 10:00 e/2025-10-31 11:00 d/PE-D testing
  3. Hit Enter.
  4. Notice the error? Yeah, that's not supposed to happen.
  5. Now, try the same command but with st/ and et/:
    add-event en/CS2103T Demo ea/D1 st/2025-10-31 10:00 et/2025-10-31 11:00 d/PE-D testing
  6. Press Enter again.

Expected Behavior

Ideally, one of two things should happen:

  • If the app is supposed to accept the s/ ... e/ ... style, then it should just work and create the event without any fuss.

  • OR, if the app doesn't support s/ ... e/ ..., then the UG shouldn't mention it at all. Consistency is key!

  • In any case, the UG needs to be consistent across the board, whether it's in the main event section or the command summary. No conflicting info allowed!

  • Ideally, the application should be flexible and accommodate both date formats. This would provide users with more options and prevent confusion. However, if maintaining two formats is not feasible, the development team should prioritize consistency by adopting a single format and ensuring that it is accurately documented in the user guide. Regular audits of the user guide should be conducted to verify that all examples and instructions align with the application's behavior. Additionally, incorporating automated tests into the development process can help detect discrepancies between the application and its documentation early on. This proactive approach would significantly reduce the likelihood of users encountering inconsistencies and improve the overall user experience.

Actual Behavior

So, here's what actually happens:

  • The first command (using s/ ... e/ ...) gets rejected. The app throws an error and doesn't create the event. Boo!

  • The second command (using st/ ... et/ ...) is accepted, and the event is added just fine. Yay, but also, why the inconsistency?

Why This Is a Bug

This is definitely a bug for a couple of reasons:

  • The UG is showing one date format (s/ e/), but the app only understands another (st/ et/). So, if someone follows the UG to the letter, they won't be able to add events. That's a major usability issue.

  • It makes the UG inconsistent. The event section and the command summary are giving different information. That's just confusing.

  • Ultimately, this inconsistency undermines the user's trust in the documentation and the application itself. When users encounter discrepancies between the user guide and the actual behavior of the application, it can erode their confidence and lead to frustration. They may question the accuracy of other instructions in the guide and become hesitant to explore the application's features. Therefore, it is crucial to address this issue promptly to restore user trust and ensure a positive user experience. This can be achieved by carefully reviewing and updating the user guide to align with the application's current behavior. Additionally, providing clear and concise error messages when users enter incorrect date formats can help them understand the issue and correct their input.

Screenshot:

Here's a visual to help you see what's going on:

Image Image

Recommendations

To resolve this issue and improve the user experience, the following recommendations are proposed:

  • Update the User Guide: Ensure that the User Guide accurately reflects the accepted date format for event creation. Remove any instances of the incorrect format (s/ e/) and replace them with the correct format (st/ et/).

  • Implement Input Validation: Implement robust input validation to check the date format entered by the user. Provide clear and informative error messages when an invalid format is detected, guiding the user to correct their input.

  • Consider Supporting Both Formats: Evaluate the feasibility of supporting both date formats (s/ e/ and st/ et/). If possible, allowing users to use either format would enhance flexibility and prevent confusion. However, if this is not feasible, prioritize consistency by adopting a single format and ensuring its accuracy throughout the application and documentation.

  • Conduct User Testing: Conduct user testing to gather feedback on the clarity and usability of the date format instructions. This will help identify any remaining areas of confusion and ensure that the documentation effectively guides users in creating events.

  • Automate Documentation Updates: Implement a system to automatically update the User Guide whenever changes are made to the date format. This will help prevent future inconsistencies and ensure that the documentation remains accurate and up-to-date.

By implementing these recommendations, the development team can resolve the date format inconsistency, improve the user experience, and foster greater confidence in the application and its documentation.

Labels

severity.Medium type.FunctionalityBug