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

V0.5rc update docs #122

Merged
merged 5 commits into from
Nov 3, 2016
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 36 additions & 14 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ b. Require developers to download those libraries manually (this creates extra w
Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`


Priority | As a ... | I want to ... | So that I can...
Priority | As a(n) ... | I want to ... | So that I can...
-------- | :-------- | :--------- | :-----------
`* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App
`* * *` | new user | view more information about a particular command | learn how to use various commands
Expand All @@ -309,17 +309,17 @@ Priority | As a ... | I want to ... | So that I can...
`*` | user | sort tasks by priority level | see the most important tasks and prioritize accordingly
`*` | user | undo most recent command | undo the most recent operation
`*` | user | redo most recent undo command | redo the operation done by the most recent undo action
`*` | user | change storage location | choose where my tasks are saved at
`*` | advanced user | alias keywords with shorter versions | type a command faster
`*` | advanced user | remove alias of keywords with shorter versions | get rid of shorter version of certain keywords
{More to be added}

## Appendix B : Use Cases

[//]: # (@@author A0097627N)

(For all use cases below, the **System** is the `Savvy Tasker` and the **Actor** is the `user`, unless specified otherwise)

#### Use case: Add task
### Use case: Add task

**MSS**

Expand Down Expand Up @@ -349,7 +349,7 @@ Use case ends.
> 2d1. Savvy Tasker shows an error message <br>
> Use case resumes at step 1

#### Use case: List tasks
### Use case: List tasks

**MSS**

Expand All @@ -365,7 +365,7 @@ Use case ends.
> 3a1. Savvy Tasker shows an error message <br>
Use case ends

#### Use case: Find task
### Use case: Find task

**MSS**

Expand All @@ -386,7 +386,7 @@ Use case ends.
> Use case ends


#### Use case: Modify task
### Use case: Modify task

**MSS**

Expand All @@ -411,7 +411,30 @@ Use case ends.
> 2b1. Savvy Tasker shows an error message and display the expected format <br>
Use case resumes at step 3

#### Use case: Mark task as done

### Use case: Change storage location

**MSS**

1. Savvy Tasker waits for user command
2. User requests to change the storage location of Savvy Tasker
3. Savvy Tasker changes the storage location, saving all existing data in the new location <br>
Use case ends.

**Extensions**

2a. The given path is invalid

> 2a1. Savvy Tasker shows an error message <br>
Use case ends

2b. The given path is is not accessible (read/write) by Savvy Tasker

> 2b1. Savvy Tasker shows an error message <br>
Use case ends


### Use case: Mark task as done

**MSS**

Expand All @@ -434,7 +457,7 @@ Use case ends.
> 3b1. Savvy Tasker shows a 'task already marked' error message.<br>
> Use case resumes at step 1

###Use case: Unmark marked task
### Use case: Unmark marked task

**MSS**

Expand All @@ -455,7 +478,7 @@ Use case ends.
> Use case resumes at step 1


#### Use case: Delete task
### Use case: Delete task

**MSS**

Expand All @@ -477,7 +500,7 @@ Use case ends.
> 4a1. Savvy Tasker shows an error message
> Use case resumes at step 3 <br>

###Use case: Alias keyword and use shorten keyword
### Use case: Alias keyword and use shorten keyword

**MSS**

Expand All @@ -499,7 +522,7 @@ Use case ends.
> 2b1. Savvy Tasker shows a error message and the shorten keyword's original associated keyword
> Use case resumes at step 1 <br>

###Use case: Unalias keyword
### Use case: Unalias keyword

**MSS**

Expand All @@ -514,7 +537,7 @@ Use case ends.
> 2a1. Savvy Tasker shows a 'not found' error message
> Use case resumes at step 1 <br>

###Use case: Undo previous command
### Use case: Undo previous command

**MSS**

Expand All @@ -529,7 +552,7 @@ Use case ends.
> 2a1. Savvy Tasker shows a 'cannot undo' error message <br>
> Use case ends

###Use case: Redo most recently undone command
### Use case: Redo most recently undone command

**MSS**

Expand All @@ -555,7 +578,6 @@ Use case ends.
8. Should store data in text file.
9. Should work without requiring an installer.

{More to be added}

## Appendix D : Glossary

Expand Down
21 changes: 17 additions & 4 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,11 @@ Examples:

#### Listing all tasks: `list`
Shows a list of all tasks in Savvy Tasker <br>
Format: `list [t/LIST_TYPE]`
Format: `list [LIST_TYPE]`

> Parameters | Description
> -------- | :--------
> LIST_TYPE | `Optional` Specifies the name of the task.<br>`Accepts` values `DueDate`, `PriorityLevel`, `Archived`<br>`Defaults` to `DueDate`
> LIST_TYPE | `Optional` Specifies the name of the task.<br>`Accepts` values `DueDate`, `PriorityLevel`, `Archived`, `Alias`<br>`Defaults` to `DueDate`

`LIST_TYPE` Explanation:
* `DueDate` <br>
Expand All @@ -91,7 +91,9 @@ Format: `list [t/LIST_TYPE]`
* `PriorityLevel` <br>
Tasks are sorted according to priority level beginning with the highest.<br>
* `Archived` <br>
Tasks that have been [marked](#mark-a-task-as-done--mark) are listed. They are sorted according to the time of creation of the task.<br>
Tasks that have been [marked](#mark-a-task-as-done--mark) are listed. They are sorted according to the time of creation of the task.
* `Alias` <br>
[Aliases](#alias-a-keyword--alias) that have been registered are listed.<br>

#### Finding all task containing any keyword in its name: `find`
Finds tasks whose names contain any of the given keywords.<br>
Expand Down Expand Up @@ -151,6 +153,16 @@ Format: `modify INDEX [t/TASK_NAME] [s/START_DATE] [e/END_DATE] [l/LOCATION] [p/
> <br>
> Overwrites any of the specified fields ('LOCATION', 'DESCRIPTION'...) with the new values

#### Change storage location : `storage`
Changes the storage location of Savvy Tasker.<br>
Format: `storage PATH`

> Parameters | Description
> -------- | :--------
> PATH | `Mandatory` Specifies the path where Savvy Tasker's task list is saved at.
> <br>
> If the new storage location specified by `PATH` is not accessible by Savvy Tasker, no change will be made to the existing path.

[//]: # (@@author A0097627N)

#### Mark a task as done : `mark`
Expand Down Expand Up @@ -256,10 +268,11 @@ Command | Format
[Delete](#deleting-a-task--delete) | `delete INDEX [MORE_INDEX]`<br>Example: `delete 1 2 3`
[Exit](#exiting-the-program--exit) | `exit`
[Find](#finding-all-task-containing-any-keyword-in-its-name-find) | `find [t/FIND_TYPE] KEYWORD [MORE_KEYWORDS]`<br>Example: `find t/exact CS2103 Meeting`
[List](#listing-all-tasks-list) | `list [t/LIST_TYPE]`<br>Example: `list t/archived`
[List](#listing-all-tasks-list) | `list [LIST_TYPE]`<br>Example: `list archived`
[Help](#viewing-help--help) | `help`
[Modify](#modifies-a-task--modify) | `modify INDEX [t/TASK_NAME] [s/START_DATE] [e/END_DATE] [l/LOCATION] [p/PRIORITY_LEVEL] [r/RECURRING_TYPE] [n/NUMBER_OF_RECURRENCE] [c/CATEGORY] [d/DESCRIPTION]`<br>Example: `modify 2 t/Wednesday Weekly Milestone s/wed d/Project Meeting and Finalization`
[Mark](#mark-a-task-as-done--mark) | `mark INDEX [MORE_INDEX]`<br>Example: `mark 1 2 3`
[Storage](#change-storage-location--storage) | `storage PATH`<br>Example: `storage data/savvytasker.xml`
[Unmark](#unmark-a-task-as-done--unmark) | `unmark INDEX [MORE_INDEX]`<br>Example: `unmark 1 2 3`
[Undo](#undo-the-most-recent-operation--undo) | `undo`
[Redo](#redo-the-most-recent-undo-operation--redo) | `redo`
Expand Down