[CS2103T-F09-4] Volant #18

raniceyue · 2020-02-17T14:11:43Z

@grrrrnt
@mikhailfaiz
@zsoh97
@vuhieunguyen

zsoh97 · 2020-02-24T16:02:17Z

Update UserGuide.adoc

kevvvinn · 2020-03-06T01:45:46Z

docs/DeveloperGuide.adoc


-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+|`* *` |frequent traveler |to be able to see a timeline view of all my short journal entries and photos, including the location and time of the photos and entries, per trip| ??


Hellooo, you might have forgotten to add some content. Might in something in v2.0

Denise-Ng · 2020-03-06T01:48:30Z

docs/DeveloperGuide.adoc

+
+|`* * *` | traveler always on the go | record short text entries recording my travels, similar to that of a Tweet on Twitter | can keep track of my activities without excessive typing
+
+|`* * *` |user |add an activity into an itinerary list |see my planned activities at a glance and better plan my trip


May want to specify "user" to a more specific target user (i.e. solo traveler, CLI enthusiast)

ChesterSim · 2020-03-06T01:49:18Z

docs/DeveloperGuide.adoc

-|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
+|`* *` |food lover |add a meal with description, photo, price and location |keep track of what I ate
+
+|`* *` |user |sort my travel entries by category depending on the ‘feeling’ tag of each travel entry |see my best moments


How do you define best moments? You could list the categories here

ChesterSim · 2020-03-06T01:50:50Z

docs/DeveloperGuide.adoc

+
+[none]
+* 1a. V detects invalid characters in trip details
+* 1a1. V outputs error informing user of invalid characters


Indentation of details of extensions (e.g. 1a1., 1a2...) should be indented

ChesterSim · 2020-03-06T01:51:45Z

docs/DeveloperGuide.adoc

+*MSS*
+
+1. User enters details of trip to be added
+2. V writes added trip into data files and displays new trip in the trip list


Use Cases should not specify what goes behind the scenes of your System (specifically adding trip into data files)

alcen · 2020-03-06T01:51:49Z

docs/DeveloperGuide.adoc

+
+|`* *` |user |sort my travel entries by category depending on the ‘feeling’ tag of each travel entry |see my best moments
+
+|`* *` |busy user |list and record items in a packing list |easily reference what I need for a trip at a glance


alcen · 2020-03-06T01:52:27Z

docs/DeveloperGuide.adoc

+**Guarantee: **Information of existing trip will be changed
+
+*MSS*
+
+1. User requests to edit trip at specified index


Might need to list the trips first (assuming user starts with a blank slate)

ChesterSim · 2020-03-06T01:53:12Z

docs/DeveloperGuide.adoc

+[discrete]
+=== UC03 - Accessing a Trip Folder
+
+*Precondition:* User is in the hope page and the trip to access exists


Typo for home page!

Denise-Ng · 2020-03-06T01:55:13Z

docs/DeveloperGuide.adoc

+
+*MSS*
+
+1. User navigates to a specific trip (UC03)


