Skip to content

Commit

Permalink
Update PPP
Browse files Browse the repository at this point in the history
  • Loading branch information
Seris370 committed Nov 9, 2019
1 parent a0c7cb5 commit 38e4859
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 34 deletions.
3 changes: 2 additions & 1 deletion docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -739,6 +739,7 @@ Updating the UI synchronously
//@@author

//@@author Seris370
// tag::plan[]

=== Training Plan Feature

Expand Down Expand Up @@ -804,7 +805,7 @@ Step 6. The user executes `deleteplan 1`, which calls `Model#getFilteredPlanList
* **Alternative 2:** By indicating index of the original problem.
** Pros: Complies with other usages of prefix `task/`.
** Cons: Adds coupling due to access to `filteredProblemList` in the model.

// end::plan[]
//@@author

== Documentation
Expand Down
2 changes: 2 additions & 0 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,7 @@ Examples:

* `edittag 1 t/difficult`

// tag::plan[]
=== Training Plans

Training plans consist of wrapped-up problems which we call `task` s.
Expand Down Expand Up @@ -409,6 +410,7 @@ Format: `findplan [n/NAME] [d/DESCRIPTION] [start/RANGE_START] [end/RANGE_END] [
** is case-sensitive.
** is matched word by word.
** is considered a match only when there is a task whose name is exactly the same as the given task name.
// end::plan[]

// tag::task[]
=== Task Management
Expand Down
55 changes: 22 additions & 33 deletions docs/team/seris370.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,62 +5,51 @@

== PROJECT: AlgoBase

---

== Overview

AlgoBase is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
AlgoBase is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 20 kLoC.

== Summary of contributions

* *Code contributed*:
https://nus-cs2103-ay1920s1.github.io/tp-dashboard/#=undefined&search=seris370[Code contributed]
* *Major enhancement*: added *the training plan feature*
** What it does: allows users to create customized training plans with specific starting date and end date and that consist of selected problems in AlgoBase. Each problem is wrapped up as a task in the plan. Users can record their progress by marking problems in plans as done or undone, and they can edit, delete or search for plans.
** Justification: This feature improves the product significantly because it would be inconvenient for a hard-working user to manage a large number of problems without a higher-level component that categorize selected problems.
** Highlights: This feature enables users to set specific duration for a training plan, which provides the possibility of various potential enhancements in the future, such as alarming for deadlines, and thus will make AlgoBase more attractive to users.

* *Major enhancement*: added *the ability to undo/redo previous commands*
** What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
** Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
** Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
** Credits: _{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}_
* *Minor enhancement to existing project*: refactored part of *command and parsers*

* *Minor enhancement*: added a history command that allows the user to navigate to previous commands using up/down keys.

* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_
* *Code contributed*:
https://nus-cs2103-ay1920s1.github.io/tp-dashboard/#=undefined&search=seris370[Code contributed]

* *Other contributions*:

** Project management:
*** Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
** Enhancements to existing features:
*** Updated the GUI color scheme (Pull requests https://github.com[#33], https://github.com[#34])
*** Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests https://github.com[#36], https://github.com[#38])
** Documentation:
*** Did cosmetic tweaks to existing contents of the User Guide: https://github.com[#14]
*** Managed releases `v1.1` - `v1.4` (3 releases) on GitHub
** Enhancements to project prototype:
*** Add basic plan commands and Ui for plans (Pull requests https://github.com/AY1920S1-CS2103T-W11-1/main/pull/65[#65], https://github.com/AY1920S1-CS2103T-W11-1/main/pull/72[#72])
*** Enable plan finding (Pull requests https://github.com/AY1920S1-CS2103T-W11-1/main/pull/117[#117], https://github.com/AY1920S1-CS2103T-W11-1/main/pull/148[#148])
** Community:
*** PRs reviewed (with non-trivial review comments): https://github.com[#12], https://github.com[#32], https://github.com[#19], https://github.com[#42]
*** Contributed to forum discussions (examples: https://github.com[1], https://github.com[2], https://github.com[3], https://github.com[4])
*** Reported bugs and suggestions for other teams in the class (examples: https://github.com[1], https://github.com[2], https://github.com[3])
*** Some parts of the history feature I added was adopted by several other class mates (https://github.com[1], https://github.com[2])
** Tools:
*** Integrated a third party library (Natty) to the project (https://github.com[#42])
*** Integrated a new Github plugin (CircleCI) to the team repo

_{you can add/remove categories in the list above}_
*** PRs reviewed (with non-trivial review comments):
https://github.com/AY1920S1-CS2103T-W11-1/main/pull/105[#105]
https://github.com/AY1920S1-CS2103T-W11-1/main/pull/108[#108]
https://github.com/AY1920S1-CS2103T-W11-1/main/pull/125[#125]
*** Reported bugs and suggestions for other teams in the class:
https://github.com/Seris370/ped[PE Dry Run]

== Contributions to the User Guide


|===
|_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
|===
include::../UserGuide.adoc[tag=plan]

== Contributions to the Developer Guide

|===
|_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
|===

== PROJECT: PowerPointLabs

---

_{Optionally, you may include other projects in your portfolio.}_
https://github.com/AY1920S1-CS2103T-W11-1/main/blob/master/docs/DeveloperGuide.adoc#training-plan-feature[Design - Plan] +
https://github.com/AY1920S1-CS2103T-W11-1/main/blob/master/docs/DeveloperGuide.adoc#adding-a-plan[Manual Testing - Plan]
include::../DeveloperGuide.adoc[tag=plan]

0 comments on commit 38e4859

Please sign in to comment.