Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentations, including tag limit #244

Merged
merged 11 commits into from Nov 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
272 changes: 250 additions & 22 deletions docs/DeveloperGuide.adoc

Large diffs are not rendered by default.

37 changes: 19 additions & 18 deletions docs/UserGuide.adoc
Expand Up @@ -16,7 +16,6 @@ endif::[]

By: `Team CS2103T-F13-3` Since: `Sep 2019` Licence: `MIT`

// tag::introduction[]
== Introduction

*MoneyGoWhere* is a personal finance application targeted to students at the National University of Singapore (NUS).
Expand Down Expand Up @@ -44,6 +43,8 @@ Tips that can help you better navigate the application.
Useful information for a deeper understanding of the command.
====

Without further ado, let's head over to <<Quick Start>> to get started!

== Quick Start

These steps will guide you in installing MoneyGoWhere on your computer.
Expand All @@ -69,9 +70,12 @@ e.g. typing *`help`* will display the help information.

. When you are ready to get started on tracking your own finances, do type `clear` in the command box and press kbd:[Enter].
This removes all the sample data from the application.
. You can refer to <<Features>> for more details about each command.

// end::introduction[]
This is the end of the Quick Start tutorial. You can refer to <<Features>> for more details about each command.

[NOTE]
Your data is saved in the `data/` folder by default. You are advised not to modify any of the system created files within the folder,
else *MoneyGoWhere* may not perform as expected.

[[Features]]
== Features
Expand Down Expand Up @@ -183,7 +187,7 @@ Edits a spending at a specified index in the list. +
* At least one of the optional fields must be provided.
* Existing values will be updated to the input values.
* When editing tags, the existing tags of the spending will be removed i.e adding of tags is not cumulative.
* Tags can have up to 64 characters.
* Tags can have up to 15 characters.
* You can remove all the spending's tags by typing `t/` without specifying any tags after it.
* If a spending date is in the future, it can only be up to end of this month.
* Spending entries that are added using a different currency will have output displayed in SGD.
Expand Down Expand Up @@ -394,6 +398,11 @@ All available exchange rates are shown, or a conversion of an input currency is
Organises the spending based on tags.
A pie chart is generated, with each sector representing the total amount of money spent on a tag.
This enables users to be more informed of their spending habits as they are now aware of where they have spent most of their money on.
An example is shown below.

.Output of `stats`
image::stats.png[width="700"]


*Format:* `stats d/DATE_START d/DATE_END`

Expand Down Expand Up @@ -427,13 +436,8 @@ The statistics panel will update with the currency set.

* `stats`: Generates statistics for all spending.

.Output of `stats`
image::allstats.png[width="700"]

* `stats d/20/10/2019 d/25/10/2019`: Generates statistics for spending between and including 20/10/2019 and 25/10/2019.

