[CS2103T-F10-2] Internship Diary #42

gerhean · 2020-02-20T01:45:22Z

Team Members:
@gerhean
@FeliciaTay
@foochifa
@ongch00
@wxwxwxwx9

chrisjwelly

General comments for user stories:
Most stories seem to have the format of "I want to store this for future use".

chrisjwelly · 2020-03-06T02:50:07Z

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
+|`* * *` |user |trace all my internship application's contact | easily follow up on the application


Should this user story be of the highest priority?

chrisjwelly · 2020-03-06T02:52:14Z

docs/DeveloperGuide.adoc

+|`* * *` |user |tag each application with a status | track my internship application phase

-|`* * *` |user |delete a person |remove entries that I no longer need
+|`* * *` |self-reflecting user |mark what positions of internship I have been applying to | see which positions I have the best chance of getting and easily look up past internship application when applying to similar positions


By marking positions of internship you have been applying to, would that help with seeing which positions you have the best chance of getting?

chrisjwelly · 2020-03-06T02:55:46Z

docs/DeveloperGuide.adoc

+|`* * *` |self-reflecting user |mark what positions of internship I have been applying to | see which positions I have the best chance of getting and easily look up past internship application when applying to similar positions

-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+|`* * *` |user |set reminders for internship deadlines/appointments| make sure I do not miss any internship opportunities


Would it be more accurate to describe this as "so that I can promptly complete the internship tasks", instead of "missing any internship opportunities", as missing internship opportunities imply not applying to it in the first place?

chrisjwelly · 2020-03-06T02:56:57Z

docs/DeveloperGuide.adoc

+
+|`*` |frequent interviewee |maintain a checklist of questions to ask the interviewer |
+
+|`*` |first-time internship seeker |use the program as a guide to internship applications |learn how to start applying for an internship


Could this have been more specific to describe how this program can act as a guide?

helloImHai · 2020-03-06T02:56:24Z

docs/DeveloperGuide.adoc

+2. User requests to prioritise the Internship Application.
+3. InternDiary updates the priority level of the Internship Application.
+
+Use case ends


The same extension for UC2 might be applicable to UC3 too?

helloImHai · 2020-03-06T02:58:46Z

docs/DeveloperGuide.adoc

+2. User requests to prioritise the Internship Application.
+3. InternDiary updates the priority level of the Internship Application.
+
+Use case ends


Consider adding extension for UC3 when the application already has the specified priority level

junhaotan

Overall, try to add features and implementation in DG. Good effort to update the class diagrams.

junhaotan · 2020-03-26T01:59:49Z

docs/DeveloperGuide.adoc


 *API* : link:{repoURL}/src/main/java/seedu/address/model/Model.java[`Model.java`]

 The `Model`,


Good effort on updating the Model class diagram

joanneong

I looked through your DG, and focused on the Design and Implementation sections. In general, good job for updating the DG and removing references to the AddressBook! :)

However, I have left some comments and questions you might want to consider to improve your DG further. Let me know if you have any questions.

Also, @gerhean , can you amend the PR description and add your team members there? Here's an example. This is so that everyone in your team will receive notifications if there are comments made on the PR!

joanneong · 2020-04-03T18:12:03Z

docs/DeveloperGuide.adoc

+`EnteredCommandsHistory` allows the user to get the sort command template back
+in just one press of the up arrow key so there is little hassle. +
+Users do not have to remember the order to place the arguments to get the sort they want.
+** Cons: Feels a little restrictive.


Can this con be phrased more clearly? In what way is this restrictive? Is it really restrictive or is it just how you 'feel' about it?

joanneong · 2020-04-03T18:26:03Z

docs/DeveloperGuide.adoc

+
+In particular, `Interview` will rely on the `ApplicationDate` and `Address` classes in the Model to implement `interviewDate` and `interviewAddress`
+
+image::InterviewClassDiagram.png[]


Let's stick to the notations which we learnt in class! This means that:

the letter 'C' should not be shown in the class diagram

