Skip to content

Commit bc1728b

Browse files
authored
Merge pull request nus-cs2103-AY2021S1#107 from Nijnxw/branch-v1.3-ug-questions
Update UG - Questions
2 parents a2386c2 + eefdbbf commit bc1728b

File tree

1 file changed

+45
-51
lines changed

1 file changed

+45
-51
lines changed

docs/UserGuide.md

Lines changed: 45 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ By: `Team Serenity` Since: `Aug 2020`
3636

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

39-
4.4 [Addressing Questions](#addressing-questions)
39+
4.4. [Question Addressing](#ins44-question-addressingins)
40+
41+
4.4.1. [Adding a question: `addQn`](#441-add-a-new-question-addqn)
4042

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

43-
* [Viewing all questions: `questions`](#viewing-all-questions-list)
44-
45-
* [Deleting a question: `deleteQn`](#deleting-a-question-deleteqn)
46-
47-
* [Marking a question as answered: `ansQn`](#marking-a-question-as-answered-ansqn)
45+
4.5. [Utility](#ins45-utilityins)
46+
47+
4.5.2. [View an existing tutorial lesson: `viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn)
4848

4949
5. [FAQ](#faq)
5050

@@ -290,72 +290,66 @@ Outcome:
290290

291291
---
292292

293-
### <ins>Addressing Questions</ins>
293+
### <ins>4.4. Question Addressing</ins>
294294

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

297-
Adds a question to the list of questions of a specified tutorial group.
297+
#### 4.4.1. Add a new question: `addqn`
298+
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.
298299

299-
##### Format:
300+
**Format:**
301+
`addqn qn/QUESTION`
300302

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

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

307311
Outcome:
312+
1. The *Result Display* will show a success message.
308313

314+
#### 4.4.2. Delete an existing question: `delqn`
315+
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.
309316

310-
#### Viewing all questions: `questions`
311-
312-
View a list of all the questions from a specified tutorial group.
313-
314-
##### Format:
317+
**Format:**
318+
`delqn INDEX`
315319

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

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

322328
Outcome:
329+
1. The *Result Display* will show a success message.
323330

331+
---
324332

325-
#### Deleting a question: `deleteQn`
333+
### <ins>4.5 Utility</ins>
326334

327-
Deletes the specific question from the list of questions of a specified tutorial group.
335+
#### 4.5.2. View an existing tutorial lesson: `viewlsn`
336+
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.
328337

329-
##### Format:
338+
**Format:**
339+
`viewlsn grp/GROUP lsn/LESSON`
330340

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

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

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

342-
343-
#### Marking a question as answered: `ansQn`
344-
345-
Marks the specified question from the list of questions of a specified tutorial group as answered.
346-
347-
##### Format:
348-
349-
`ansQn TUTORIAL_GROUP LESSON_NUMBER INDEX`
350-
* Marks the question at the specified `INDEX` as answered.
351-
* The index refers to the index number shown in the displayed question list.
352-
* The index **must be a positive integer** 1, 2, 3, …​
353-
354-
##### Examples:
355-
* `ansQn G07 7-1 1`
356-
* `ansQn G10 5-2 3`
357-
358-
Outcome:
352+
![Figure X. Outcome of a successful `viewlsn` command](#)
359353

360354
--------------------------------------------------------------------------------------------------------------------
361355

0 commit comments

Comments
 (0)