Update UG #148
Update UG #148
Conversation
Codecov Report
@@ Coverage Diff @@
## master #148 +/- ##
============================================
- Coverage 52.07% 52.06% -0.02%
- Complexity 559 560 +1
============================================
Files 113 114 +1
Lines 2452 2468 +16
Branches 301 301
============================================
+ Hits 1277 1285 +8
- Misses 1093 1100 +7
- Partials 82 83 +1
Continue to review full report at Codecov.
|
docs/UserGuide.md
Outdated
| You can use `NUMBER_OF_DAYS` index to quickly view assignments that you need to complete soon! (with deadlines nearing). | ||
| For example, `list 2` will show you assignments that are due 2 days (48 hours) from the current date (and current time). | ||
| {: .alert .alert-gitlab-purple} |
There was a problem hiding this comment.
The phrasing for line 142 sounds a little strange. Maybe "... quickly view assignments that are due soon." would be better?
There was a problem hiding this comment.
Thought "you need to complete soon" sounds a bit more impactful :')
There was a problem hiding this comment.
Hmm, then maybe removing the (with deadlines nearing) would be better in terms of phrasing :)
docs/UserGuide.md
Outdated
| Here is the table of prefixes that is used: | ||
| <style type="text/css"> | ||
| .tg {border-collapse:collapse;border-spacing:0;} | ||
| .tg td{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px; | ||
| overflow:hidden;padding:10px 5px;word-break:normal;} | ||
| .tg th{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px; | ||
| font-weight:normal;overflow:hidden;padding:10px 5px;word-break:normal;} | ||
| .tg .tg-0lax{text-align:left;vertical-align:top} | ||
| </style> | ||
| <table class="tg"> | ||
| <thead> | ||
| <tr> | ||
| <th class="tg-0lax">Prefix</th> | ||
| <th class="tg-0lax">Type of keyword</th> | ||
| <th class="tg-0lax">Syntax with examples</th> | ||
| <th class="tg-0lax">Remarks</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> |
There was a problem hiding this comment.
For this table, I don't think the "type of keyword" column is very meaningful as the syntax column already mentions the type of keyword in all caps. Also, personally, I feel that the "syntax with example" column is a little cluttered. Maybe separating that column into 2 columns would be better? (one syntax column and one examples column)
docs/UserGuide.md
Outdated
|
|
||
| Format: `find PREFIX/ KEYWORD [MORE KEYWORDS]` | ||
|
|
||
|
|
There was a problem hiding this comment.
Format line should be placed right after the "Finding assignments" subheader to preserve consistency :)
docs/UserGuide.md
Outdated
| Parameters are: | ||
| - n/ NAME_OF_ASSIGNMENT [MORE NAME_OF_ASSIGNMENTS] to find by name of assignment. | ||
| - d/ DATE_OR_TIME_OF_ASSIGNMENT [MORE DATE_OR_TIME_OF_ASSIGNMENT] to find by the deadline (date or time) of assignment. |
There was a problem hiding this comment.
Currently, the parameters section and the table appear to have some slight overlap. You may consider either incorporating the parameters section into the "Remarks" column in the table, or edit the parameters section such that it is distinct from the table.
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
| ## About | ||
| This user guide provides you with the necessary information on how to become an expert user of ProductiveNUS. | ||
| Before moving on to the next section, [Getting started](#getting-started), you can familiarize yourself with the terminologies, syntax and icons used in this user guide by reading the following sub-sections. |
There was a problem hiding this comment.
Do you think it's better to remove the "Before moving on to the ..." and go straight to "You can familiarise yourself ..."? The first part seems a little redundant to me. Unless you want to prevent users from "skipping ahead" of the user guide :)
There was a problem hiding this comment.
Also, remember to change to "familiarise"
| You can list all your assignments with `list`. Alternatively, you can type `list` followed by an index `NUMBER_OF_DAYS` to list your assignments with deadlines that fall within the current date (and time) and `NUMBER_OF_DAYS` later (in number of hours). | ||
|
|
||
| The `NUMBER_OF_DAYS` in hours is multiplied by 24. | ||
|
|
||
| For example, `list 3` lists all your assignments that are due within 3 days (72 hours) from the current date (and current time). If the current date and time is 24/10/2020 12:00 pm, all assignments due from this date and time to 27/10/2020 12:00PM will be displayed. |
There was a problem hiding this comment.
I think we can omit the multiplied by 24 hours information as the users do not need to know. Just telling them the input number refers to the number of days should suffice :)
| - `list` | ||
| - `list 7` |
There was a problem hiding this comment.
Okay, this might be redundant but perhaps adding "lists all your assignments" and "lists all your upcoming assignments in the coming week" or something similar might be a nice touch!
No description provided.