[CS2113-T12-1] Study It by farice9 · Pull Request #33 · nus-cs2113-AY2021S1/tp

farice9 · 2020-10-01T04:24:56Z

Study It helps manage your study-related matters. It can keep track of your various study matters, present them in an organized and thoughtful manner to help you organize your study life.

ivanderjmw

This developer guide contains many details, including specific methods. However, it looks a bit messy and disorganized in Github Pages. Some errors are also present in the diagrams. You can improve it much more!

ivanderjmw · 2020-10-28T03:27:49Z

+
+![Bookmark Sequence Diagram](Images/sequence_bookmark.png)
+


There are some problems in this diagram.

Overlapping of method calls.

Placement of conditional in alt block is not correct.

I am unsure of the use of the dotted line that cuts horizontally through alt block.

Self invocation is not drawn correctly.

Some actuation bars extends after the method returns a value.

Here are more details.

ivanderjmw · 2020-10-28T03:29:24Z

+
+![BookmarkCommand ClassDiagram](Images/AddCommand_sequenceDiagram.png)
+


Is this an exact copy of the Bookmark Sequence diagram above?

ivanderjmw · 2020-10-28T03:30:43Z

+
+![Bookmark Class Diagram](Images/BookmarkRun_Class.png)
+


It would be nice to have a label for each association.

You can add lables under each figure.

ivanderjmw · 2020-10-28T03:32:01Z

+
+![BookmarkCommand ClassDiagram](Images/bookmarkCommand_Class.png)
+


Some lines are detached. Use the inheritance arrow instead of association here.

You might also need to use dotted lines.

ivanderjmw · 2020-10-28T03:33:07Z

+
+![Flashcard Component Class Diagram](Images/Flashcard_Class.png)
+


Some arrows are not quite clear. Maybe you can point out both directions of multiplicity.

Are Flashcard and FlashcardSotorage abstract? Would be nice if you specify using the label {abstract}, if they are not, you can remove the italics.

ivanderjmw · 2020-10-28T03:38:31Z

+1. SEVERE: A critical problem detected which may cause the termination of the application.
+2. WARNING: Can continue, but with caution.
+3. INFO: Information showing the noteworthy actions by the App.
+4. FINE:  Details that are not usually noteworthy but may be useful in debugging.


You can emphasize the log message levels.

ivanderjmw · 2020-10-28T03:38:51Z

+This project uses code coverage that is in IntelliJ IDE to check for the coverage of the code. 

-### Value proposition
+##Appendix: Requirement 


ivanderjmw · 2020-10-28T03:42:09Z

+[to be filled] 
+


Add an introduction to the developer guide.

ivanderjmw · 2020-10-28T03:42:55Z

+[to be filled] 
+
+## Setting up, Getting Started
+###Setting up the project in your computer


This header is incorrectly rendered in Github Pages

You can instead use a space before the title.

### Setting up...

instead of

###Setting up...

ivanderjmw · 2020-10-28T03:44:01Z

+1. Configure the coding style. 
+Ensure Coding style is standardised throughout. 
+2. Learn the design. 
+When you are ready to start coding, we recommend that you get some 


I think it would be good to specify more details? Learn which design, and what coding style to refer to.

Mick609 · 2020-10-28T05:31:32Z

You guys probably should change the name of the project to CS2113T-T12-1. Now the name (CS2113-T12-1) is missing a T.

gua-guargia

Overall, I think your developer guide is very concise and easy to follow. It will be better if you can standardize the size and resolution of the diagrams.

gua-guargia · 2020-10-30T03:24:14Z

+### **Major components**
+This section introduces the multiple components in Study It.
+
+![](Images/ArchitectureDiagrams/components.png)


Perhaps you can consider the following format to standardize your diagrams which might will help with the document's neatness :

gua-guargia · 2020-10-30T03:29:02Z

+This section will describe in detail how some features inside the academic tracker section have been implemented.
+Figure x illustrates the general overview, the associations and the multiplicity of the academic classes.
+
+![Academic_Class_Diagram](Images/Academic_Class_Diagram.png)


The resolution of this image is a bit low, perhaps can export the diagram with a higher resolution?

Perhaps the diagram can be broken down into two separate parts. The :BookmarkRun, :TimetableRun, :AcademicRun and :FlashcardRun components could be grouped into a separate sub diagram and represented in the main diagram with a black-box. This will make the diagram more readable.

gua-guargia · 2020-10-30T03:30:03Z

+
+![Academic_Class_Diagram](Images/Academic_Class_Diagram.png)
+
+API: `java.academic`


Should it be academic.java instead?

gua-guargia · 2020-10-30T03:34:47Z

+### **Major components**
+This section introduces the multiple components in Study It.
+
+![](Images/ArchitectureDiagrams/components.png)


Perhaps can remove the small negative sign box on the top of every class box. It can be a little bit confusing.

gua-guargia · 2020-10-30T03:40:54Z

+general commands, it'll be processed and provide output. Otherwise, the command will be relayed
+to different components to be processed based on the software's current mode. 
+
+### **Main Component**


This title 'Main Component' can be a little bit confusing with the previous title 'Major Components', and the content for these two sections also have some replications. Perhaps you can try to combine these two sections into one entity or introduce directly to the separated sub-components sections (i.e. skips the general 'main component' and directly shows the 'Bookmark Component' section)

xuche123 · 2020-10-30T06:17:49Z

 ## Design & implementation
+This section explains the architecture of our software and the design of each component.
+
+### **Major components**


Should be in title case for consistency.

xuche123 · 2020-10-30T06:21:07Z

+### **Main Component**
+This section will give an overview of the main component of Study It
+
+![Main Component Diagram](Images/MainComponentDiagrams/maincomponent.png)


Diagram is quite difficult to read. Maybe a font change or size increase could increase the readability?

xuche123 · 2020-10-30T06:23:06Z

+As there are multiple modes of our app (main menu/bookmark/timetable/academic/flashcard), 
+the Mode enumeration and a private static currentMode of Mode type is introduced to monitor the current 
+operating mode of StudyIt. This is to allow the program to respond to different commands under different modes.
+
+Each command input by the user will be processed by CommandParser class to determine the command type. 
+This information, along with the original command string will be passed into Command class and executed under 
+executeCommand(). If it is one of the general commands, it will be processed by that class. 
+If it isn’t, the Command class will detect the current mode of the program and run that command string under that 
+specific mode, distributed under handleNonGeneralCommand() method. If it still doesn’t parse successfully, 
+it will be considered an invalid command and an error message will be printed out.
+
+The classes Ui, ErrorMessage, HelpMessage and MainMenu help handle the printing of various user interfaces of the 
+program. ErrorMessage, HelpMessage and MainMenu are subclasses of Ui to make use of the methods in Ui.
+
+StudyIt class will also initialize various instances of classes such as TimeTableRun, FlashCardRun, 
+ArrayList<BookmarkCategory>, ArrayList<Grade>, ArrayList<Person> and pass it to Command class to perform 
+each mode’s functionality.


Maybe surround all classes like Ui, ErrorMessage and so on with ` ` instead of just StudyIt.

xuche123 · 2020-10-30T06:26:28Z

+
+![BookmarkCommand ClassDiagram](Images/BookmarkDG/AddCommand_sequenceDiagram.png)
+
+###Timetable Component


Not rendered properly on github pages due to the missing space in between # and T

…into Finalizing-V2.1

Add javadocs

Edited DG

change uml diagram

Add author tags for CS2101

Update DG About section

Fix typo in user guide

slightlyharp force-pushed the master branch from 74f42e4 to 8019286 Compare October 11, 2020 20:25

ivanderjmw reviewed Oct 28, 2020

View reviewed changes