to indicate access level for each method (private/public etc), notations such as - or + should be used instead of colored circles

the composition association should have arrow heads pointing towards the parts in this whole-part relationship

These comments also apply to other class diagrams in your DG!

joanneong · 2020-04-03T18:31:02Z

docs/DeveloperGuide.adoc

+which is the primary logic parser for user input. The following sequence diagram will illustrate the process of invocation for
+ `InterviewAddCommand`. All other sub-commands will follow the same invocation format.
+
+image::InterviewCommandSequenceDiagram.png[]


A few comments/questions:

Why is there a strange : InterviewCommand in the sequence diagram?

Why do the lifelines lead back to instances at the bottom of the diagram?

Are the instances named correctly? (i.e. are you perhaps missing something like a :?)

joanneong · 2020-04-03T18:34:10Z

docs/DeveloperGuide.adoc

+* `EmailContainsKeywordsPredicate` -- Predicate to check if an internship application's `Email` field contains any
+substring matching any words in the list supplied by its constructor `EmailContainsKeywordsPredicate(List<String>
+keywords)`.
+* `PriorityContainsNumbersPredicate` -- Predicate to check if an internship application's `Phone` field contains any


...to check if an internship application's Phone field...

Is there a typo here?

joanneong · 2020-04-03T18:35:40Z

docs/DeveloperGuide.adoc

+`ApplicationDateIsDatePredicate`, `PriorityContainsNumbersPredicate` and `StatusContainsKeywordsPredicate` to get a
+single predicate and passing that into the method `updateFilteredInternshipApplicationList()` of the `ModelManager`
+instance.
+


Are there appropriate UML diagram(s) that you can insert to complement your description?

joanneong · 2020-04-03T18:40:02Z

docs/DeveloperGuide.adoc

+
+3) The `unarchive` command moves an internship application from the archival list to the main list.
+
+image::UnarchiveSequenceDiagram.png[]


GIven that the sequence diagram for unarchive is essentially the same as for archive, do you think that having this diagram is necessary?

joanneong · 2020-04-03T18:41:40Z

docs/DeveloperGuide.adoc

+`StatisticsWindow` serves as an additional graphical statistics interface for users to get a visual breakdown of their internship
+application(s) in the form of a bar chart or pie chart.
+
+Users will be able to bring up the `StatisticsWindow` by executing the command `stats`.


Can you provide more details on the implementation for this feature? You can also consider using appropriate UML diagrams to illustrate your ideas!

joanneong · 2020-04-03T18:42:37Z

docs/DeveloperGuide.adoc

+** Pros: Users will be choose which list they want to view the relevant statistics for.
+Works well with `archival`, `list`, and `find` commands that dynamically changes the list.
+** Cons: Often re-computation upon changes in the filtered list may cause some performance bottleneck.
+


Can you spot the grammatical errors in this section?

Update UG

… into branch-Documentation-Update

Update DG for find command

… into update-docs-14

… into branch-week-13-docs

Update Find DG

Update help_window.png

* 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main: Update find class diagram Update description Fix priority predicate description fix styling of interview in DG

… into branch-week-13-docs

Fix docs

Update DG and PPP

PPP fix

get rid of some stuff

* 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main: get rid of some stuff Update PPP PRs remove floating PR header Add markdown syntax to DG Fix acsiidoctor error Remove extra fullstop

Add markdown syntax

Fix word

update to ppp

Update project title in PPP

chrisjwelly reviewed Mar 6, 2020

View reviewed changes

helloImHai reviewed Mar 6, 2020

View reviewed changes

foochifa force-pushed the master branch from 65c3774 to 4b4cc53 Compare March 19, 2020 01:45

junhaotan reviewed Mar 26, 2020

View reviewed changes

joanneong reviewed Apr 3, 2020

View reviewed changes

wxwxwxwx9 and others added 25 commits April 11, 2020 20:19

Added preface section

1528001

Update RemovalBasedCommand parsing to fix edge case

851a018

update DG

2dc09ce

Update UG

