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.

Sign up for GitHub

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

[T4A4] [T01-T3] Ang Lang Yi #6

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[T4A4] [T01-T3] Ang Lang Yi #6

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ce9c90
Added user stories
Jul 4, 2017
628d737
Deleted unnecessary files
Jul 4, 2017
656d739
Added use case
Jul 4, 2017
f71d134
Added NFR
Jul 4, 2017
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
27 changes: 27 additions & 0 deletions doc/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ Priority | As a ... | I want to ... | So that I can...
`* * *` | user | add a new person |
`* * *` | user | delete a person | remove entries that I no longer need
`* * *` | user | find a person by name | locate details of persons without having to go through the entire list
`* * *` | user | edit the details of a person | correct any errors I made during input
`* *` | user | hide [private contact details](#private-contact-detail) by default | minimize chance of someone else seeing them by accident
`* *` | user | use shortcuts of commands | use the appliation easily
`*` | user with many persons in the address book | sort persons by name | locate a person easily


Expand Down Expand Up @@ -74,12 +76,37 @@ Use case ends.
> 3a1. AddressBook shows an error message <br>
Use case resumes at step 2

#### Use case: Rename tag

**MSS**

1. User requests to edit tag details
2. AddressBook requests confirmation
3. User confirms the edit
Use case ends if false, continue to 4 if true.
4. AddressBook edits tag if confirmed
Use case ends.

**Extensions**

1a. Invalid tag details

> 1a1. AddressBook shows an error message <br>
Use case resumes at step 2

2a. The tag does not exist

> Use case ends


## Appendix C : Non Functional Requirements

1. Should work on any [mainstream OS](#mainstream-os) as long as it has Java 8 or higher installed.
2. Should be able to hold up to 1000 persons.
3. Should come with automated unit tests and open source code.
4. Should favor DOS style commands over Unix-style commands.
5. Should take up less than 500mb of space.
6. Should Automatically save to local repository.

## Appendix D : Glossary

Expand Down