From e65e90c04ddbe01ed5e61494a2f176cb62e60d96 Mon Sep 17 00:00:00 2001 From: mrchensheng21 <45890946+mrchensheng21@users.noreply.github.com> Date: Thu, 3 Oct 2019 15:50:11 +0800 Subject: [PATCH] Edit the User Guide to sort the flow of guide (#43) * Edit User Guide in display * Edit User Guide in display (#42) (#3) * Cleanup the User Guide format --- docs/UserGuide.adoc | 49 ++++++++++++++++++++++++++------------------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index a94f8115d68..9aa17172fe4 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -153,6 +153,25 @@ Format: `delete interviewer NAME` + Deletes the specified interviewee from the database. + Format: `delete interviewee NAME` +=== Tag interview slot `tag` `[Coming in v2.0]` +Tags an interview slot with a name. + +Format: `tag TAG_NAME` + + +User will also be able to filter by tags. + +Format: `filter tag TAG_NAME` + + +=== Scheduling `generate` +==== Generating timetable of all available time slots +Generate the timetable of all available interview time slots based on the availability of interviewers. + +Format: `generate timetable` + + +==== Generating full interview schedule +Schedule and allocate interviewees to the available interview slots based on the availability of interviewees and +the timetable of all available interview time slots. + +Format: `generate schedule` + + +**Note:** This command requires the timetable of all available time slots to be generated first! + === Importing existing availabilities `import` ==== Importing interviewers’ availability Imports interviewers’ availability from a comma separated values (CSV) file. + @@ -180,25 +199,6 @@ Format: `export` + Note: This command requires the interview schedule to be generated first! -=== Tag interview slot `tag` `[Coming in v2.0]` -Tags an interview slot with a name. + -Format: `tag TAG_NAME` + - -User will also be able to filter by tags. + -Format: `filter tag TAG_NAME` + - -=== Scheduling `generate` -==== Generating timetable of all available time slots -Generate the timetable of all available interview time slots based on the availability of interviewers. + -Format: `generate timetable` + - -==== Generating full interview schedule -Schedule and allocate interviewees to the available interview slots based on the availability of interviewees and -the timetable of all available interview time slots. + -Format: `generate schedule` + - -**Note:** This command requires the timetable of all available time slots to be generated first! - === Sending of email `email` ==== Sending of interview time slot to interviewees Sends an email containing the interviewee’s allocated interview time slot to every interviewee, including other details such as the interviewer, time, date and location. @@ -252,8 +252,15 @@ Format: `record rank` |`add interviewer name:"NAME" slot:SLOT...` + `add interviewee name:"NAME" slot:SLOT...` -|Display interview schedule -|`display` + +|Display list of interviewers/interviewees +|`display interviewers` + + `display interviewees` + +|Display weekly schedule +|`display date DATE` + +Display available slots +`display available date Date` |Get interview schedule for interviewer/interviewee |`get NAME` +