Merge 023ed68 into 064e563

docs/DeveloperGuide.adoc

@@ -18,6 +18,7 @@ endif::[]
 
 By: `Team W10-3`      Since: `Feb 2019`      Licence: `MIT`
 
+//tag:introduction[]
 == Introduction
 Welcome to the Developer Guide for *Equipment Manager*!
 
@@ -30,7 +31,7 @@ Objectives of the application include:
 * Displaying location of equipment in Google Maps.
 
 * Planning the most efficient route to take for visiting multiple locations.
-
+//end:introduction[]
 
 == Setting up
 
@@ -111,6 +112,7 @@ Optionally, you can set up AppVeyor as a second CI (see <<UsingAppVeyor#, UsingA
 [NOTE]
 Having both Travis and AppVeyor ensures your App works on both Unix-based platforms and Windows-based platforms (Travis is Unix-based and AppVeyor is Windows-based)
 
+//tag::design[]
 == Design
 
 [[Design-Architecture]]
@@ -237,6 +239,7 @@ The `Storage` component,
 
 * can save `UserPref` objects in json format and read it back.
 * can save the *Equipment Manager* data in json format and read it back.
+//end::design[]
 
 [[Design-Commons]]
 === Common classes
@@ -247,6 +250,7 @@ Classes used by multiple components are in the `seedu.equipment.commons` package
 
 This section describes some noteworthy details on how certain features are implemented.
 
+//tag::filter[]
 === Filter feature
 
 ==== Introduction
@@ -287,7 +291,7 @@ Step 6. The argument is filtered against the predicate and returned to the GUI.
 * **Alternative 2:** filter by tags
 ** Pros: It is more specific and more strictly
 ** Cons: More difficult to implement
-
+// end::filter[]
 
 // tag::sort[]
 === Sort feature
@@ -323,8 +327,6 @@ Output: The list is sorted in alphabetical order.
 
 Output: The list is sorted in ascending order.
 
-
-
 ==== Design Considerations
 *Implementation of `SortCommand`*
 
@@ -334,6 +336,7 @@ Output: The list is sorted in ascending order.
 * **Alternative 2:** Sort by client name
 ** Pros: Overall list is sorted fully by client name
 ** Cons: Unable to sort other specific fields such as serial number of the equipment.
+// end::sort[]
 
 // tag::display[]
 === Display feature
@@ -367,6 +370,7 @@ Step 5. The webpage receive the coordinates in parameter form. It will first par
 * **Alternative 2:** Use third party JavaFX map libraries.
 ** Pros: No unexpected behaviors, and more consistant running on different platforms.
 ** Cons: Harder to implement, less flexibility, and limit to extendsions.
+// end::display[]
 
 // tag::undoredo[]
 === Undo/Redo feature
@@ -680,6 +684,7 @@ A project often depends on third-party libraries. For example, Address Book depe
 
 *Value proposition*: help plan an efficient route for busy engineers to multiple locations and also carrying preventive maintance on multiple equipments in a day.
 
+//tag:userstories[]
 [appendix]
 == User Stories
 
@@ -751,6 +756,7 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 |=======================================================================
 
 _{More to be added}_
+//end:userstories[]
 
 
 [appendix]
@@ -786,6 +792,7 @@ Use case resumes at step 2.
 
 _{More to be added}_
 
+//tag:: appendix[]
 [appendix]
 == Non Functional Requirements
 Non-functional requirements specify the constraints under which system is developed and operated.
@@ -821,6 +828,7 @@ If you do not understand a technical term used in this document, refer to [under
 |*User Interface (UI)*
 |Allows the user to interact with the application through inputs and outputs of data.
 |===
+//end:: appendix[]
 
 [appendix]
 == Instructions for Manual Testing
@@ -830,6 +838,7 @@ Given below are instructions to test the app manually.
 [NOTE]
 These instructions only provide a starting point for testers to work on; testers are expected to do more _exploratory_ testing.
 
+
 === Launch and Shutdown
 
 . Initial launch

docs/UserGuide.adoc

@@ -16,13 +16,15 @@ endif::[]
 
 By: `Team W10-3`      Since: `JAN 2019`      Licence: `MIT`
 
+//tag::Introduction[]
 == Introduction
 
 *Equipment Manager* is a desktop CLI (Command Line Interface) application that allows engineers to keep track on the Preventive Maintenance schedule of all Resuscitation Devices in singapore. It has a GUI (Graphic User Interface) that allows users to get further information on each equipment.
 
 Our purpose is to help engineers plan the number of equipment that they would like to carry out preventive maintenance and keep track on each equipment details such as status, location and more information.
+//end::Introduction[]
 
-
+//tag::aboutug[]
 == About This User Guide
 Welcome to *Equipment Manager* User Guide! +
 
@@ -31,7 +33,6 @@ this section will explain the key things to take note of. +
 
 If this is not a problem for you, jump to the <<Quick Start>> to get started. If you already have Equipment Manager up and running, then head over to <<Features>>. Enjoy!
 
-
 === Icons Meaning
 The following section provides a quick understanding on each of the legends used throughout the user guide.
 These legends alert reader on special information such as tips, notes and warnings. +
@@ -50,8 +51,9 @@ These legends alert reader on special information such as tips, notes and warnin
 |image:advanced.png[width="40"]
 | The book icon indicates that it is an additional information for advanced users.
 |===
+//end::aboutug[]
 
-
+//tag::quickstart[]
 == Quick Start
 
 To get Equipment manager up and running, simply follow these few steps.
@@ -92,7 +94,9 @@ Type the command in the Command Box and press kbd:[Enter] to execute it. +
 |===
 | image:tip.png[width="40"] |Refer to <<Features>> for details of each command.
 |===
+//end::quickstart[]
 
+//tag::features[]
 [[Features]]
 == Features
 
@@ -369,12 +373,16 @@ There is no need to save manually.
 === Encrypting data files `[coming in v2.0]`
 
 _{explain how the user can enable/disable data encryption}_
+//end::features[]
 
+//tag::faq[]
 == FAQ
 
 *Q*: How do I transfer my data to another Computer? +
 *A*: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Equipment Manager folder.
+//end::faq[]
 
+//tag::glossary[]
 == Glossary
 Unsure of a few technical terms? We got you covered. Refer to [underline]#<<techtable>># below.
 
@@ -396,8 +404,9 @@ Unsure of a few technical terms? We got you covered. Refer to [underline]#<<tech
 |*User Interface (UI)*
 |Allows the user to interact with the application through inputs and outputs of data.
 |===
+//end::glossary[]
 
-
+//tag::commandsummary[]
 == Command Summary
 
 This is the last section of the User Guide, but the most useful if you just want a list of commands to try.
@@ -468,3 +477,4 @@ For more details on what each command does, please refer to <<Features>>.
 |filter /year 1987-2018 /status in-use`
 |fil ongoing
 |===
+//end::commandsummary[]

docs/team/rachel.adoc

@@ -0,0 +1,111 @@
+= Rachel Tan - Project Portfolio
+:site-section: AboutUs
+:imagesDir: ../images
+:stylesDir: ../stylesheets
+
+== About Me
+
+---
+image:e0191632.png[width="100"]
+
+Hello! I am Rachel Tan!
+
+I am a Year 2 Computer Science student studying in National University of Singapore. I am currently working on *Equipment Manager* application, a project for a module called CS2103T Software Engineering along with 3 other team mates, Mei Yen, Yiqun and Liu Xuan. This is my Project Portfolio where I will showcase my contributions to team in making *Equipment Manager* a successful application.
+
+---
+
+== PROJECT: Equipment Manager
+
+---
+
+== Overview
+
+*Equipment Manager* is a Preventive Maintenance (PM) planner application that allows users, specifically the engineers, to keep track of the PM schedule of all Resuscitation Equipment in Singapore. *Equipment Manager* is designed to allow engineers assign the equipment they are going to carry out maintenance work to their own work schedule. When they are carrying out maintenance work on multiple equipments in their work schedule, they are able to have a visual representation on the locations of all equipment. In order to carry out maintenance work efficiently, *Equipment Manager* provide engineers with an efficient route to take for visiting multiple locations, minimizing the chance that the resuscitation devices will fail and cause costly unscheduled downtime.
+
+== Summary of contributions
+This section shows a summary of my coding, documentation, and other helpful contributions to the team project.
+
+* *Major Enhancement 1*: I added a model for client to keep track of their name, address and the equipments they own
+** What it does: allows the user know the details to the clients and the number of equipments the clients own.
+** Justification: Having the details of the client improves the overall efficiency of the maintenance work.
+*** User will head for maintenance work based on client address.
+*** Client address can be represented on google map for planning of efficient routes to take.
+*** Knowing how many equipment a client owns, allows user to be aware that there are equivalent number of equipment to carry out maintenance work at that location.
+** Highlights: This enhancement allows a visual representation of equipment location on Google Map and route planning.
+
+** Codes contributed:
+
+* *Major enhancement 2*: I enhanced the initial Person model to *Equipment model*
+** What it does: All the `commands` carried out by user will be based on details of an Equipment. Specifically, an equipment has a serial number, a due date to carry out preventive maintenance and a sub-location where the equipment is installed.
+** Justification: This enhancement allow users to get access to detailed information of an equipment easily and for tracking purposes in the program. Main tracking purposes include:
+*** Knowing specifically where equipment is installed. For example, in the client's level 1 reception counter, level 2 ball room and etc.
+*** Alerting when preventive maintenance due date is nearing
+*** Allow assignation of each selected equipment with all its details into work agenda
+** Highlights: This enhancement modifies the existing UI, specifically the selected equipment details in `ResultPanel` and showing full details of a selected equipment on `FullResultPanel`.
+** Codes contributed:
+
+image:tip.png[width="40"]
+`commands`
+: add-e, edit-e, filter, find, list-e
+
+* *Minor enhancement*: {in progress}
+
+* *Other contributions*:
+
+** Project management:
+*** Morphed the code from address book to equipment manager. https://github.com/CS2103-AY1819S2-W10-3/main/pull/16[#16], https://github.com/CS2103-AY1819S2-W10-3/main/pull/19[#19]
+*** Morphed the test cases from address book to equipment manager. https://github.com/CS2103-AY1819S2-W10-3/main/pull/72[#72], https://github.com/CS2103-AY1819S2-W10-3/main/pull/63[#63]
+
+** Enhancements to existing features:
+*** Changed the condition to check for duplicate equipments https://github.com/CS2103-AY1819S2-W10-3/main/pull/59[#59]
+*** Updated command word and prefixes https://github.com/CS2103-AY1819S2-W10-3/main/pull/58[#58]
+*** Updated the GUI color scheme https://github.com[#33], https://github.com[#34]
+
+** Documentation:
+*** Did cosmetic tweaks to existing contents of the User Guide and Developer Guide: https://github.com/CS2103-AY1819S2-W10-3/main/pull/90[#90], https://github.com/CS2103-AY1819S2-W10-3/main/pull/88[#88]
+*** Updated images, diagrams and contents of User Guide and Developer Guide: https://github.com/CS2103-AY1819S2-W10-3/main/pull/90[#90], https://github.com/CS2103-AY1819S2-W10-3/main/pull/73[#73], https://github.com/CS2103-AY1819S2-W10-3/main/pull/37[#37], https://github.com/CS2103-AY1819S2-W10-3/main/pull/36[#36]
+
+** Community:
+*** PRs reviewed (with non-trivial review comments): https://github.com/CS2103-AY1819S2-W10-3/main/pull/65[#65], https://github.com/CS2103-AY1819S2-W10-3/main/pull/52[#52], https://github.com[#32], https://github.com[#19], https://github.com[#42]
+
+** Tools:
+*** Set up coverall badges, appveyors and travis bot for the team.
+
+== 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=introduction]
+
+include::../UserGuide.adoc[tag=aboutug]
+
+include::../UserGuide.adoc[tag=quickstart]
+
+include::../UserGuide.adoc[tag=features]
+
+include::../UserGuide.adoc[tag=faq]
+
+include::../UserGuide.adoc[tag=glossary]
+
+include::../UserGuide.adoc[tag=commandsummary]
+
+== 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._
+|===
+
+include::../DeveloperGuide.adoc[tag=introduction]
+
+include::../DeveloperGuide.adoc[tag=design]
+
+include::../DeveloperGuide.adoc[tag=userstories]
+
+include::../DeveloperGuide.adoc[tag=appendix]
+
+== PROJECT: PowerPointLabs
+
+---