[CS2103-F10-3] CS2103/T Revision Tool #97

khiangleon · 2019-09-27T15:08:19Z

@wilfredbtan @jxofficial @neoshh @ShaunNgTX

shuiyao-sg · 2019-10-04T03:51:29Z

docs/DeveloperGuide.adoc

+|`*` |lonely CS2103 student |have someone to talk to, even if it’s a computer |I won't feel lonely
+
+|`*` |CS2103 student who keeps having stomach ache |the application to tell me where the nearest toilet is |go and shit
+|=======================================================================

 [appendix]
 == Use Cases


Did you forget to update the Use Cases?

ShirleyWangxt

In general, the diagrams have used intuitive symbols. The description given is understandable and sufficiently high-level. Diagrams are not cluttered with too many unnecessary details. The document uses multiple types of diagrams and they are well-integrated into the description. There are some details to be fixed, but the document looks neat, well-formatted, and professional overall.

ShirleyWangxt · 2019-10-04T03:45:32Z

docs/DeveloperGuide.adoc

@@ -295,20 +267,64 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 [width="59%",cols="22%,<23%,<25%,<30%",options="header",]
 |=======================================================================
 |Priority |As a ... |I want to ... |So that I can...
-|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App


The user stories are correctly formatted. All three parts are present.

ShirleyWangxt · 2019-10-04T03:49:13Z

docs/DeveloperGuide.adoc

+
+|`* * *` |CS2103 student with a lot of things on my mind |mark certain questions that I am unsure of |refer back to the question when I am free.
+
+|`* * *` |CS2103 student |import questions from my peers |study on my own.


The benefit does not match the function. It would be better if the benefit is more specific, such as the student does not need to input the questions himself/herself.

ShirleyWangxt · 2019-10-04T03:50:02Z

docs/DeveloperGuide.adoc

+
+|`* * *` |conscientious CS2103 student |export the questions I am unsure of |raise them up during tutorials.
+
+|`* * *` |indecisive student |be recommended questions instead of me having to plan my own study plan |go directly to studying


The benefit is a bit unclear. Hard to see how it matches the function.

ShirleyWangxt · 2019-10-04T03:51:59Z

docs/DeveloperGuide.adoc

+
+|`* *` |competitive CS2103 student |at least know where I stand among my cohort |look at who is the next person I can beat.
+
+|`* *` |gamer CS2103/T student |accomplish tasks that give me a sense of achievement, preferably through in application rewards |I feel good.


The benefit can be more specific like I can more motivated to accomplish more tasks.

ShirleyWangxt · 2019-10-04T03:56:18Z

docs/DeveloperGuide.adoc

 * can type fast
 * prefers typing over mouse input
 * is reasonably comfortable using CLI apps

-*Value proposition*: manage contacts faster than a typical mouse/GUI driven app
+*Value proposition*: helps student to ace CS2103/T

 [appendix]
 == User Stories


Some of the user stories might be a little irrelevant to this app.

ShirleyWangxt · 2019-10-25T03:36:43Z

docs/DeveloperGuide.adoc


-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `Group F10-3`      Since: `Aug 2019`      Licence: `MIT`

 == Setting up



For Figure 2 Class Diagram of the Logic Component, it would be better if the classes and arrows and the different sections can be color-coded to make it easier for visualisation.

ShirleyWangxt · 2019-10-25T03:42:08Z

docs/DeveloperGuide.adoc

@@ -98,9 +98,9 @@ image::LogicClassDiagram.png[]
 *API* :


For Figure 3. Component interactions for delete 1 command, the arrow seems to overlap with the activation bar.

For the self-invocation part, it might be better if the line in the middle can be covered.

irene-lly

Overall good job, the diagrams are neat and easy to understand, the document is also pretty well-formatted.

irene-lly · 2019-10-25T03:24:29Z

docs/DeveloperGuide.adoc

-* stores the Address Book data.
-* exposes an unmodifiable `ObservableList<Person>` that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.
+* stores a `Question Bank` object that represents the Question Bank.
+* stores the Test Bank data.


