-
Notifications
You must be signed in to change notification settings - Fork 82
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
[T7][F11-B2] #44
base: master
Are you sure you want to change the base?
[T7][F11-B2] #44
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You must be clear what you are going to build at the end. Basically, it's like implement the user guide step by step. Thus, it is better (required) to complete the user guide at the beginning.
README.md
Outdated
@@ -1,36 +1,25 @@ | |||
# Address Book (Level 4) | |||
# main |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe you want to change main
to your app name. :P
README.md
Outdated
[](https://coveralls.io/github/se-edu/addressbook-level4?branch=master) | ||
[](https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade) | ||
[](https://travis-ci.org/CS2103JAN2017-F11-B2/main) | ||
[](https://ci.appveyor.com/project/damithc/main) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not the correct update for appveyor.
BTW, if you don't want appveyor, you can just delete it.
README.md
Outdated
[](https://travis-ci.org/CS2103JAN2017-F11-B2/main) | ||
[](https://ci.appveyor.com/project/damithc/main) | ||
[](https://coveralls.io/github/CS2103JAN2017-F11-B2/main?branch=master) | ||
[](https://www.codacy.com/app/damith/main?utm_source=github.com&utm_medium=referral&utm_content=CS2103JAN2017-F11-B2/main&utm_campaign=Badge_Grade) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not the correct update.
Refer to the Codacy badge for more information.
README.md
Outdated
|
||
#### Site Map | ||
* [User Guide](docs/UserGuide.md) | ||
* [Developer Guide](docs/DeveloperGuide.md) | ||
* [Learning Outcomes](docs/LearningOutcomes.md) | ||
* [About Us](docs/AboutUs.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are supposed to give About Us
page. Refer to the module website for more information.
README.md
Outdated
|
||
<img src="docs/images/Ui.png" width="600"><br> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have UI prototype or mockup?
@@ -1,186 +1,85 @@ | |||
# AddressBook Level 4 - User Guide | |||
# User Guide |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure you fulfill all the must-to-have features. :)
docs/UserGuide.md
Outdated
|
||
## Adding a task : `add` | ||
Adds a task to the task manager<br> | ||
Format: `add TASKNAME DATE [STARTTIME] [ENDTIME] VENUE DESCRIPTION` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think about the user experience. Does user need to remember the order of parameters? How the user will know which one is STARTTIME, which one is ENDTIME and etc.
docs/UserGuide.md
Outdated
### 2.6. Deleting a person : `delete` | ||
## Deleting a task : `delete` | ||
Deletes a specified tasks from the task manager. Irreversible.<br> | ||
Format: `delete TASKNAME` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider: Is the TASKNAME exact match or keyword match. How are you going to do if there are multiple tasks founded. Delete them all?
docs/UserGuide.md
Outdated
### 2.7. Select a person : `select` | ||
## View description of a task : `view` | ||
Displays details of the specified task.<br> | ||
Format: `view TASKNAME` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here. Multiple matched tasks?
docs/UserGuide.md
Outdated
Format: `clear` | ||
|
||
### 2.9. Exiting the program : `exit` | ||
## Clearing all entries : `delete` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Type here delete
. Should be clear
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For developer guide. :)
Good work, Keep it up!
@@ -1,6 +1,6 @@ | |||
# AddressBook Level 4 - Developer Guide |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remember to update the Design when you make changes to the code base.
You don't want to push the documentations thing in the end right?
docs/DeveloperGuide.md
Outdated
`* * *` | user | find a person by name | locate details of persons without having to go through the entire list | ||
`* *` | user | hide [private contact details](#private-contact-detail) by default | minimize chance of someone else seeing them by accident | ||
`*` | user with many persons in the address book | sort persons by name | locate a person easily | ||
`* * *` | user | add a new task| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Impressive features :)
But remember that you don't have enough time to implement every features, better prioritise them and schedule them in the milestones.
docs/DeveloperGuide.md
Outdated
|
||
#### Use case: Delete person |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to see you have use cases.
Remember you can follow the interaction in use cases to implement the feature (as actually this how use cases are supposed to work).
Updated Aboutus, developer guide and learningoutcomes
V0.0