From c7f5cb96af8889394794bef98e1d6bc9bb693fb5 Mon Sep 17 00:00:00 2001 From: flxffy Date: Tue, 2 Apr 2019 23:31:19 +0800 Subject: [PATCH 1/2] ppp first draft --- docs/DeveloperGuide.adoc | 7 +++- docs/UserGuide.adoc | 7 +++- docs/team/flxffy.adoc | 64 +++++++++++++++++++++++++++++++++++ docs/team/johndoe.adoc | 72 ---------------------------------------- 4 files changed, 76 insertions(+), 74 deletions(-) create mode 100644 docs/team/flxffy.adoc delete mode 100644 docs/team/johndoe.adoc diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc index 74f8694f22c1..972f6d9f882e 100644 --- a/docs/DeveloperGuide.adoc +++ b/docs/DeveloperGuide.adoc @@ -179,11 +179,13 @@ image::SDforDeleteMedicine.png[width="800"] The sections below give more details of each component. +// tag::uicomponent[] [[Design-Ui]] === UI component .Structure of the UI Component image::UiClassDiagram.png[width="800"] +// end::uicomponent[] *API* : link:{repoURL}/src/main/java/seedu/address/ui/Ui.java[`Ui.java`] @@ -857,6 +859,7 @@ A project often depends on third-party libraries. For example, MediTabs depends . Require developers to download those libraries manually (this creates extra work for developers) [appendix] +// tag::userstories[] == User Stories Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (unlikely to have) - `*` @@ -899,6 +902,7 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un |`*` |pharmacist |save information on medicine's usage |remind myself of its usage |======================================================================= +// end::userstories[] [appendix] // tag::usecase[] @@ -995,6 +999,7 @@ Use case resume at step 2. // end::usecase[] [appendix] +// tag::nonfunctionalreq[] == Non Functional Requirements . User Constraints @@ -1015,7 +1020,7 @@ Use case resume at step 2. . Testability .. Avoid implementing features that are difficult to test manually and automatically. i.e, avoid dependence on remote APIs as their behaviours are beyond our control. .. Due to the project's constraints, audio related features were not taken into consideration. Avoid any features using audio indicators. - +// end::nonfunctionalreq[] [appendix] diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index cbb02c64bda0..a74438a2f54f 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -83,10 +83,12 @@ image::UserGuide_ApplicationInterface.png[width="1000"] * The list of medicine running low on stock or expiring soon medicine will be displayed in the warning panel to notify the user. * Warnings will be logged in the warnings panel until action has been taken to either remove or update the medicine. +// tag:featureintro[] [[Features]] == Features As an inventory management application, MediTabs supports basic functionalities (add, edit, delete, list). On top of these basic functions, MediTabs also boasts several features tailored to your needs. These features aim to streamline your inventory management process, thereby enhancing your user experience. +// end:featureintro[] === Information Panel .Information panel @@ -100,7 +102,7 @@ You can easily refer to the batch table provided in the information panel while You can also sort the table by any of its columns with the `sort` command to suit your needs and preference. You may refer to <> for more details. - +// tag::warningpanelfeature[] === Warning Panel .Warning panel @@ -113,6 +115,7 @@ The warning panel provides an overview of the most pressing issues that have to On top of that, the panel features flexible thresholds to determine what is expiring and what is low in stock. These thresholds can be changed according your own preferences and needs with a simple command. You can learn about related commands related in <>. +// end::warningpanelfeature[] // tag::exportingascsvfileformat[] === Exporting as CSV file format @@ -353,6 +356,7 @@ Updates quantity and expiry date of batch `s9c4x9532` in batch records of the 2n Updates quantity of batch `8937v1x7` in batch records of the 1st medicine in the results of the `find` command to `500`. //end::update[] +// tag::warningpanelcommand[] [[WarningPanel]] === Managing the warning panel : `warning` @@ -376,6 +380,7 @@ Medicines with expiry dates within 10 days to expiry from today will be displaye Medicines with quanities of less than or equal to 20 will be displayed in the warning panel. * `warning show` + Current thresholds used for the warning panel will be shown. +// end::warningpanelcommand[] // tag::exportcommand[] [[ExportCommand]] diff --git a/docs/team/flxffy.adoc b/docs/team/flxffy.adoc new file mode 100644 index 000000000000..ef21c28f865b --- /dev/null +++ b/docs/team/flxffy.adoc @@ -0,0 +1,64 @@ += Ong Ai Hui - Project Portfolio +:site-section: AboutUs +:imagesDir: ../images +:stylesDir: ../stylesheets + +== PROJECT: MediTabs + +--- + +== Overview + +MediTabs is a desktop inventory management application used by pharamcists to keep track of medicines in a clinic. 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. + +== Summary of contributions + +* *Major enhancement*: Added a warning panel and its related commands +** What it does: Gives users an overview of what medicines are expiring, expired and low in stock. Thresholds used for the determination of what medicines are considered expiring and what are low in stock can be set by the user via the command line. +** Justification: Simplifies the process of sieving through an inventory to take stock of expiring or expired medicines that need to be disposed of, and medicines that require replenishing. The flexible threholds add customisability to the feature. +** Highlights: Offers users a way to get the information they need quickly, while also providing customisability by allowing users to set their own thresholds. To achieve this, an additional column had to be rendered in the application's user interface to accomodate the warning panel. Furthermore, to add on to the user experience, the thresholds set by the user in previous session are saved and reused for later sessions. + +* *Minor enhancement*: - + +* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_ + +* *Other contributions*: + +** Project management: +*** Updated the GUI colour scheme (Pull request https://github.com/CS2103-AY1819S2-T12-3/main/pull/134[#134]) +*** Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests https://github.com/CS2103-AY1819S2-T12-3/main/pull/139[#139], https://github.com[#38]) +** Documentation: +*** Restructured existing contents of the User Guide: https://github.com/CS2103-AY1819S2-T12-3/main/pull/151[#151] + +== 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=featureintro] + +include::../UserGuide.adoc[tag=warningpanelfeature] + +include::../UserGuide.adoc[tag=warningpanelcommand] + +include::../UserGuide.adoc[tag=dataencryption] + +== 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=uicomponent] + +include::../DeveloperGuide.adoc[tag=warningpanel] + +include::../DeveloperGuide.adoc[tag=dataencryption] + +include::../DeveloperGuide.adoc[tag=userstories] + +include::../DeveloperGuide.adoc[tag=usecase] + +include::../DeveloperGuide.adoc[tag=nonfunctionalreq] diff --git a/docs/team/johndoe.adoc b/docs/team/johndoe.adoc deleted file mode 100644 index 453c2152ab9d..000000000000 --- a/docs/team/johndoe.adoc +++ /dev/null @@ -1,72 +0,0 @@ -= John Doe - Project Portfolio -:site-section: AboutUs -:imagesDir: ../images -:stylesDir: ../stylesheets - -== PROJECT: AddressBook - Level 4 - ---- - -== Overview - -AddressBook - Level 4 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. - -== Summary of contributions - -* *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*: 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}_ - -* *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] -** 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}_ - -== 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=undoredo] - -include::../UserGuide.adoc[tag=dataencryption] - -== 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=undoredo] - -include::../DeveloperGuide.adoc[tag=dataencryption] - - -== PROJECT: PowerPointLabs - ---- - -_{Optionally, you may include other projects in your portfolio.}_ From 4a7d354bce889072e9859f04b07de55a177941e1 Mon Sep 17 00:00:00 2001 From: flxffy Date: Tue, 2 Apr 2019 23:35:10 +0800 Subject: [PATCH 2/2] typo --- docs/team/flxffy.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/team/flxffy.adoc b/docs/team/flxffy.adoc index ef21c28f865b..d55656dc6faa 100644 --- a/docs/team/flxffy.adoc +++ b/docs/team/flxffy.adoc @@ -9,7 +9,7 @@ == Overview -MediTabs is a desktop inventory management application used by pharamcists to keep track of medicines in a clinic. 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. +MediTabs is a desktop inventory management application used by pharmacists to keep track of medicines in a clinic. 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. == Summary of contributions