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 docs #149

Merged
merged 137 commits into from
Nov 7, 2016
Merged

Update docs #149

merged 137 commits into from
Nov 7, 2016

Conversation

INCENDE
Copy link

@INCENDE INCENDE commented Oct 29, 2016

Shifted the to-dos here. Fixes #104

  • User guide should have clear correspondence to user stories
  • Insight from product survey
  • More NFRs than the handbook
  • Make it more informal like 2101, directly address the user
  • Do not use terms unfamiliar to user e.g. floating task
  • Introduction: each task has a index... before describing deleting tasks
  • More examples
  • App behavior: How the app responds so that the user can verify his/her action was correct by comparing the actual app behavior to the expected behavior.
  • UI screenshots
  • Add examples to command summary
  • Content page

Developer Guide

  • Compare with other alternative designs possible.
  • Add more descriptions e.g. show at least one interaction (i.e. sequence diagrams) within each component. But this doesn't mean to add more verbose text about trivial and unstable things.
  • Use object diagrams to show the object structure at runtime
  • Use activity diagrams and OO domain models where applicable (covered in yesterday's lecture)
  • Explain how they implemented things such as undo/redo (since they weren't given features in AddressBook Level 4)
  • explain other interesting design decisions you made.
  • sequence diagram for other command e.g. add?

@rachx
Copy link

rachx commented Nov 7, 2016

Updated about us again (add more features and change the links to match the sub-headers of the new user guide))

@rachx
Copy link

rachx commented Nov 7, 2016

Tick if you are okay with the files and ready to merge.

Rachael

  • User guide
  • Developer guide - think the justification for singleton/ add, schedule use cases should be updated but not changing it.

Weiguang

  • User guide
  • Developer guide

Justin

  • User guide
  • Developer guide

Vishnu

  • User guide
  • Developer guide

@@ -74,7 +75,8 @@ protected Stage createDialogStage(String title, Stage parentStage, Scene scene)
* @param iconSource e.g. {@code "/images/help_icon.png"}
*/
protected void setIcon(String iconSource) {
primaryStage.getIcons().add(AppUtil.getImage(iconSource));
// primaryStage.getIcons().add(AppUtil.getImage(iconSource));
primaryStage.getIcons().add(new Image(this.getClass().getResourceAsStream(iconSource)));

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is there commented code here?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, what does this code change?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

O forgot to delete it !!!

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 👍

Copy link

@burnflare burnflare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To merge after addressing commented code

@rachx
Copy link

rachx commented Nov 7, 2016

should we add sync interface in the diagram?

@burnflare
Copy link

@rachx To the Model diagram? Can you help me do it, I don't have PPT installed. 🎱

@burnflare burnflare merged commit fb0f9c1 into master Nov 7, 2016
@burnflare burnflare deleted the update-guides-for-v0.4 branch November 7, 2016 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants