search

m1oojv / pe

0 stars 0 forks source link

Inconsistencies in Logging #2

Open m1oojv opened 10 months ago

m1oojv commented 10 months ago

Screenshot 2023-11-17 at 4.17.00 PM.png It says intializing AddressBook - not updated to MediSync

version also has AddressBook

Screenshot 2023-11-17 at 4.17.31 PM.png

but in the exit command it says medisync

this is a very detrimental bug as the user will be very confused if they noticed this

nus-pe-script commented 10 months ago

Team's Response

This is a cosmetic bug that only affects the terminal. Furthermore, the AddressBook does in a sense refer to the contents of our app, which is essentially a customised address book for a head nurse. Unlikely to cause much confusion, and can be easily fixed in a future patch.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Medium]

Reason for disagreement: Dear Team,

I appreciate your perspective on the logging inconsistencies. However, I would like to argue that the discrepancy between the application initialization and termination messages in the logs should not be dismissed as merely a cosmetic issue of very low severity. While the issue might seem minor, it has broader implications for software clarity and user experience.

  1. Importance of Consistent Logging: In any software application, especially one designed for professional use like MediSync, consistent logging is crucial. Logs are not just for casual observation; they are often used for troubleshooting and understanding the application's behavior. Inconsistencies in logging, such as referring to the application as both 'MediSync' and 'AddressBook', can lead to confusion, especially in contexts where accurate identification of the software is crucial.

  2. User Perception and Trust: The discrepancy in the log messages may cause users, particularly those who are more technically inclined, to question the application's reliability. Users often rely on logs for a clear understanding of what the application is doing, especially during startup and shutdown. Inconsistent messages can undermine user confidence in the application’s stability and professionalism.

  3. Troubleshooting and Technical Support: For technical support and troubleshooting, consistent log messages are essential. If the application encounters issues, and users or developers turn to the logs for information, inconsistencies can lead to misunderstandings or misdiagnoses of problems. This is especially pertinent in an environment where timely resolution of software issues is critical.

  4. Reflecting Application Identity: The log messages should accurately reflect the identity of the application. While 'AddressBook' may conceptually refer to part of the app's functionality, it is important for the log messages to consistently use the application's actual name, 'MediSync', to avoid any ambiguity about which application is running.

Given these considerations, the issue at hand goes beyond a mere cosmetic concern and can affect the operational aspects of the application, particularly in contexts of troubleshooting and technical support. Therefore, I suggest reassessing the severity of this issue to at least a low severity, reflecting its potential impact on user experience and technical clarity.