Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY2021S1#107 from Nijnxw/branch-v1.3-ug…
Browse files Browse the repository at this point in the history
…-questions

Update UG - Questions
  • Loading branch information
chunyongg authored Oct 19, 2020
2 parents a2386c2 + eefdbbf commit bc1728b
Showing 1 changed file with 45 additions and 51 deletions.
96 changes: 45 additions & 51 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ By: `Team Serenity` Since: `Aug 2020`

* [Exporting of class participation grades to CSV: `exportCp`](#exporting-of-class-participation-grades-to-csv-exportcp)

4.4 [Addressing Questions](#addressing-questions)
4.4. [Question Addressing](#ins44-question-addressingins)

4.4.1. [Adding a question: `addQn`](#441-add-a-new-question-addqn)

* [Adding a question: `addQn`](#adding-a-question-addqn)
4.4.2. [Deleting a question: `deleteQn`](#442-delete-an-existing-question-delqn)

* [Viewing all questions: `questions`](#viewing-all-questions-list)

* [Deleting a question: `deleteQn`](#deleting-a-question-deleteqn)

* [Marking a question as answered: `ansQn`](#marking-a-question-as-answered-ansqn)
4.5. [Utility](#ins45-utilityins)

4.5.2. [View an existing tutorial lesson: `viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn)

5. [FAQ](#faq)

Expand Down Expand Up @@ -290,72 +290,66 @@ Outcome:

---

### <ins>Addressing Questions</ins>
### <ins>4.4. Question Addressing</ins>

#### Adding a question: `addQn`
Need to keep track of all your students' questions during lessons quickly? This feature allows you to key in questions easily for future references.

Adds a question to the list of questions of a specified tutorial group.
#### 4.4.1. Add a new question: `addqn`
You can use this command to add a question that was asked in a lesson, so that you can address the question at the end of the lesson.

##### Format:
**Format:**
`addqn qn/QUESTION`

`addQn TUTORIAL_GROUP LESSON_NUMBER QUESTION_DESCRIPTION`
**Example:**
When teaching group `G04` lesson `1-2`, a student ask a question, and you want to note it down.

##### Examples:
* `addQn G07 7-1 Could you elaborate on the marking scheme for OP1?`
* `addQn G07 7-1 What are the deadlines that students should take note of?`
To add a question to group `G04` lesson `1-2`:
1. Navigate to view group `G04` lesson `1-2` via [`viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) command.
2. Type `addqn qn/What is the deadline for the report?` into the *Command Box*.
3. Press `Enter` to execute.

Outcome:
1. The *Result Display* will show a success message.

#### 4.4.2. Delete an existing question: `delqn`
You can use this command to add a question that was asked in a tutorial lesson, so that you can address the question at the end of the lesson.

#### Viewing all questions: `questions`

View a list of all the questions from a specified tutorial group.

##### Format:
**Format:**
`delqn INDEX`

`questions TUTORIAL_GROUP LESSON_NUMBER`
**Example:**
When teaching group `G04` lesson `1-2`, you answered one of the questions and wants to delete it from the list of questions.

##### Examples:
* `questions G07 7-1`
* `questions G10 5-2`
To delete a question from group `G04` lesson `1-2`:
1. Navigate to view group `G04` lesson `1-2` via [`viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) command.
2. Type `delqn 1` into the *Command Box*.
3. Press `Enter` to execute.

Outcome:
1. The *Result Display* will show a success message.

---

#### Deleting a question: `deleteQn`
### <ins>4.5 Utility</ins>

Deletes the specific question from the list of questions of a specified tutorial group.
#### 4.5.2. View an existing tutorial lesson: `viewlsn`
You can use this command to view the attendance, participation scores and questions of an existing tutorial group. You will also be able to execute tutorial lesson-related commands.

##### Format:
**Format:**
`viewlsn grp/GROUP lsn/LESSON`

`deleteQn TUTORIAL_GROUP LESSON_NUMBER INDEX`
* Deletes the question at the specified `INDEX`.
* The index refers to the index number shown in the displayed question list.
* The index **must be a positive integer** 1, 2, 3, …​
**Example:**
Suppose you would like to view the details for tutorial group `G04`'s lesson `1-2`. You can perform the following steps.

##### Examples:
* `deleteQn G07 7-1 1`
* `deleteQn G10 5-2 3`
To view tutorial group `G04`'s lesson `1-2`:
1. Type `viewlsn grp/G04 lsn/1-2` into the *Command Box*.
2. Press `Enter` to execute.

Outcome:
1. The *Result Display* will show a success message.
2. The *Data Display* will update and display the students' information for tutorial group `G04`'s lesson `1-2`.


#### Marking a question as answered: `ansQn`

Marks the specified question from the list of questions of a specified tutorial group as answered.

##### Format:

`ansQn TUTORIAL_GROUP LESSON_NUMBER INDEX`
* Marks the question at the specified `INDEX` as answered.
* The index refers to the index number shown in the displayed question list.
* The index **must be a positive integer** 1, 2, 3, …​

##### Examples:
* `ansQn G07 7-1 1`
* `ansQn G10 5-2 3`

Outcome:
![Figure X. Outcome of a successful `viewlsn` command](#)

--------------------------------------------------------------------------------------------------------------------

Expand Down

0 comments on commit bc1728b

Please sign in to comment.