Skip to content

Latest commit

 

History

History
259 lines (178 loc) · 8.4 KB

UserGuide.adoc

File metadata and controls

259 lines (178 loc) · 8.4 KB
Raw

Insert name - User Guide

By: Team F10-3 Since: Jun 2016 Licence: MIT

1. Introduction

Insert name is for those who prefer to use a desktop app for storing test banks. More importantly, Insert name is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Insert name can get your contact management tasks done faster than traditional GUI apps. Interested? Jump to the Section 2, “Quick Start” to get started. Enjoy!

2. Quick Start

  1. Ensure you have Java 11 or above installed in your Computer.

  2. Download the latest Insert name here.

  3. Copy the file to the folder you want to use as the home folder for your test bank.

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

    Ui

  5. Type the command in the command box and press Enter to execute it.
    e.g. typing help and pressing Enter will open the help window.

  6. Some example commands you can try:

    • list : lists all categories and difficulties for the user to choose.

    • addmcq/According to the textbook, which kind of project is more difficult? x/Greenfield x/Brownfield y/None of the above x/Padifield : adds an mcq question with x/ (as in a cross for "wrong") marking the wrong answers and y/ (as in "yes") marking the correct answers.

    • delete3 : deletes the 3rd question shown in the current list.

    • exit : exits the app.

  7. Refer to Section 3, “Features” for details of each command.

3. Features

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add mcq/QUESTION, QUESTION is a parameter which can be used as add mcq/What the recommended user story format?.

  • Items in square brackets are optional e.g mcq/QUESTION [cat/CATEGORY] can be used as mcq/What is the recommended user story format cat?/Requirements or as mcq/What is the recommended user story format?.

  • Items with …​ after them can be used multiple times including zero times e.g. [y/CORRECT_ANSWER]…​ can be used as   (i.e. 0 times), y/Greenfield, y/Brownfield etc.

  • Parameters can be in any order e.g. if the command specifies mcq/QUESTION cat/CATEGORY, cat/CATEGORY mcq/QUESTION is also acceptable.

3.1. Viewing help : help

Format: help

3.2. Starting the quiz: start.

User can start by choosing a category, difficulty or recommended bank of questions.

Format: start cat/[CATEGORY] diff/[difficulty]

💡
 If no category or difficulty is stated (i.e. start), program will start the quiz with a recommended list of questions based on categories that the user can improve on.

Examples:

  • start cat/implementation

  • start diff/2

3.3. Ending the quiz: end

User can end the quiz and go back into configuration mode to perform commands such as add, list, and status

Format: end

3.4. Check your progress: status

Displays the number of questions answered correctly by category and difficulty.

Format: status

Example:

status

Total: 290/300 questions answered correctly

Difficulty

  • Level 1: 100/100

  • Level 2: 100/100

  • Level 3: 90/100

Category

  • Requirements: 100/100

  • Design: 50/100

  • Implementation: 50/100

  • Project Management: 90/100

3.5. Adding a question: add

Adds a question to the test bank

Format: add [mcq/QUESTION] [cat/CATEGORY] [diff/DIFFICULTY] [x/WRONG_ANSWER]…​ [y/CORRECT_ANSWER]…​

Examples:

  • mcq/ According to the textbook, which kind of project is more difficult? x/Greenfield x/Brownfield y/None of the above x/Padifield

  • mcq/ What are some characteristics of well-defined requirements? y/Unambiguous x/Untestable y/Clear y/Atomic

3.6. Need improvement Editing a question : edit

Edits an existing question in the test bank.

Format: edit INDEX [mcq/QUESTION] [cat/CATEGORY] [diff/DIFFICULTY] [x/WRONG_ANSWER]…​ [y/CORRECT_ANSWER]…​

  • Edits 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, …​

  • At least one of the optional fields must be provided.

  • Existing values will be updated to the input values.

  • When editing category and/or difficulty, the existing category and/or difficulty of the question will be removed i.e adding of category and/or difficulty is not cumulative.

  • You can remove all the question’s category and/or difficulty by typing cat/ or diff/ without specifying any tags after it.

Examples:

  • edit 1 mcq/ e/[email protected]
    Edits the phone number and email address of the 1st question to be 91234567 and [email protected] respectively.

  • edit 2 n/Betsy Crower t/
    Edits the name of the 2nd question to be Betsy Crower and clears all existing tags.

3.7. Deleting a question : delete

Deletes the specified questions from the test bank.
Format: delete INDEX [MORE_INDICES]

  • Delete the question(s) at the specified `INDEX`s.

  • The index refers to the index number shown in the displayed question list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • list
    delete 2
    Deletes the 2nd question in the test bank list.

  • find Greenfield
    delete 1 3 5
    Deletes the 1st, 3rd and 5th question in the test bank list.

3.8. Listing all questions : list

Shows a list of all questions in the test back. If appended with a category and/or difficulty, Insert name will show all questions of the chosen category and/or difficulty

Format: list cat/[CATEGORY] diff/[DIFFICULTY]

Examples:

  • list cat/requirements

  • list cat/requiments diff/2

3.9. Locating questions: find

Finds questions whose descriptions contain any of the given keywords.

Format: find KEYWORD [MORE_KEYWORDS]

  • The search is case insensitive. e.g brownfield will match Brownfield

  • The order of the keywords does not matter. e.g. green field will match field green

  • Only the name is searched.

  • Only full words will be matched e.g. Requirement will not match Requirements

  • Descriptions matching at least one keyword will be returned (i.e. OR search). e.g. User story will return User Survery, User Input

Examples:

  • find User
    Returns How do you gather user requirements? and What is the recommended user story format?

  • find User, Brownfield, Greenfield
    Returns any question containing descriptions User, Brownfield, or Greenfield

3.10. Clearing all entries : clear

Clears all questions from the test bank.
Format: clear

3.11. Restoring all entries : restore

Clears all current questions from the test bank and restores the default questions that were in the original app.
Format: restore

3.12. Exiting the program : exit

Exits the program.
Format: exit

3.13. Saving the data

Test bank data are saved in the hard disk automatically after any command that changes the data.
There is no need to save manually.

3.14. Importing / Exporting test banks [coming in v2.0]

{explain how the user can import / export test banks}

4. FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Test Bank folder.

5. Command Summary

  • Help : help

  • Start `start [cat/CATEGORY] [diff/DIFFICULTY]

  • End end

  • Status : status

  • Add add [mcq/QUESTION] [cat/CATEGORY] [diff/DIFFICULTY] [x/WRONG_ANSWER]…​ [y/CORRECT_ANSWER]…​
    e.g. mcq/ What are some characteristics of well-defined requirements? y/Unambiguous x/Untestable y/Clear y/Atomic

  • Edit (To be updated) : edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​
    e.g. edit 2 n/James Lee e/[email protected]

  • Delete : delete INDEX [MORE_INDICS]
    e.g. delete 1 3 5

  • List : list

  • Find : find KEYWORD [MORE_KEYWORDS]
    e.g. find user story

  • Clear : clear

  • Restore : restore