Remember to underline the inclusion of other use cases. (Following the textbook's format)

yjskrs · 2020-03-06T01:52:20Z

docs/DeveloperGuide.adoc

+|Priority |As a ... |I want to ... |So that I ca ...
+|`* * *` | frequent traveler | add a travel entry with weather, location and time metadata | document my past travels
+
+|`* * *` | traveler always on the go | record short text entries recording my travels, similar to that of a Tweet on Twitter | can keep track of my activities without excessive typing


I'm not sure what short text entries have to do with excessive typing

yjskrs · 2020-03-06T01:53:05Z

docs/DeveloperGuide.adoc

+
+|`* * *` |user |edit the entries in my itinerary list |can amend any mistakes when entering data, or change my travel plans
+
+|`* * *` |user | see a chronological timeline of the activities in the itinerary | can have a clear idea of my travel plans and schedule dur


alcen · 2020-03-06T01:57:03Z

docs/DeveloperGuide.adoc

+[none]
+1. User requests to delete a contact in the contact list at the specified index
+2. V deletes the contact at the specified index and display the new contact list
+3. Use case ends


Probably "use case ends" shouldn't be part of the list here, to standardise with previous use cases

Denise-Ng · 2020-03-06T01:58:08Z

docs/DeveloperGuide.adoc


 [appendix]
 == Non Functional Requirements

 .  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed.
-.  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
+.  Should be able to hold up to 100 trips without a noticeable sluggishness in performance for typical usage.


Can specify what is "noticeable sluggishness". e.g. no lags > 1 second

nathanaelseen

I feel that overall the docs are quite good quality, just a few minor things to note!

nathanaelseen · 2020-03-06T01:53:10Z

docs/DeveloperGuide.adoc


 [appendix]
 == Non Functional Requirements

 .  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed.
-.  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
+.  Should be able to hold up to 100 trips without a noticeable sluggishness in performance for typical usage.
 .  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.


Average typing speed not quite specific

nathanaelseen · 2020-03-06T02:18:33Z

docs/DeveloperGuide.adoc

 |=======================================================================
-|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
+|Priority |As a ... |I want to ... |So that I ca ...


(trivial: small typo for 'can')

nathanaelseen · 2020-03-06T03:13:19Z

docs/DeveloperGuide.adoc

+*MSS*
+
+1. User navigates to a specific trip (UC03)
+2. User requests to navigate to the desired page in current trip


hi! to add on, as we should alternate User and V, instead of having 2 consecutive User (rationale: use-case diagram shows user-system interaction)

alushingg · 2020-03-27T02:31:04Z

docs/DeveloperGuide.adoc

+
+The _Sequence Diagram_ below illustrates how the components iteract with each other for the scenario where the user issues the command `goto 1` when in a `HomePage` view.
+
+.Component interactions for `goto 1` command in the `HomePage` view.


The "new" can be removed. Method calls should have (). From user to mainwindow, it should be a method call.

zixinn · 2020-03-27T02:31:04Z

docs/DeveloperGuide.adoc


-.Component interactions for `delete 1` command
+.Component interactions for `back` command in the `TRIP` view.
 image::ArchitectureSequenceDiagram.png[]


Constructor call should have (). The "new" keyword is not necessary.

zixinn · 2020-03-27T02:41:24Z

docs/DeveloperGuide.adoc


 [[Design-Ui]]
 === UI component

 .Structure of the UI Component
-image::UiClassDiagram.png[]
+image::UIClassDiagram.png[]


Perhaps a little too complicated?

alushingg · 2020-03-27T02:46:53Z

docs/DeveloperGuide.adoc

+
+
+.Class Diagram of the Journal Logic Component
+image::JournalLogicDiagram.png[]


The arrow for one of the creates i think should be pointing down

update repo

Update GUI Update GUI Update GUI Update GUI

Update GUI

* Fix bugs from PR #165 * Update SampleDataUtil.java Fix bug for missing invalid goto command exception on the Trip page * Fix command feedback messages * Fix result display bugs Fix %s bug from returning to trip page from itinerary page Standardize format for result display text for all command usage messages Remove `list` command Fix result display bugs * Implement refresh command * Make elements on home page scroll together * Touch up GUI Update Ui.png * Implement help window for home page Touched up user guide Fix build fail * Add some screenshots to user guide * Fix travis build fail * Update user guide with screenshots * Update user guide with data storage screenshot * Update user guide with data storage screenshot * Update icons in asciidoctor.css * Update tip icon * Fix journal GUI * Remove tutorial images * Update screenshots * Update screenshots * Update screenshots * Add screenshots to user guide * Implement help windows Implement help windows * Fix GUI bugs * Clean up code * Update diagrams in DG * Optimize imports * Fix screenshots in UG * Fix build errors * Fix itinerary delete bug * Remove AB3 diagrams, Add navigation cheatsheet, Update Ranice's PPP * Change width of navigation summary diagram * Fix UG screenshots * Fix GUI bug on HOME page * Update implementation in DG * Add class diagram for home page model * Update sequence diagram in DG * Update DG * Update Ranice's PPP

refactored code where file was deleted in model instead of logic

* Fix bugs from PR #165 * Update SampleDataUtil.java Fix bug for missing invalid goto command exception on the Trip page * Fix command feedback messages * Fix result display bugs Fix %s bug from returning to trip page from itinerary page Standardize format for result display text for all command usage messages Remove `list` command Fix result display bugs * Implement refresh command * Make elements on home page scroll together * Touch up GUI Update Ui.png * Implement help window for home page Touched up user guide Fix build fail * Add some screenshots to user guide * Fix travis build fail * Update user guide with screenshots * Update user guide with data storage screenshot * Update user guide with data storage screenshot * Update icons in asciidoctor.css * Update tip icon * Fix journal GUI * Remove tutorial images * Update screenshots * Update screenshots * Update screenshots * Add screenshots to user guide * Implement help windows Implement help windows * Fix GUI bugs * Clean up code * Update diagrams in DG * Optimize imports * Fix screenshots in UG * Fix build errors * Fix itinerary delete bug * Remove AB3 diagrams, Add navigation cheatsheet, Update Ranice's PPP * Change width of navigation summary diagram * Fix UG screenshots * Fix GUI bug on HOME page * Update implementation in DG * Add class diagram for home page model * Update sequence diagram in DG * Update DG * Update Ranice's PPP * Update AboutUs.adoc and Ranice's PPP

* Updated User Guide according to tutor feedback * Update UG with exit command and correct command summary * Fixed bug in Journal where feeling tag does not show in GUI if user does not provide weather * Add underscore for consistency * Add refresh command to Trip page * Update UML diagrams in DG * Implementation for data storage (DG) and fix spelling error in TripPageItineraryCard * Fix bug where feeling tag does not show in GUI when weather is not provided in Journal * Rearranged DG * Proof-read, review and format UG for v1.4 submission

* Fix bugs from PR #165 * Update SampleDataUtil.java Fix bug for missing invalid goto command exception on the Trip page * Fix command feedback messages * Fix result display bugs Fix %s bug from returning to trip page from itinerary page Standardize format for result display text for all command usage messages Remove `list` command Fix result display bugs * Implement refresh command * Make elements on home page scroll together * Touch up GUI Update Ui.png * Implement help window for home page Touched up user guide Fix build fail * Add some screenshots to user guide * Fix travis build fail * Update user guide with screenshots * Update user guide with data storage screenshot * Update user guide with data storage screenshot * Update icons in asciidoctor.css * Update tip icon * Fix journal GUI * Remove tutorial images * Update screenshots * Update screenshots * Update screenshots * Add screenshots to user guide * Implement help windows Implement help windows * Fix GUI bugs * Clean up code * Update diagrams in DG * Optimize imports * Fix screenshots in UG * Fix build errors * Fix itinerary delete bug * Remove AB3 diagrams, Add navigation cheatsheet, Update Ranice's PPP * Change width of navigation summary diagram * Fix UG screenshots * Fix GUI bug on HOME page * Update implementation in DG * Add class diagram for home page model * Update sequence diagram in DG * Update DG * Update Ranice's PPP * Update AboutUs.adoc and Ranice's PPP * Update Ranice's PPP

* Fix bugs from PR #165 * Update SampleDataUtil.java Fix bug for missing invalid goto command exception on the Trip page * Fix command feedback messages * Fix result display bugs Fix %s bug from returning to trip page from itinerary page Standardize format for result display text for all command usage messages Remove `list` command Fix result display bugs * Implement refresh command * Make elements on home page scroll together * Touch up GUI Update Ui.png * Implement help window for home page Touched up user guide Fix build fail * Add some screenshots to user guide * Fix travis build fail * Update user guide with screenshots * Update user guide with data storage screenshot * Update user guide with data storage screenshot * Update icons in asciidoctor.css * Update tip icon * Fix journal GUI * Remove tutorial images * Update screenshots * Update screenshots * Update screenshots * Add screenshots to user guide * Implement help windows Implement help windows * Fix GUI bugs * Clean up code * Update diagrams in DG * Optimize imports * Fix screenshots in UG * Fix build errors * Fix itinerary delete bug * Remove AB3 diagrams, Add navigation cheatsheet, Update Ranice's PPP * Change width of navigation summary diagram * Fix UG screenshots * Fix GUI bug on HOME page * Update implementation in DG * Add class diagram for home page model * Update sequence diagram in DG * Update DG * Update Ranice's PPP * Update AboutUs.adoc and Ranice's PPP * Update Ranice's PPP * Fix DG bugs

* Fix bugs from PR #165 * Update SampleDataUtil.java Fix bug for missing invalid goto command exception on the Trip page * Fix command feedback messages * Fix result display bugs Fix %s bug from returning to trip page from itinerary page Standardize format for result display text for all command usage messages Remove `list` command Fix result display bugs * Implement refresh command * Make elements on home page scroll together * Touch up GUI Update Ui.png * Implement help window for home page Touched up user guide Fix build fail * Add some screenshots to user guide * Fix travis build fail * Update user guide with screenshots * Update user guide with data storage screenshot * Update user guide with data storage screenshot * Update icons in asciidoctor.css * Update tip icon * Fix journal GUI * Remove tutorial images * Update screenshots * Update screenshots * Update screenshots * Add screenshots to user guide * Implement help windows Implement help windows * Fix GUI bugs * Clean up code * Update diagrams in DG * Optimize imports * Fix screenshots in UG * Fix build errors * Fix itinerary delete bug * Remove AB3 diagrams, Add navigation cheatsheet, Update Ranice's PPP * Change width of navigation summary diagram * Fix UG screenshots * Fix GUI bug on HOME page * Update implementation in DG * Add class diagram for home page model * Update sequence diagram in DG * Update DG * Update Ranice's PPP * Update AboutUs.adoc and Ranice's PPP * Update Ranice's PPP * Fix DG bugs * Fix bug in Ranice's PPP

Mik PPP

* Updated User Guide according to tutor feedback * Update UG with exit command and correct command summary * Fixed bug in Journal where feeling tag does not show in GUI if user does not provide weather * Add underscore for consistency * Add refresh command to Trip page * Update UML diagrams in DG * Implementation for data storage (DG) and fix spelling error in TripPageItineraryCard * Fix bug where feeling tag does not show in GUI when weather is not provided in Journal * Rearranged DG * Proof-read, review and format UG for v1.4 submission * Update Grant's PPP * Update DG

raniceyue force-pushed the master branch 4 times, most recently from 569da94 to 3ff2c25 Compare February 28, 2020 12:33

kevvvinn reviewed Mar 6, 2020

View reviewed changes

Denise-Ng reviewed Mar 6, 2020

View reviewed changes

ChesterSim reviewed Mar 6, 2020

View reviewed changes

alcen reviewed Mar 6, 2020

View reviewed changes

ChesterSim reviewed Mar 6, 2020

View reviewed changes

Denise-Ng reviewed Mar 6, 2020

View reviewed changes

yjskrs reviewed Mar 6, 2020

View reviewed changes

alcen reviewed Mar 6, 2020

View reviewed changes

Denise-Ng reviewed Mar 6, 2020

View reviewed changes

nathanaelseen reviewed Mar 6, 2020

View reviewed changes

raniceyue force-pushed the master branch from 83125c2 to 732f75a Compare March 19, 2020 16:04

alushingg reviewed Mar 27, 2020

View reviewed changes

zixinn reviewed Mar 27, 2020

View reviewed changes

alushingg reviewed Mar 27, 2020

View reviewed changes

ranicelin and others added 7 commits March 27, 2020 16:35

Merge remote-tracking branch 'AY1920S2-CS2103T-F09-4/master'

fef7aee

Fix build error

458d1bb

Merge pull request #6 from AY1920S2-CS2103T-F09-4/master

c06522d

update repo

Merge remote-tracking branch 'AY1920S2-CS2103T-F09-4/master'

ec17c0b

Sorting activity list chronologically update

d70d995

Update GUI

0fcd8c1

Update GUI Update GUI Update GUI Update GUI

Merge pull request #144 from raniceyue/master

38b0daa

Update GUI

zsoh97 and others added 30 commits April 13, 2020 21:12

merge conflict commit

ab25367

Merge pull request #269 from zsoh97/master

5b0d718

refactored code where file was deleted in model instead of logic

Updated PPP

56cd604

Update zsoh97.adoc

9d6312f

Add files via upload

af7dc20

Fix bug where LEGEND does not appear on website

309810e

Update use cases in DG, appendix for manual testing formatting

7a88ba3

Updated PPP

5e52306

Update use cases in DG, appendix for manual testing formatting (#273)

282ab2c

Merge branch 'master' into master

ac1b53a

Add files via upload

975216b

Update zsoh97.adoc

37a2a8f

Update zsoh97.adoc

72b115c

Updated vuhieunguyen.adoc (#276)

a16f2fd

fix reference in storage

2898c1d

Update zsoh97.adoc

49781a1

Fix bug where figure 14 does not appear

7fa84fb

Update Mik PPP

c383fc9

Merge remote-tracking branch 'AY1920S2-CS2103T-F09-4/master'

59eede2

Update zsoh97.adoc

0df7326

ppp update

33b7b5a

pppppp

1e3ef65

Merge pull request #278 from mikhailfaiz/master

662527c

Mik PPP

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2103T-F09-4] Volant #18

[CS2103T-F09-4] Volant #18

raniceyue commented Feb 17, 2020

zsoh97 commented Feb 24, 2020

kevvvinn Mar 6, 2020

Denise-Ng Mar 6, 2020

ChesterSim Mar 6, 2020

ChesterSim Mar 6, 2020

ChesterSim Mar 6, 2020

alcen Mar 6, 2020

alcen Mar 6, 2020

ChesterSim Mar 6, 2020

Denise-Ng Mar 6, 2020

yjskrs Mar 6, 2020

yjskrs Mar 6, 2020

alcen Mar 6, 2020 •

edited

Loading

Denise-Ng Mar 6, 2020

nathanaelseen left a comment •

edited

Loading

nathanaelseen Mar 6, 2020

nathanaelseen Mar 6, 2020

nathanaelseen Mar 6, 2020

alushingg Mar 27, 2020

zixinn Mar 27, 2020

zixinn Mar 27, 2020

alushingg Mar 27, 2020


		\|`* * *` \|user \|find a person by name \|locate details of persons without having to go through the entire list
		\|`* *` \|frequent traveler \|to be able to see a timeline view of all my short journal entries and photos, including the location and time of the photos and entries, per trip\| ??


		\|`* * *` \| traveler always on the go \| record short text entries recording my travels, similar to that of a Tweet on Twitter \| can keep track of my activities without excessive typing

		\|`* * *` \|user \|add an activity into an itinerary list \|see my planned activities at a glance and better plan my trip


		\|`* *` \|user \|sort my travel entries by category depending on the ‘feeling’ tag of each travel entry \|see my best moments

		\|`* *` \|busy user \|list and record items in a packing list \|easily reference what I need for a trip at a glance


		\|`* * *` \|user \|edit the entries in my itinerary list \|can amend any mistakes when entering data, or change my travel plans

		\|`* * *` \|user \| see a chronological timeline of the activities in the itinerary \| can have a clear idea of my travel plans and schedule dur


		The _Sequence Diagram_ below illustrates how the components iteract with each other for the scenario where the user issues the command `goto 1` when in a `HomePage` view.

		.Component interactions for `goto 1` command in the `HomePage` view.



		.Class Diagram of the Journal Logic Component
		image::JournalLogicDiagram.png[]

[CS2103T-F09-4] Volant #18

Are you sure you want to change the base?

[CS2103T-F09-4] Volant #18

Conversation

raniceyue commented Feb 17, 2020

zsoh97 commented Feb 24, 2020

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alcen Mar 6, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nathanaelseen 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

alcen Mar 6, 2020 •

edited

Loading

nathanaelseen left a comment •

edited

Loading