-
Notifications
You must be signed in to change notification settings - Fork 411
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[CS2103T-T11-2] Dukemon #102
base: master
Are you sure you want to change the base?
[CS2103T-T11-2] Dukemon #102
Conversation
|
||
|`* * *` |user |see the content of the word bank |study beforehand/make changes | ||
|
||
|`* * *` |young student |trivia questions to be gamified |enjoy the process |
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.
Perhaps you should write a more specific benefit instead of "enjoy the process"
|
||
|`* * *` |user |delete word banks |free up some memory when I don’t need it anymore | ||
|
||
|`* * *` |user |see the content of the word bank |study beforehand/make changes |
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.
May need to rephrase this use case. Can't really understand how the benefit relates to the "I want to..."
|
||
|`* *` |studious student |set and complete goals |have something to work towards | ||
|
||
|`* *` |student |see my test statistics |track my progress/improvement |
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.
Nice use case!
docs/DeveloperGuide.adoc
Outdated
. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. | ||
. Users can export and import their <<word-bank,word banks>> or statistics. |
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.
This is a functional requirement
|
||
|`* *` |student |share and compare my results with my classmates |know where I stand | ||
|
||
|`* *` |student |partition the trivia |attempt questions that I'm comfortable with |
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 rephrasing "partition the trivia" to "sort according to difficulty" etc..
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.
Good job, your project seems very interesting!
Please look at the comments my team made regarding user stories and non-functional requirements
Holds the data of live game sessions in-memory. | ||
* <<Design-Storage,*`Storage`*>>: + | ||
Reads data from, and writes data to, the local hard disk. | ||
|
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.
Good introduction to your main components, easy to understand.
@@ -12,7 +12,7 @@ ifdef::env-github[] | |||
:note-caption: :information_source: | |||
:warning-caption: :warning: | |||
endif::[] | |||
:repoURL: https://github.com/se-edu/addressbook-level3/tree/master | |||
:repoURL: https://github.com/AY1920S1-CS2103T-T11-2/main |
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.
can change the header title!
docs/DeveloperGuide.adoc
Outdated
|
||
image::UndoRedoState1.png[] | ||
|
||
Step 3. The user executes `add n/David ...` to add a new person. The `add` command also calls `Model#commitAddressBook()`, causing another modified address book state to be saved into the `addressBookStateList`. | ||
Step 3. The user executes `stop` to abruptly end the game. The `add` command also calls `Model#commitAddressBook()`, causing another modified address book state to be saved into the `addressBookStateList`. |
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.
very clear explanation, well done!
@@ -131,6 +150,20 @@ As a more OOP model, we can store a `Tag` list in `Address Book`, which `Person` | |||
+ | |||
image:BetterModelClassDiagram.png[] | |||
|
|||
[[Design-Game]] | |||
=== Game component | |||
|
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.
Very good, very impressive
Class HiddenOutside #FFFFFF | ||
HiddenOutside ..> Game | ||
HiddenOutside ..> Guess | ||
Game -- ReadOnlyWordBank :.clone() Cards from > |
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.
i do not think the .clone()
should be in the UML diagram
docs/DeveloperGuide.adoc
Outdated
|
||
image::UndoRedoState0.png[] | ||
|
||
Step 2. The user executes `delete 5` command to delete the 5th person in the address book. The `delete` command calls `Model#commitAddressBook()`, causing the modified state of the address book after the `delete 5` command executes to be saved in the `addressBookStateList`, and the `currentStatePointer` is shifted to the newly inserted address book state. | ||
Step 2. The user enters `start difficult` command to begin the game. The `LogicManager` passes string to `Model#commitAddressBook()`, causing the modified state of the address book after the `delete 5` command executes to be saved in the `addressBookStateList`, and the `currentStatePointer` is shifted to the newly inserted address book state. | ||
|
||
image::UndoRedoState1.png[] |
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.
The diagrams do not fit the descriptions.
|
||
|
||
.Structure of the Game Component | ||
image::GameClassDiagram.png[] |
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.
added more pictures and cleaned up the bullet pointing
Updated UG - Command Summary
… into chenhui-2-codeQuality # Conflicts: # docs/UserGuide.adoc
…lity Chenhui 2 code quality
Upon start, sample data will be automatically created, but will not automatically create itself again after it has been removed by user.
… into chenhui-2-codeQuality
… into subbash-29-finalCodeUpdate
…odeUpdate Update Use cases
… into jason-2-ppp
Update PPP and some tests
… into chenhui-3-UGDG
Chenhui 3 ugdg
Italicise some words
… into subbash-29-finalCodeUpdate
Subbash 29 final code update
Added Page Breaks for UG
Final formatting edits for DG
… into chenhui-3-UGDG
Chenhui 3 ugdg
Fix PPP adoc and pdf
@kohyida1997 @chrischenhui @dragontho @jascxx