A markup can be used here i.e. Test Bank

irene-lly · 2019-10-25T03:44:09Z

docs/DeveloperGuide.adoc

@@ -121,13 +121,13 @@ image::ModelClassDiagram.png[]



If QuestionList implements ReadOnlyQuestionList then ReadOnlyQuestionList should be an abstract class or an interface.

Auxinnn · 2019-10-25T03:26:32Z

docs/DeveloperGuide.adoc

+* **Alternative 1 (current choice):** Read and parse the command to execute it
 ** Pros: Easy to implement.
 ** Cons: May have performance issues in terms of memory usage.


Maybe it is better to come up with an alternative 2 implementation for comparison?

xinmingzh · 2019-10-25T04:27:40Z

docs/DeveloperGuide.adoc


-Step 1. The user launches the application for the first time. The `VersionedAddressBook` will be initialized with the initial address book state, and the `currentStatePointer` pointing to that single address book state.
+Step 1. The user types `add mcq q/"string of question" x/option1 x/option2 y/option3 x/option4 cat/[UML] diff/[easy]`, this command adds a easy difficulty mcq question about UML with 4 options and option3 being the correct answer.

 image::UndoRedoState0.png[]


The diagrams seems not up to date. Does it match your description?

xinmingzh · 2019-10-25T04:28:14Z

docs/DeveloperGuide.adoc

-If the `currentStatePointer` is at index 0, pointing to the initial address book state, then there are no previous address book states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the undo.
-
-The following sequence diagram shows how the undo operation works:
+The following sequence diagram shows how the add question operation works:

 image::UndoSequenceDiagram.png[]

 NOTE: The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.


Not updated.

xinmingzh · 2019-10-25T04:29:51Z

docs/DeveloperGuide.adoc


-* **Alternative 1 (current choice):** Saves the entire address book.
+* **Alternative 1 (current choice):** Read and parse the command to execute it


Any alternatives to your current choice?

Is it possible to be more specific when describing the pros and cons?

Documentation for Statistics and Notes

Merged Shaun, Sihao. Partial merge of Junxian's Timer and CustomMode. Updated UI as well.

…into AutoComplete-feature # Conflicts: # docs/UserGuide.adoc # src/main/java/seedu/revision/logic/commands/main/StartQuizCommand.java

…into branch-timer

Implement Custom Mode v1.0

Resolve bug in ArcadeMode

…into AutoComplete-feature

…into branch-status * 'master' of https://github.com/AY1920S1-CS2103-F10-3/main: (30 commits) pass checkstyle enable ui to change between mcq, saq, truefalse minor ui updates added SaqAnswersGridPane to initialise an empty pane for Saq pass checkstyle clean up SampleDataUtil set Answer word limit and update SampleDataUtil resolved some travis issues add Custom Mode Edit StartQuizCommandParser to parse predicates update UserGuide, add customisable timer, extend Mode for NormalMode - Refactor CustomMode to factory to accomodate optional values for timer, category and difficulty Add CustomMode.java added javadoc for answerchecker class update saq AnswerChecker to check for numbers in number format and word format Shift order of code in startQuizWindow#executeCommand 1. update bar 2. check if next question is next stage, if yes, confirmation message then create new timer and bar if no, reset timer 3. update the question options and question text update QuizCommandParser to parse Saq input Fix progress bar to show 8/8 Fix popup window displaying when user inputs command Todo: popup when timer reaches 0 for last question of level Make timer stop after every command in StartQuizWindow#executeCommand ... # Conflicts: # src/main/java/seedu/revision/ui/StartQuizWindow.java

…into branch-status * 'master' of https://github.com/AY1920S1-CS2103-F10-3/main: Resolve bug in ArcadeMode Implement custom mode v1.0 # Conflicts: # src/main/java/seedu/revision/logic/commands/main/CommandResult.java

…into pull-custom

Update ppp and add use cases

* master: update use case, copy UG DG into PPP add newline at EOF Update PPP Update autocomplete to remove double enter Resolve Wifred's comments on PR#162 Updated DG appendix fix find bug where '?' character is considered a word update sequence diagrams for delete and quiz Update DG for restore and autocomplete update UG, DG, add design considerations and implementation details of Configuration and Quiz Mode improve code quality but renaming variables reorganising methods Implement SaqInputCommandParserTest Resolve issue #114 Implement SaqTest Implement 6 passing tests for TrueFalseTest - Implement McqInputCommandTest Implement failing SaqInputCommandTest Implement TrueFalseInputCommandTest Resolve bug where t/f input commands not being marked as case insensitive # Conflicts: RESOLVED # docs/DeveloperGuide.adoc

Updated DG, UG, sihao's PPP

…into branch-dg-ug

Final ppp dg ug jx

updated PPP to within 10 pages

Ppp

…into branch-charts * 'master' of https://github.com/AY1920S1-CS2103-F10-3/main: (28 commits) resolved travis build issues Final PPP, DG, UG updated PPP updated sihao's PPP updated user guide updated dev guide update use case, copy UG DG into PPP Updated dev guide add newline at EOF Update PPP added Saq AnswerChecker activity diagram to DG Update autocomplete to remove double enter Added Saq isCorrect sequence diagram to DG Resolve Wifred's comments on PR#162 Updated DG appendix fix find bug where '?' character is considered a word Updated developer guide with SaqAnswerChecker class diagram update sequence diagrams for delete and quiz Update DG for restore and autocomplete Add Ui overview in DG ... # Conflicts: # docs/AboutUs.adoc # docs/DeveloperGuide.adoc # src/main/java/seedu/revision/ui/StartQuizWindow.java

DG, UG, PPP

…into revert-to-manual

Revert tests

push latest

updated about us to link profiles to correct PPP

khiangleon closed this Sep 27, 2019

khiangleon reopened this Sep 27, 2019

nus-se-pr-bot added team.3 tutorial.CS2103-F10 tutor.kthSim labels Sep 27, 2019

shuiyao-sg reviewed Oct 4, 2019

View reviewed changes

ShirleyWangxt reviewed Oct 25, 2019

View reviewed changes

irene-lly reviewed Oct 25, 2019

View reviewed changes

Auxinnn reviewed Oct 25, 2019

View reviewed changes

xinmingzh reviewed Oct 25, 2019

View reviewed changes

alages97 pushed a commit to alages97/main that referenced this pull request Oct 27, 2019

Merge pull request nus-cs2103-AY1920S1#97 from jeongyh99/master

96b46b6

Documentation for Statistics and Notes

wilfredbtan and others added 19 commits October 31, 2019 22:43

pass checkstyle

7b54fff

Implement custom mode v1.0

5763026

Merge pull request #98 from wilfredbtan/master

985a9e8

Merged Shaun, Sihao. Partial merge of Junxian's Timer and CustomMode. Updated UI as well.

Edit helpCommand URL

391fd70

Merge branch 'master' of https://github.com/AY1920S1-CS2103-F10-3/main …

d5ed828

…into AutoComplete-feature # Conflicts: # docs/UserGuide.adoc # src/main/java/seedu/revision/logic/commands/main/StartQuizCommand.java

Merge branch 'master' of https://github.com/AY1920S1-CS2103-F10-3/main …

f17bf18

…into branch-timer

Update history and stats functionalities

6090698

Merge pull request #99 from jxofficial/branch-timer

e0ebce6

Implement Custom Mode v1.0

Resolve bug in ArcadeMode

08136bb

Merge pull request #101 from jxofficial/branch-timer

e87639b

Resolve bug in ArcadeMode

Merge branch 'master' of https://github.com/AY1920S1-CS2103-F10-3/main …

3e17ef6

…into AutoComplete-feature

Troubleshooting stats and history commands

c7f7a86

update ui

279a6ab

Merge branch 'master' of https://github.com/AY1920S1-CS2103-F10-3/main …

4c3c35c

…into pull-custom

update user guide with quiz mode

52355a5

add autocomplete to user guide

56a5d16

add EOF

ef2db8f

neoshh and others added 30 commits November 11, 2019 21:11

updated dev guide

572778c

Merge pull request #173 from wilfredbtan/update-PPP

f153709

Update ppp and add use cases

add manual test case

ac19b87

updated user guide

91912da

updated sihao's PPP

2c04a89

updated PPP

e58b8ed

Final PPP, DG, UG

34c9d4f

resolved travis build issues

70eabf9

Merge pull request #175 from neoshh/branch-ppp,-ug,-dg

b5520a5

Updated DG, UG, sihao's PPP

Temp Commit

dad10ba

Merge branch 'master' of https://github.com/AY1920S1-CS2103-F10-3/main …

2242f7f

…into branch-dg-ug

Merge pull request #176 from jxofficial/branch-dg-ug

c556f99

Final ppp dg ug jx

Test for parser

e9d7eea

Merge https://github.com/AY1920S1-CS2103-F10-3/main into PPP

b7ca766

Update DG, UG and PPP

ce10242

updated PPP to within 10 pages

3ee2a21

Update ppp

b36f032

Merge pull request #178 from neoshh/branch-ppp,-ug,-dg

aff22d0

updated PPP to within 10 pages

Merge pull request #177 from ShaunNgTX/PPP

ebf0714

Ppp

Merge pull request #179 from khiangleon/branch-charts

85c5ba0

DG, UG, PPP

Merge branch 'master' of https://github.com/AY1920S1-CS2103-F10-3/main …

577ab19

…into revert-to-manual

omit coveralls

7cd6b2e

Merge pull request #180 from wilfredbtan/revert-to-manual

db9031a

Revert tests

push latest

77c5f50

Merge pull request #181 from wilfredbtan/pull-master

ff69963

push latest

updated about us to link profiles to correct PPP

428d3d0

Merge https://github.com/AY1920S1-CS2103-F10-3/main

7f32ec1

Merge pull request #184 from neoshh/master

ced6263

updated about us to link profiles to correct PPP

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2103-F10-3] CS2103/T Revision Tool #97

[CS2103-F10-3] CS2103/T Revision Tool #97

khiangleon commented Sep 27, 2019 •

edited

Loading

shuiyao-sg Oct 4, 2019

ShirleyWangxt left a comment

ShirleyWangxt Oct 4, 2019

ShirleyWangxt Oct 4, 2019

ShirleyWangxt Oct 4, 2019

ShirleyWangxt Oct 4, 2019

ShirleyWangxt Oct 4, 2019

ShirleyWangxt Oct 25, 2019

ShirleyWangxt Oct 25, 2019

irene-lly left a comment •

edited

Loading

irene-lly Oct 25, 2019

irene-lly Oct 25, 2019

Auxinnn Oct 25, 2019

xinmingzh Oct 25, 2019

xinmingzh Oct 25, 2019

xinmingzh Oct 25, 2019

xinmingzh Oct 25, 2019


		\|`* * *` \|CS2103 student with a lot of things on my mind \|mark certain questions that I am unsure of \|refer back to the question when I am free.

		\|`* * *` \|CS2103 student \|import questions from my peers \|study on my own.


		\|`* * *` \|conscientious CS2103 student \|export the questions I am unsure of \|raise them up during tutorials.

		\|`* * *` \|indecisive student \|be recommended questions instead of me having to plan my own study plan \|go directly to studying


		\|`* *` \|competitive CS2103 student \|at least know where I stand among my cohort \|look at who is the next person I can beat.

		\|`* *` \|gamer CS2103/T student \|accomplish tasks that give me a sense of achievement, preferably through in application rewards \|I feel good.


		* Alternative 1 (current choice): Saves the entire address book.
		* Alternative 1 (current choice): Read and parse the command to execute it

[CS2103-F10-3] CS2103/T Revision Tool #97

Are you sure you want to change the base?

[CS2103-F10-3] CS2103/T Revision Tool #97

Conversation

khiangleon commented Sep 27, 2019 • edited Loading

Choose a reason for hiding this comment

ShirleyWangxt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

irene-lly left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khiangleon commented Sep 27, 2019 •

edited

Loading

irene-lly left a comment •

edited

Loading