cloudhill / ped Goto Github PK

When typing a command, the autocomplete suggestion initially shows the available prefixes:

However, in the middle of typing a valid prefix, the command becomes red, making me think I made a mistake:

Although birthdate is a compulsory parameter for adding a person, that information is not shown anywhere in the UI, and there doesn't seem to be any clear way to see that information anywhere else.

It seems like the birthdate is used to calculate the person's age, but it also seems like information that the user may want to see or at least have access to.

It looks like editing elderlies and volunteers can be done by index, but this is not the case for the delete commands, where you have to provide the full NRIC.

Indexes are much easier to type anyway, so it might be more consistent to also allow deleting elderlies and volunteers by index.

The mt/ parameter of the Add Volunteer command in the Command summary looks like its missing a comma

The term "Entity" is defined in the How to Use FriendlyLink section and the Glossary, but it's not actually used anywhere else in the user guide.

It's not a big issue, but you can consider removing the term

(Instead, you might want to define the term "People" or "Person" to be an elderly or a volunteer instead, because that's actually being used in a few places)

For example, Features in the Commands subsection of How to Use FriendlyLink:

This looks pretty confusing as it doesn't differentiate them from other terms that are also referenced as code (e.g. commands, prefixes, and values)

Maybe simply bolding it would be enough to highlight it as there are not many bolded words in the user guide anyway.

P.S. Adding a hyperlink to the mentioned section could be useful as well

Currently, the pair and unpair command accepts the elderly and volunteer NRICs. However, it's pretty easy to make mistakes when typing NRICs.

Since the UI shows both the elderly and volunteer list anyway, it may be useful to allow the pair and unpair commands to also accept the indexes.

Something like pair eid vid and unpair eid vid would be much easier and quicker to type.

The explanation for the date range parameter in the find command is pretty hard to understand.

You could mention how the command either:

• shows the people whose date range "includes" the given dates, or
• how the given dates are "within" the shown date ranges.

Based on the user guide, the find command should only show "date ranges that starts before or equal to AVAILABLE_DATE_START and ends after or equal to AVAILABLE_DATE_END"

This sounds like it doesn't include empty date ranges. However, upon entering a find command with any date range, those without date ranges are also shown.

For example:

1. After list command
   

2. After find dr/2023-01-01,2023-01-02
   

I think this behaviour can either be amended to fit the user guide, or the user guide can specify this behavior

The definition of an entity based on the user guide is:

An entity is a generic term for an object stored in FriendlyLink. It includes elderly, volunteers and pairs.

And just below that, the definition for an index is:

Indexes are natural numbers (numbers used for counting) that are used for numbering entities in a list.

However, pairs in the application do not seem to have an index, and none of the commands actually reference any usage of a pair's index

Pretty nitpicky, but it did confuse me for a bit (maybe pairs should actually have an index to make the unpair command more type-friendly?)

When typing a command, the autocomplete suggestion initially shows the available prefixes:

However, after typing the first prefix, the following prefixes with multiple characters will be shown twice if you're in the middle of typing:

• bd/ is shown twice
  

• vic/ is shown twice