leezhengjing/ped

ped's Issues

Documentation: Missing Task Management Commands

The user guide mentions commands like addt, delt, and viewt for task management, but there is no dedicated section explaining these commands. Additionally, these commands are not included in the command summary at the end of the guide. It's important to provide information about these commands and include them in the summary for user clarity.

Documentation: editm removes all current tags not warned in user guide

As a user, when I want to edit the tags about a current member, perhaps I wish to add a new tag on top of the tags that the member already has, i.e. Welfare Head.

However, the current editm functionality completely removes all previous tags and replaces it with the new tags that the user has inputted. It seems like this is intended, as there is a warning in the event of an invalid editMember command, that existing values will be overwritten. However, this could result in the loss of tag data if the user is unaware of this effect. Perhaps it would be good to include a warning in your user guide, as it wasn't explicitly warned in the user guide.

Documentation: Missing Table of Contents

Without a table of contents, the user guide's navigability is reduced. While not all users necessarily use the user guide, it would be a hindrance to the users that do.

Suggestion: Include a working table of contents with working links to the different sections.

Documentation: Lack of hyperlinks for navigability

On top of the missing table of contents, once there is a table of contents in place, perhaps you could include hyperlinks at each section that can direct back to the table of contents so that a user would have an easier time navigating the user guide?

Functionality: Edit feature causing app to crash

I noticed that addm prevented any duplicate entry, be it the name or any of the other fields required. However, editm allowed one to change the user details such that it results in a duplicate entry. As such, this results in the app crashing the next time it boots up. This is probably not an intended effect, and should be prevented in the implementation of editm.

video:https://raw.githubusercontent.com/leezhengjing/ped/main/files/011f3702-76ed-4d78-8fd5-454f897d1b97.mp4

Documentation: Lack of visuals

Not enough visuals e.g., screenshots/diagrams accompanying the user guide sections. Only one screenshot of the app's UI was present in the entire user guide.

Perhaps you could consider putting in more screenshots for sections like the expected outcomes and invalid inputs?

Feature: Invalid command format error message does not include shortform example

Perhaps it would be good to include an example of the shortform command example in the response box? Feels like as a user I would want to be reminded about the shortform commands.