[CS2113-F15-1] Player2113 #55
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Manifest-Version: 1.0 | ||
| Main-Class: seedu.duke.Player2113 | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,41 @@ | ||
| # Player2113 | ||
|
|
||
| A CLI tool to help COMP2113 student revise conceptual questions in a gamification environment. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Prerequisites: JDK 11, Player2113 release `JDK` file | ||
|
|
||
| Start the programme with the following command: | ||
|
|
||
| ``` | ||
| java --jar Player2113.jar | ||
| ``` | ||
|
|
||
| You will see the welcome screen upon successful start-up: | ||
|
|
||
| ``` | ||
| Hello from | ||
| ______ _ _____ __ __ _____ | ||
| | ___ \ | / __ \/ | / | |____ | | ||
| | |_/ / | __ _ _ _ ___ _ __`' / /'`| | `| | / / | ||
| | __/| |/ _` | | | |/ _ \ '__| / / | | | | \ \ | ||
| | | | | (_| | |_| | __/ | ./ /____| |__| |_.___/ / | ||
| \_| |_|\__,_|\__, |\___|_| \_____/\___/\___/\____/ | ||
| __/ | | ||
| |___/ | ||
| What is your name? | ||
| ``` | ||
| ## Usage | ||
|
|
||
| > [!IMPORTANT] | ||
| > The current release of Player2113 is a MVP preview version with various proposed functions unimplemented. Please strictly follow this user's guide. | ||
|
|
||
| ## Command Summary | ||
|
|
||
| * help `help` | ||
| * Start game `topic TOPIC_NUM` eg `topic 1` | ||
| * Show Results `results [details] [TOPIC_NUM]` eg results details 2 | ||
| * Show Solution `solution TOPIC_NUM [QUESTION_NUM]` eg solution 1 1 | ||
| * Show Explanation `explain TOPIC_NUM [QUESTION_NUM]` eg explain 1 1 | ||
| * Exit `bye` |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| # About us | ||
|
|
||
| Display | Name | Github Profile | Portfolio | ||
| --------|:--------:|:----------------------------------------:|:---------: | ||
|  | Yuheng | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md) | ||
|  | Songyue Wang | [Github](https://github.com/songyuew) | [Portfolio](https://cidlab.ok.ubc.ca/developing-digital-passports-interface-in-bim-for-future-reuse-of-construction-materials/) | ||
|  | Jason Chan | [Github](https://github.com/cyhjason29) | [Portfolio](docs/team/jasonchan.md) | ||
|  | Hong Yi Jie | [Github](https://github.com/hongyijie06) | [Portfolio](docs/team/hongyijie06.md) | ||
|  | Sean Ng | [Github](https://github.com/NGXZS) | [Portfolio](docs/team/seanng.md) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,176 @@ | ||
| # Developer Guide | ||
|
|
||
| ## Design & implementation | ||
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
|
|
||
|
|
||
| ### Results feature | ||
|
|
||
| The results feature is facilitated by `ResultsList` and | ||
| `AnswerTracker`. Both are used to display the results for | ||
| all question sets attempted by the user, including details | ||
| such as specific questions and their respective answer inputs | ||
| from the user. | ||
|
|
||
| Given below is an example usage scenario and how the results | ||
| mechanism behaves at each step. | ||
|
|
||
| Step 1. The user launches the application for the first time, | ||
| and proceeds to start a game with their chosen topic. | ||
|
|
||
| The following sequence diagram shows how the `Results` for | ||
|
There was a problem hiding this comment. Hi, the method calling solid line arrow for "new Results()" seems to not be pointing to the start of the activation bar. |
||
| one question set is added to the `ResultsList`: | ||
|  | ||
|
There was a problem hiding this comment. 
I like the use of ref block to make the sequence diagram more concise and readable.
Good use of different color to differentiate Logic and Result👍
There was a problem hiding this comment.
Good use of ref block to help improve readability! There was a problem hiding this comment.
Wouldn't it be better to use opt block instead of alt block as there is only one path? There was a problem hiding this comment. Activation bar might not have been terminated correctly. Missing the border line at the bottom!
There was a problem hiding this comment. See if you can get reference frames to be opaque.
Recall the textbook's notation on reference frames. This is a repeated issue for all your sequence diagrams
|
||
| > **Note:** The lifeline for Parser and Results should end | ||
|
There was a problem hiding this comment. 
Perhaps add an object to indicate who invoked `printChosenTopic` method would make the diagram more clear.
There was a problem hiding this comment. Perhaps add the explanation of the |
||
| > at the destroy marker (X) but due to a limitation of PlantUML, | ||
| > the lifeline reaches the end of the diagram. | ||
|
Comment on lines
+58
to
+60
There was a problem hiding this comment. It should be possible to remove the bubbles at the bottom with some tinkering of PlantUML if I am not wrong. Alternatively, you may also crop the image. |
||
|
|
||
| Similarly, the following sequence diagram shows how the | ||
| `AnswerTracker` stores all the user answer inputs: | ||
|  | ||
|
There was a problem hiding this comment. I think the photo is not loaded correctly on the DG site |
||
|
|
||
| Step 2. The user may repeat Step 1 with other question sets. | ||
|
|
||
| The sequence diagram for this step involving `ResultsList` | ||
| and `AnswerTracker` are the same as the ones shown in Step 1. | ||
|
|
||
| Step 3. The user now wants to view their results by executing | ||
| the `results` command. | ||
|  | ||
|
There was a problem hiding this comment. Photo not loaded for this as well |
||
|
|
||
| > **Note:** If the user uses the results feature before | ||
| > attempting any questions, the application will instead | ||
| > return an error to the user indicating that there are no | ||
| > results. | ||
|
|
||
|
|
||
| ### Topics Feature | ||
|
|
||
| The topics feature comprises `TopicList` and `QuestionListByTopic`. | ||
| `TopicList` is the list of topics for the users to attempt. | ||
| `QuestionListByTopic` stores the respective question set for each topic in an ArrayList. | ||
|
|
||
| Given below is an example usage scenario and how the results | ||
| mechanism behaves at each step. | ||
|
|
||
| Step 1. The user launches the application for the first time, | ||
| and proceeds to start a game with their chosen topic. | ||
|
|
||
| The following shows the class diagram for `topicList`: | ||
|
There was a problem hiding this comment. Perhaps add a line separator here to make the class diagram occupy a dedicated space would allow the format to be more readable. |
||
|  | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. class may need to add + and - to show public and private? There was a problem hiding this comment.
There was a problem hiding this comment. Class diagram for topicList should not have the C icon present, as I don't think it follows the standards stated. There was a problem hiding this comment. Missing of indication of private and public methods/ variables with "+/-" etc There was a problem hiding this comment.
There was a problem hiding this comment. Most of your peers have identified the bigger issues of the diagram, like the class circle and the access modifiers. |
||
|
|
||
| Step 2. A question from the question set of the chosen topic is displayed. | ||
| The user inputs their answer. | ||
|
|
||
| Step 3. Step 2 repeats until all the questions in the question set has been asked. | ||
| Step 1 executes and process repeats. | ||
|
|
||
| The following shows the class diagram for `QuestionListByTopic`: | ||
|  | ||
|
|
||
| ### Solution feature | ||
|
|
||
| The solution feature either prints the solution to 1 question or all questions in 1 topic. | ||
|
|
||
| The solution feature is facilitated by `Parser#processSolutionCommand`, which is called by `Parser#parseCommand` | ||
|
|
||
| > **OVERVIEW:** | ||
| >  | ||
|
There was a problem hiding this comment. after calling the methods, i think you may need to add return arrow, even if void? There was a problem hiding this comment. some method invocation got no name, maybe need to add the method name on it, instead of putting it on the return arrow? There was a problem hiding this comment.
There was a problem hiding this comment. The sequence diagram has many parts and may be slightly hard to understand initially, it would be good if you could break it down into parts when explaining, means showing just small sections of the sequence diagram There was a problem hiding this comment. Consider removing getters and setters as their functions are quite obvious There was a problem hiding this comment.
Have you maybe forgot to add [else] int the alt block? |
||
|
|
||
| > > **Note:** The lifeline for Parser and Results should end | ||
|
There was a problem hiding this comment. Might be intentional, but the double quote makes the rendering seem buggy (space between 'overview' and the note.
|
||
| > at the destroy marker (X) but due to a limitation of PlantUML, | ||
| > the lifeline reaches the end of the diagram. | ||
|
|
||
| Step 1: After user runs the program and keys in the user command, the command will be passed to | ||
| `Parser#parseCommand`. | ||
|
|
||
| > **NOTE:** The command must contain the `solution` keyword. | ||
|
|
||
| Step 2a: `Parser#processSolutionCommand` first checks the number of parameters in the user command | ||
| by calling `Parser#checkIfTwoParameters`. | ||
| The, further processing of parameters is done by calling `Parser#getTopicOrQuestionNum`. | ||
| This is facilitated by calling `QuestionsListByTopic#getQuestionSet` to get all questions in the specified topic. | ||
|
|
||
| Step 2b: Before getting the solution(s), the program first verifies if the topic has been attempted before. | ||
| The program only prints them only if the topic is attempted before. | ||
| The topic is selected by calling `TopicList#get` and `TopicList#hasAttempted` returns the attempted status. | ||
|
|
||
| Step 3: | ||
| Depending on the number of parameters, | ||
| if there is 1 parameter (ie get all solutions): | ||
| `QuestionsList#getAllSolutions` will get all solutions and `ui#printAllSolutions` will print them. | ||
| else if there are 2 parameters (ie get one solution): | ||
| `QuestionsList#getOneSolution` will get the specified solution and `ui#printOneSolution` will print it. | ||
|
|
||
| ### Explain feature | ||
| The explain feature either prints the explanation to 1 question or all questions in 1 topic. | ||
|
|
||
| The explain feature is facilitated by `Parser#processExplanationCommand`, which is called by `Parser#parseCommand` | ||
|
|
||
|
There was a problem hiding this comment. Perhaps add some diagram here would allow better understanding of developers? |
||
| Step 1: After user runs the program and keys in the user command, the command will be passed to | ||
| `Parser#parseCommand`. | ||
|
|
||
| > **NOTE:** The command must contain the `explain` keyword. | ||
| > | ||
| > Sequence diagram for `explain` is similar to the [sequence diagram](#solution-feature) for `solution` feature | ||
|
|
||
| Step 2a: `Parser#processExplainCommand` first checks the number of parameters in the user command | ||
| by calling `Parser#checkIfTwoParameters`. | ||
| The, further processing of parameters is done by calling `Parser#getTopicOrQuestionNum`. | ||
| This is facilitated by calling `QuestionsListByTopic#getQuestionSet` to get all questions in the specified topic. | ||
|
There was a problem hiding this comment. maybe you could swap 2b and 2a since 2a is more related to step 3 |
||
|
|
||
| Step 2b: Before getting the explanation(s), the program first verifies if the topic has been attempted before. | ||
| The program only prints them only if the topic is attempted before. | ||
| The topic is selected by calling `TopicList#get` and `TopicList#hasAttempted` returns the attempted status. | ||
|
|
||
| Step 3: | ||
| Depending on the number of parameters, | ||
| if there is 1 parameter (ie get all explanations): | ||
| `QuestionsList#getAllExplanations` will get all explanations and `ui#printAllExplanations` will print them. | ||
| else if there are 2 parameters (ie get one explanation): | ||
| `QuestionsList#getOneExplanation` will get the specified explanation and `ui#printOneExplanation` will print it. | ||
|
|
||
|
|
||
| ## Product scope | ||
|
|
||
| ### Target user profile | ||
|
|
||
| CS2113/2103 students who wish to have an efficient tool to help them revise relevant concepts. | ||
|
|
||
| ### Value proposition | ||
|
|
||
| Integration of key notions and learning learning objectives for CS2113 course, self-adaptive testing for understanding and feedback. | ||
|
|
||
| ## User Stories | ||
|
|
||
| | Version | As a ... | I want to ... | So that I can ... | | ||
|
There was a problem hiding this comment. maybe you could categorise the user stories by priorities and include their priority into the userstories table |
||
| |---------|--------------------------------|------------------------------------------------------|------------------------------------------------------------------------| | ||
| | v1.0 | new user | see user guide in the app | refer to them if I am unfamiliar with the usage of a command | | ||
| | v1.0 | student new to Java | receive solutions with explanation after answering | be aware of the reasoning behind the correct answer | | ||
| | v2.0 | regular user | see a progress bar when answering MCQs | track my progress when attempting a question set | | ||
| | v2.0 | regular user | see a progress bar about all topics in the main menu | track my revision progress for the entire course | | ||
| | v2.0 | student going to take the exam | access timed modes in the game easily | train my thought process to quicken in preparation for tests | | ||
| | v2.0 | student new to Java | avoid memorization of specific question sets through randomly generated practice sets | I can ensure I understand the concepts rather than memorising answers | | ||
|
|
||
| ## Non-Functional Requirements | ||
|
|
||
| Usability: the user is able to use the app without reading lengthy documentations. | ||
|
|
||
| Technical: the app should run on both macOS and Windows | ||
|
|
||
| ## Glossary | ||
|
|
||
|
|
||
| - _glossary item_ - Definition | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| ### Libraries | ||
|
|
||
| 1. Display formatted tables in the CLI - [ASCII TABLES](https://bethecoder.com/applications/products/asciiTable.action) | ||
|
There was a problem hiding this comment. good that you included your references :) |
||
|
|
||
| 2. Topic selection menu and testing mode progress bar - [ProgressBar](https://github.com/ctongfei/progressbar) | ||
|
|
||
| ### References | ||
|
There was a problem hiding this comment. Maybe remove references if there is nothing to add here |
||
|
|
||
| ## Instructions for manual testing | ||
|
There was a problem hiding this comment. Please include details about manual testing here |
||
|
|
||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding in a table of contents, similar to the reference Address Book DG