Skip to content

Commit 18ded0f

Browse files
Merge pull request #389 from nottiffchan/update-ppp
PPP
2 parents 8bf534c + f75dd33 commit 18ded0f

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

docs/team/nottiffchan.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Tiffany Chan - Project Portfolio
2+
3+
## Project: TrackIt@NUS
4+
5+
This portfolio aims to document the contributions that I have made to the **TrackIt@NUS** project. The Github Link to
6+
**TrackIt@NUS** can be found [here](https://github.com/AY2021S1-CS2103T-W13-4/tp).
7+
8+
## 1. Overview
9+
**TrackIt@NUS** is a desktop application to provide a simple an easy way for students to manage their academic and
10+
social life. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java.
11+
12+
## 2. Summary of Contributions
13+
14+
### 2.1 Code Contributed - RepoSense [link](https://nus-cs2103-ay2021s1.github.io/tp-dashboard/#breakdown=true&search=nottiffchan&sort=groupTitle&sortWithin=title&since=2020-08-14&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other)
15+
16+
### 2.2 Design of App
17+
* We recognised the importance of the layout and aesthetics of the interface for a user and put an emphasis on being able to complement our back-end methods with a UI that would facilitate user flow and maximise user experience using our app.
18+
* Throughout v1.2, v1.3 and v1.4, we have constantly revised and updated the interface design in a way that suits the evolution of the functionalities.
19+
* Our designs (on Figma) can be viewed [here](https://www.figma.com/file/4CJHXSfo1oevJtZrUQrzbK/CS2103T-W13-4-TrackIt-NUS?node-id=1%3A38)
20+
21+
### 2.3 UI Development
22+
23+
#### 2.3.1 Upcoming Tab (Major Enhancement)
24+
* I have added a [Upcoming Tab](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/UserGuide.md#upcomingtab) feature.
25+
* This is a core feature, and the main default face of our application. It shows a calendar style view of all the user's tasks and lessons, sorted by date.
26+
* This includes the "Overdue" and "Future" sections as well, which houses the tasks that lie before and after the scope of the current week.
27+
* I introduced a few new classes to achieve this, namely the `UpcomingSection`, `UpcomingSectionCard`, `UpcomingSectionDayCard`, `UpcomingLessonCard` (which extends `LessonCard`), `UpcomingTaskCard` (which extends `TaskCard`) and `OverdueFutureTaskCard` (which also extends `TaskCard`).
28+
29+
30+
#### 2.3.2 Help Tab (Major Enhancement)
31+
* I have added the [Help Tab](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/UserGuide.md#helptab) feature.
32+
* I redesigned the entire Help Tab from the default AB3 help window, opting to use a tab rather than a pop-up as it complements the functionalities of our app more.
33+
* This required redoing this aspect and populating the Help Panel.
34+
* I opted to use a table instead of just a list or just the link to our UG, to display a summary of the app's commands.
35+
36+
#### 2.3.3 Overall Populating of Data to the Relevant Tabs
37+
* Linked the back-end methods to the various tabs we had
38+
* Fixed merge conflicts in merging together the front-end and back-end codebase
39+
40+
### 2.4 Project Management
41+
* Actively voiced my opinions and gave suggestions as well as constructive feedback on the core functionalities of the application.
42+
* Requested the necessary methods and implementations from the back-end in order to do up the interface.
43+
* Managed and reviewed PRs for the front-end developments.
44+
45+
## 3. Contributions to the User Guide
46+
47+
* Explained and provided writeups for the [Application Layout](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/UserGuide.md#layout) section, namely the Upcoming, Contacts, Module and Help tab.
48+
* Did the [Format and Usage](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/UserGuide.md#about) section, including tables and relevant detailed explanations for how to read the User Guide.
49+
* The [Contacts](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/UserGuide.md#contact) section.
50+
* Overall reformatting of the entire User Guide.
51+
52+
## 4. Contributions to the Developer Guide
53+
* Included the UI component as part of my contribution to code base [UI Component](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/DeveloperGuide.md#ui) and [Upcoming Tab](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/DeveloperGuide.md#module-tab).
54+
* Did a UML class diagram and a UML sequence diagram as part of the [Upcoming Tab](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/DeveloperGuide.md#module-tab) elaboration, it being a hefty component of the app.
55+
* [Use Cases](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/DeveloperGuide.md#appen-c)
56+
* [User Stories](https://github.com/AY2021S1-CS2103T-W13-4/tp/blob/master/docs/DeveloperGuide.md#appen-b)
57+
* Overall re-formatting of the entire Developer Guide.
58+
59+
## 5. Review/mentoring contributions:
60+
* Worked closely with Wei Hong for the implementation of the UI segment where we consistently reviewed and gave detailed feedback on each other's code and PRs

0 commit comments

Comments
 (0)