Release Notes for v1.5
Overview
Hello once again! MedDict is back with a fresh new look ππ. This release brings substantial improvements and new features, transforming the application into a more full-fledged tool for medical staff and aspiring developers. With an updated and polished User Guide tailored for medical professionals, as well as a Developer Guide for budding developers, this version is set up for practical testing and open-wide feedback. We welcome all observations on bugs, usability, and any potential enhancements.
Key Updates
-
Enhanced Command Functionality:
- Fixed and refined core commands such as
EditPerson
,AddRemarks
,CreatePatient
, andCreateDoctor
. - Improved
DeleteSequenceDiagram
andMarkAppointmentCommandTest
, enhancing both visual and functional consistency. - Modifications to the existing commands for smoother workflow and improved usability.
- Fixed and refined core commands such as
-
Testing Improvements:
- Additional unit tests for
MarkAppointmentCommandTest
andRemarkCommandTest
to ensure robust handling of appointment and remark functionalities. - Created comprehensive command parser tests, especially for Person-related commands, to verify proper parsing of user inputs.
- Additional unit tests for
-
User Interface and Usability Enhancements:
- Updated visual elements across the application, improving readability and layout.
- Fixed multiple formatting and CSS errors to ensure a smoother user experience.
- Added indicators to distinguish completed and incomplete appointments.
-
Documentation Updates:
- User Guide: Expanded with a detailed Quick Start guide for medical staff, refining instructions to enhance accessibility and ease of use.
- Developer Guide: Updated to include manual testing instructions, UML modifications, and a refined architecture sequence diagram, aiding developers in navigating the codebase.
-
Logging and Assertions:
- Enabled assertions and added extra logging for better debugging and error tracking.
-
Code Quality Enhancements:
- Refactored code to enhance maintainability, readability, and overall quality.
Known Areas for Testing
This release is primed for extensive testing. Feedback on the following would be particularly valuable:
- Command Parsing: Ensure accuracy and intuitive handling of all commands, especially around Person and Appointment commands.
- UI Feedback: Evaluate usability, visual consistency, and whether indicators for appointment statuses improve user experience.
- Documentation Clarity: Verify if the updated guides are sufficiently clear and helpful, especially for new users and developers.
Full Changelog
For a comprehensive list of all changes in this release, please visit v1.5 Changelog.
We look forward to your insights and bug reports!
Special thanks to everyone who has worked to rush out v1.5.0
What's Changed
- Fix print by @Nigeltzy in #125
- Modify Existing Architecture Sequence Diagram by @chengzihao123 in #126
- Enable Assertion by @chengzihao123 in #124
- Update ModelClassDiagram.puml by @Nigeltzy in #128
- UML Modification by @tyxiangs in #132
- MarkAppointmentCommandTest: add unit test for marking appointments by @tyxiangs in #135
- Add extra Logging by @chengzihao123 in #127
- Update DeleteSequenceDiagram by @sandyk0105 in #130
- Update UserGuide.md by @sandyk0105 in #139
- RemarkCommandTest: add unit test for remark functionality by @tyxiangs in #137
- Branch user guide update feature by @tyxiangs in #141
- Modify existing commands by @chengzihao123 in #143
- Update user guide by @tyxiangs in #144
- Update UserGuide (detailed quick start) by @shinichi04 in #148
- Update Current User Guide by @sandyk0105 in #158
- Update UG by @sandyk0105 in #170
- Fix EditPerson , AddRemarks, CreatePatient and CreateDoctor Commands by @chengzihao123 in #162
- Fix CreateP, CreateD and Delete Commands by @chengzihao123 in #171
- Branch alpha bug fix appointment by @tyxiangs in #174
- More test cases for parsers by @chengzihao123 in #176
- Developer Guide Update by @tyxiangs in #177
- Modify DG and UG by @chengzihao123 in #180
- Update website by @Nigeltzy in #181
- Update table format by @Nigeltzy in #182
- 178 update ug by @Nigeltzy in #183
- Update bugs by @Nigeltzy in #184
- Update formatting errors by @Nigeltzy in #187
- Test formatting by @Nigeltzy in #188
- Update UG formatting by @Nigeltzy in #189
- Add DG manual testing by @shinichi04 in #175
- User Guide Update by @tyxiangs in #185
- Update formatting by @Nigeltzy in #190
- Update visual elements by @Nigeltzy in #193
- Code Quality Changes by @chengzihao123 in #192
- Update visual elements by @Nigeltzy in #194
- Update Getting Started in UG by @Nigeltzy in #197
- Create Command Parser Tests for Person-related Commands by @sandyk0105 in #196
- Fix remaining formatting errors by @Nigeltzy in #201
- Fix css by @sandyk0105 in #204
- Refine UG by @Nigeltzy in #205
- Fix formatting errors by @Nigeltzy in #207
- Fix bugs by @chengzihao123 in #203
- Indicate Completed/Incompelte Appointments by @sandyk0105 in #209
Full Changelog: v1.4...v1.5