4d3891a

Fix checkstyle

7749644

Merge pull request #238 from wxwxwxwx9/master

761c816

Update UG

fix use cases reference

8b0e486

Merge branch 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main…

0656872

… into branch-Documentation-Update

added summary of contributions to PPP

a2fcc92

added additional highlights to PPP

ff5f123

minor corrections to PPP

f268420

preliminary change to Overview for PPP

0418260

Add find activity diagram

e2fe411

Add find class diagram

bf8a7a7

Add manual test cases for find

f2f389e

Add images to find command in DG

528c301

Fix typo

d6b7392

Add use case for find command

a298617

Add newline at EOF

2c4ae2e

Update find command usage message

38f2329

Merge pull request #240 from ongch00/branch-week-12-dg

ae56948

Update DG for find command

Update CommandHistoryActivityDiagram.puml

d0a7d70

Merge branch 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main…

cdae9f7

… into update-docs-14

Fix sort

ead4399

Update user guide

fd49403

wxwxwxwx9 and others added 30 commits April 13, 2020 14:20

Update help_window.png

ce7807b

Update description

70e5667

Update find class diagram

790ea70

Merge branch 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main…

706af1a

… into branch-week-13-docs

Merge pull request #279 from ongch00/branch-week-13-docs

606037a

Update Find DG

Merge pull request #278 from wxwxwxwx9/master

3232ebd

Update help_window.png

Remove extra fullstop

1734815

Merge branch 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main

2784cfb

* 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main: Update find class diagram Update description Fix priority predicate description fix styling of interview in DG

Merge branch 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main…

dc9b2a9

… into branch-week-13-docs

Fix acsiidoctor error

991c2c7

Merge pull request #280 from ongch00/branch-week-13-docs

5e254a7

Fix docs

Update PPP

612f7f0

Add markdown syntax to DG

ff4b4ab

remove floating PR header

728bd92

Update PPP PRs

23375f7

Merge pull request #281 from ongch00/branch-week-13-docs

170ea5d

Update DG and PPP

Merge pull request #282 from foochifa/branch-Documentation-Update

e965f74

PPP fix

get rid of some stuff

ce39392

Merge pull request #283 from gerhean/update-docs-14

a0bd19b

get rid of some stuff

Merge branch 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main

c8a5896

* 'master' of https://github.com/AY1920S2-CS2103T-F10-2/main: get rid of some stuff Update PPP PRs remove floating PR header Add markdown syntax to DG Fix acsiidoctor error Remove extra fullstop

Add markdown syntax

21e2883

Merge pull request #285 from ongch00/branch-week-13-docs

b500055

Add markdown syntax

Update PPP

bea2e45

Update wxwxwxwx9.adoc

62ef386

Fix word

9029e57

Merge pull request #286 from ongch00/master

207b731

Fix word

update EOF

8e00cb2

Merge pull request #284 from wxwxwxwx9/master

22a2c02

update to ppp

Update project title in PPP

e2cbb36

Merge pull request #287 from ongch00/master

6385c9a

Update project title in PPP


		\|`*` \|frequent interviewee \|maintain a checklist of questions to ask the interviewer \|

		\|`*` \|first-time internship seeker \|use the program as a guide to internship applications \|learn how to start applying for an internship


		API : link:{repoURL}/src/main/java/seedu/address/model/Model.java[`Model.java`]

		The `Model`,


		In particular, `Interview` will rely on the `ApplicationDate` and `Address` classes in the Model to implement `interviewDate` and `interviewAddress`

		image::InterviewClassDiagram.png[]


		3) The `unarchive` command moves an internship application from the archival list to the main list.

		image::UnarchiveSequenceDiagram.png[]

[CS2103T-F10-2] Internship Diary #42

Are you sure you want to change the base?

[CS2103T-F10-2] Internship Diary #42

Uh oh!

Conversation

gerhean commented Feb 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chrisjwelly left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

junhaotan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joanneong left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

gerhean commented Feb 20, 2020 •

edited

Loading