gua-guargia reviewed Oct 30, 2020

View reviewed changes

xuche123 reviewed Oct 30, 2020

View reviewed changes

flsqqq and others added 22 commits November 9, 2020 13:24

Resized images for Flashcard UG

e433da5

Resized image for UG

63a94fe

Added page breaks and improved spacing in UG

bf576ab

Edited UG image

ede767b

Edited page breaks

0b93195

Added page breaks in UG for printing

cc50ed9

Added page breaks for Flashcard section of UG

bd400c1

Add files via upload

0d97ebe

Delete Flashcard_4_3_resized.png

8939902

Add files via upload

c422573

Resized UG image

7c9ad39

Delete Flashcard_4_3_resized.png

bcb78fe

Merge branch 'master' of https://github.com/hailqueenflo/tp

21f006d

no message

bb09536

Merge branch 'master' of https://github.com/AY2021S1-CS2113T-T12-1/tp …

7ad8005

…into Finalizing-V2.1

Set theme jekyll-theme-modernist

77eb7c7

Edited UG images

1aeb272

Merge branch 'master' into Finalizing-V2.1

9d35453

Merge branch 'master' into master

7548e68

Merge pull request #234 from farice9/Finalizing-V2.1

1f6c922

Add javadocs

Updated DG

47901a1

Merge branch 'master' of https://github.com/AY2021S1-CS2113T-T12-1/tp

17a73f9

flsqqq and others added 30 commits November 9, 2020 22:51

no message

013f842

Minor edits in DG

337aad1

Spacing in DG

d5a739f

Update flashcard class diagram.png

0cc6440

Edited Bookmark DG

a1ce4ae

Update flashcard class diagram.png

e7c59ec

Edited DG

fb9f534

Edited DG

71ac781

Update TimeTable class diagram.png

d08054a

Merge branch 'master' into master

43f9a5b

Merge pull request #256 from hailqueenflo/master

9ecac5e

Edited DG

Merge branch 'master' into master

d5443e4

update PPP

9f9b27f

Merge branch 'master' of https://github.com/slightlyharp/tp

5bc3474

Merge pull request #257 from slightlyharp/master

0f0cfef

change uml diagram

Merge branch 'master' of https://github.com/AY2021S1-CS2113T-T12-1/tp

b67ed15

Add author tags for CS2101

b50588d

Edit Florence's author tag

e606514

Merge pull request #258 from farice9/master

f9e1c0f

Add author tags for CS2101

Merge branch 'master' of https://github.com/AY2021S1-CS2113T-T12-1/tp

0bebeec

Update DG

daa03be

Merge pull request #259 from farice9/master

011b5e5

Update DG About section

Update DG About section

79de0de

Merge branch 'master' into master

c6b0f26

Merge pull request #260 from farice9/master

9b2c41f

Update DG About section

Fix typo in user guide

ef21ee1

Fix typo in user guide

b6f99da

Merge pull request #261 from lingsihui/master

10a7fcb

Fix typo in user guide

Update and rename hailqueenflo.md to flsq.md

4296fc4

Delete florencelim.png

a7e5c8e


		![BookmarkCommand ClassDiagram](Images/AddCommand_sequenceDiagram.png)


		![BookmarkCommand ClassDiagram](Images/bookmarkCommand_Class.png)


		![Flashcard Component Class Diagram](Images/Flashcard_Class.png)


		![Academic_Class_Diagram](Images/Academic_Class_Diagram.png)

		API: `java.academic`


		![BookmarkCommand ClassDiagram](Images/BookmarkDG/AddCommand_sequenceDiagram.png)

		###Timetable Component

		[to be filled]

Uh oh!

Conversation

farice9 commented Oct 1, 2020

Uh oh!

ivanderjmw 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!

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!

Mick609 commented Oct 28, 2020

Uh oh!

gua-guargia 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!

xuche123 Oct 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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

xuche123 Oct 30, 2020 •

edited

Loading