[CS2113T-F08-1] ModMan #30
Conversation
docs/DeveloperGuide.md
Outdated
| 1. `Ui` is class with a `Scanner` object that reads input from console. | ||
| 1. `Modman` has `Ui` object as an attribute which is instantiated | ||
| when we enter the program. | ||
| 1. `Ui` object reads input from screen and returns it which will then be passed to the Parser so that it can | ||
| parse the command. | ||
| 1. Depending on the parsed command, the corresponding | ||
| `execute()` function of the `Command` abstract class | ||
| runs. It accepts `Ui` object as a parameter and calls the relevant `Ui` methods | ||
| that prints the messages. |
There was a problem hiding this comment.
Maybe include a sequence diagram to illustrate this?
docs/DeveloperGuide.md
Outdated
| The `Data`, | ||
| * stores an `ArrayList` of `Module` objects that represents the modules. | ||
| * Each `Module` object contains `ArrayLists` of `Assignment`, `Lesson`, and `Student` objects. |
There was a problem hiding this comment.
Maybe include a line to explain moduleCode, as shown in the diagram?
|  | ||
|
|
There was a problem hiding this comment.
Maybe include a short explanation on the user inputs required to start this sorting assignments by deadline logic?
docs/DeveloperGuide.md
Outdated
| Step 1. The user launches the application. The CS2113T module has an assignment quiz1 due on 17 Aug 2021. | ||
| Step 2. The user adds 2 more assignments quiz2 and quiz3 | ||
| Step 3. The user only sets the deadline for quiz3 to be 16 Aug 2021. | ||
| Step 4. The user executes `sort by deadline` which reorders the assignments in CS2113T to be quiz3, quiz1 and quiz2. | ||
| Assignments with null as deadline are sorted behind assignments with deadlines. |
There was a problem hiding this comment.
Maybe format these steps to be on separate lines? It currently looks like this:
docs/DeveloperGuide.md
Outdated
| {Describe the target user profile} | ||
|
|
||
| ### Value proposition | ||
|
|
||
| {Describe the value proposition: what problem does it solve?} | ||
| Just to keep track of all informaiton pertaining to a module teaching assistants (at NUS) have to make use of multiple platforms: |
There was a problem hiding this comment.
A minor typo for the word "information" here, and perhaps a comma between "module" and "teaching assistants" would increase readability!
docs/DeveloperGuide.md
Outdated
| <br> | ||
| <br> | ||
|
|
||
| Given below is the Sequence Diagram for the Storage class. The storage class interacts with the database file, storing our data into the database or loading our data from the database. </br> |
There was a problem hiding this comment.
Perhaps this line should be under "Storage Component (Bryan)" instead of "Ui Component"?
docs/DeveloperGuide.md
Outdated
| <br> | ||
| <br> | ||
|
|
||
| Given below is the Sequence Diagram for the Storage class. The storage class interacts with the database file, storing our data into the database or loading our data from the database. </br> |
There was a problem hiding this comment.
The diagram below is a class diagram, hence a Sequence diagram should be included and/or change the words to mean class diagram.
docs/DeveloperGuide.md
Outdated
|
|
||
| ## Logic Component (Jianning) | ||
|
|
||
|  |
There was a problem hiding this comment.
Perhaps multiplicity should be included in this and the following class diagrams?
|
|
||
| Given below is the sequence diagram for the sort assignments by deadline command. | ||
|
|
||
|  |
There was a problem hiding this comment.
Perhaps the activation bar for the ":Data" class should have ended upon returning "module", as currently it is activated until the very end.
|
|
||
| Given below is the sequence diagram for the sort assignments by deadline command. | ||
|
|
||
|  |
There was a problem hiding this comment.
perhaps can shift the sequence diagram for the reference frame of getCommand down to here.
|
|
||
| Given below is the Sequence Diagram for the Storage class. The storage class interacts with the database file, storing our data into the database or loading our data from the database. </br> | ||
| ## Storage Component (Bryan) | ||
|  |
There was a problem hiding this comment.
perhaps for the class diagram, can remove the icon (i.e "C" and "I") as it is not really following the standard convention?
|
|
||
| Given below is the sequence diagram for the sort assignments by deadline command. | ||
|
|
||
|  |
There was a problem hiding this comment.
perhaps you can remove the object boxes at the bottom of the sequence diagram.
| @@ -1,18 +1,120 @@ | |||
| # Developer Guide | |||
|
|
|||
| ## Design & implementation | |||
| ## Design | |||
There was a problem hiding this comment.
perhaps can include an introduction to the developer guide.
docs/DeveloperGuide.md
Outdated
| 3. The command execution can affect the state of other components e.g. the sort command changes the order of assignments in `Module`. | ||
| 4. The `Command` object can also instruct the `Ui` to list and display information to the user. | ||
|
|
||
| Given below is the Sequence Diagram for creating the corresponding `Command` object from user input via `Parser`. </br> |
There was a problem hiding this comment.
The "</br>" can be fixed, as it is currently visible on the DG. This does not really affect readability too much, but just for the neatness.
|
|
||
| ## Data Component | ||
|
|
||
|  |
There was a problem hiding this comment.
Another point on neatness: maybe the diagrams can be resized such that the font sizes of the DG and the font sizes of the diagram can be consistent? (stated at bottom of https://nus-cs2113-ay2021s2.github.io/website/schedule/week11/tutorial.html)
docs/DeveloperGuide.md
Outdated
|
|
||
| ## UI Component | ||
| The UI Component consists of one class - `Ui` which provides all the functions | ||
| required to print different kinds of messages on te console. |
There was a problem hiding this comment.
Small typo: "te" console - but does not affect readability a lot, just for the neatness component.
docs/DeveloperGuide.md
Outdated
|  | ||
|
|
||
| 1. The `Storage` class is used to interact with the database.txt file by calling loadData() at the start of the program and calling saveData() at the end of the program. | ||
| 2. The `Storage` class will collect the data of all classes that implements the Storable interface so that these data can be saved to the database. |
There was a problem hiding this comment.
Since multiple classes are interacting with the Storage class, maybe it would be nice to include 1 small example of a class interacting with the Storage class with a sequence diagram?
docs/DeveloperGuide.md
Outdated
| 4. The `Command` object can also instruct the `Ui` to list and display information to the user. | ||
|
|
||
| Given below is the Sequence Diagram for creating the corresponding `Command` object from user input via `Parser`. </br> | ||
| The sequence diagram also acts as a reference frame for `getCommand`. |
There was a problem hiding this comment.
It could be slightly confusing to a reader as to where /in what context getCommand is actually used, since getCommand is not referenced anywhere else. Perhaps it would be useful to include a brief definition of it?
…into branch-JUnit # Conflicts: # src/test/java/seedu/duke/parser/ParserTest.java
Branch j unit
Fix UserGuide formatting
Bugs round #2
fix set assigment grade bug
Fix User Guide formatting
update developer guide
UG fix again
Try anchor links
Fix all anchor links
Try fix anchors
Fix Anchor Links PLS
UserGuide for 2101 changes
Edit UG Descriptions
Fix all anchor links
Mod Man, short for Module Manager, is a desktop app designed to help teaching assistants manage their module(s). It is optimized for use via a Command Line Interface (CLI). Mod Man helps to track module details as well as students’ progress and data, all in one platform.