.Output of `stats d/20/10/2019 d/25/10/2019`
image::daterangestats.png[width=700"]

*Expected Output:*

Expand All @@ -445,6 +449,10 @@ Statistics is shown.
=== Generating a graph : `graph`
Organises the spending based on date. A line graph is generated, with each point representing the total amount of money spent on a particular date.
This enables users to analyze trends in their spending amount over a particular period of time.
An example is shown below.

.Output of `graph`
image::graph.png[width="700"]

*Format:* `graph d/DATE_START d/DATE_END`

Expand Down Expand Up @@ -476,15 +484,8 @@ The graph panel will update with the currency set.
*Examples:*

* `graph`: Generates a graph for all spending.

.Output of `graph`
image::allgraph.png[width="700"]

* `graph d/20/10/2019 d/25/10/2019`: Generates a graph for spending between and including 20/10/2019 and 25/10/2019.

.Output of `graph d/20/10/2019 d/25/10/2019`
image::daterangegraph.png[width="700"]

*Expected Output:*

A graph is shown.
Expand Down Expand Up @@ -699,9 +700,9 @@ e.g. `exchangerate`, `exchangerate 5 USD`
e.g. `budget 18000`
| *Show Budget* | `showbudget` +
e.g. `showbudget`
| *Generate statistics*| `stats d/STARTDATE d/ENDDATE` +
| *Generate statistics*| `stats d/DATE_START d/DATE_END` +
e.g. `stats d/01/01/2019 d/07/01/2019` +
| *Graph*| `graph d/STARTDATE d/ENDDATE` +
| *Graph*| `graph d/DATE_START d/DATE_END` +
e.g. `graph d/01/01/2019 d/07/01/2019` +
| *Import data*| `import p/FILE_PATH` +
e.g. `import p/C:\Users\User\Documents\importfile.csv` +
Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams/GraphSequenceDiagram.puml
Expand Up @@ -55,7 +55,7 @@ deactivate SpendingBookParser
LogicManager -> GraphCommand : execute()
activate GraphCommand

GraphCommand -> Model : updateStatsPredicate(predicate)
GraphCommand -> Model : updateFilteredSpendingList(predicate)
activate Model

Model --> GraphCommand
Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams/StatsSequenceDiagram.puml
Expand Up @@ -55,7 +55,7 @@ deactivate SpendingBookParser
LogicManager -> StatsCommand : execute()
activate StatsCommand

StatsCommand -> Model : updateStatsPredicate(predicate)
StatsCommand -> Model : updateFilteredSpendingList(predicate)
activate Model

Model --> StatsCommand
Expand Down
Binary file modified docs/images/GraphSequenceDiagram.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/StatsSequenceDiagram.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/allgraph.png
Binary file not shown.
Binary file removed docs/images/allstats.png
Binary file not shown.
Binary file removed docs/images/daterangegraph.png
Binary file not shown.
Binary file removed docs/images/daterangestats.png
Binary file not shown.
Binary file added docs/images/graph.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/stats.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 18 additions & 17 deletions docs/team/choongyx.adoc
Expand Up @@ -7,14 +7,14 @@

MoneyGoWhere is a finance application built by my team and I as part of a Software Engineering Project.
It was morphed from a basic command line interface Address Book.
MoneyGoWhere is designed to help students to keep track of all their spending and their related information such as date, cost and tags.
MoneyGoWhere is a personal finance application targeted at students at the National University of Singapore (NUS).
It is designed to help students to keep track of all their spending and their related information such as date, cost and tags.
Notable features include allowing users to set budget goals, view statistics, set reminders for bills and export their data to a .csv file.

=== My Role

My role was to implement the statistics and graph features which are essential in allowing users analyze their spending habits.
My role was to implement the statistics and graph features.
The following sections will illustrate these features in greater detail.
These include the implementation details and also other contributions and relevant sections I have recorded in the User Guide and Developer Guide.

Below are a few icons and formatting which will be used in this document.

Expand All @@ -36,14 +36,16 @@ Additional useful information for this section.
This section shows a summary of contributions I have made for the project.

* *Major enhancement*: I implemented the *statistics feature*.

** What it does: It allows the user to view their spending in the form of a pie-chart which organises the user's expenditure based on tags.
** Justification: This feature enhances the product significantly as it enables users to view their spending in the form of figures which is easier to read than text.
It allows them to be more informed of their spending habits as they will be more aware of what they have spent their money on.
** Justification: This feature enhances the product significantly as it enables users to view their spending in the form of figures which is more reader-friendly.
Furthermore, it allows users to be more informed of their spending habits as they are now aware of where they have spent most of their money on, enabling them to reflect on their spending habits.
** Highlights: This enhancement required an in-depth understanding of the software architecture as it involves multiple components of the application.

* *Minor enhancement*: I implemented the *graph feature*.
** What it does: It allows the user to view their spending in the form of a graph based on a date range provided.
** Justification: This enables the user to easily track their spending by providing an overview of their spending within a specified date range.
** What it does: It organises the user's expenditure based on date, allowing users to view their daily expenditure based on a date range provided.
** Justification: It enables users to view how much they spend daily and also enable them to analyze trends in their spending amount over a particular period of time.
This helps them to better analyze their spending habits.
** Highlights: This enhancement also required an in-depth understanding of the software architecture as it involves multple components of the application.

* *Code contributed*: [https://nus-cs2103-ay1920s1.github.io/tp-dashboard/#=undefined&search=choongyx[Collated code]]
Expand All @@ -61,11 +63,12 @@ https://github.com/AY1920S1-CS2103T-F13-3/main/pull/71[#71])
** Documentation:
*** Vetted and formatted the entire User Guide after individual contributions by team members. (Pull request https://github.com/AY1920S1-CS2103T-F13-3/main/pull/101[#101])
*** Reviewed team member's documentations. (Pull requests
https://github.com/AY1920S1-CS2103T-F13-3/main/pull/80[#80]
https://github.com/AY1920S1-CS2103T-F13-3/main/pull/80[#80],
https://github.com/AY1920S1-CS2103T-F13-3/main/pull/85[#85],
https://github.com/AY1920S1-CS2103T-F13-3/main/pull/98[#98])
*** Updated Quick Start section and created a set of symbols/legends for User Guide (Pull requests https://github.com/AY1920S1-CS2103T-F13-3/main/pull/50/files[#50], https://github.com/AY1920S1-CS2103T-F13-3/main/pull/101[#101])
*** Collated and updated profiles for all members of the team. (Pull request https://github.com/AY1920S1-CS2103T-F13-3/main/pull/7/files[#7])
*** Updated SettingUp, Documentation, Testing and DevOps sections of Developer Guide (Pull request https://github.com/AY1920S1-CS2103T-F13-3/main/pull/244/files[#244])

** Community:
*** PRs reviewed with non-trivial review comments (Pull requests
Expand All @@ -76,19 +79,16 @@ https://github.com/AY1920S1-CS2103T-F13-3/main/pull/81[#81]
*** Conducted manual testing, reported bugs and offered suggestions for our team
(Examples: https://github.com/AY1920S1-CS2103T-F13-3/main/issues/128[1],
https://github.com/AY1920S1-CS2103T-F13-3/main/issues/122[2],
https://github.com/AY1920S1-CS2103T-F13-3/main/issues/125[3],
https://github.com/AY1920S1-CS2103T-F13-3/main/issues/124[4],
https://github.com/AY1920S1-CS2103T-F13-3/main/issues/120[5],
https://github.com/AY1920S1-CS2103T-F13-3/main/issues/115[6],
https://github.com/AY1920S1-CS2103T-F13-3/main/issues/114[7],
https://github.com/AY1920S1-CS2103T-F13-3/main/issues/119[8])
https://github.com/AY1920S1-CS2103T-F13-3/main/issues/125[3])
*** Conducted manual testing, reported bugs and offered suggestions for other teams in the class
(Examples: https://github.com/AY1920S1-CS2103T-T10-1/main/issues/246[1],
https://github.com/AY1920S1-CS2103T-T10-1/main/issues/242[2],
https://github.com/AY1920S1-CS2103T-T10-1/main/issues/244[3])

== Contributions to the User Guide

Given below are sections I contributed to the User Guide, which include the Introduction, How To Use This Guide, Quick Start, Statistics feature and Graph feature.

include::../UserGuide.adoc[tag=introduction]
Given below are sections I contributed to the User Guide for the Statistics feature and Graph feature.
They showcase my ability to write documentation targeting end-users.

include::../UserGuide.adoc[tag=statistics]

Expand All @@ -97,6 +97,7 @@ include::../UserGuide.adoc[tag=graph]
== Contributions to the Developer Guide

Given below are sections on the implementation of the Statistics feature and Graph feature I have worked on.
They showcase my ability to write technical documentation and the technical depth of my contributions to the project.

include::../DeveloperGuide.adoc[tag=statistics]
include::../DeveloperGuide.adoc[tag=graph]
Expand Down