Sequence Diagram Creation Guideline

[GoogleCodeExporter]

We have Updated the class diagram for a better workflow. 

In the class diagram, there are three main parties: 

-User
-User Interface
-System Components: (System, Cases, Contibutions, Comments, etc..)

For a workflow, at first User interacts with UserInterface, and requests a 
form/button/view. like: showCaseCreationForm() or showLoginForm(). These 
methods generally start with "show"

then user clicks a button or fills in a form in the User Interface, which is 
calling another UserInterface method like: userEnteredComment(), 
createCaseFromFormData(), or userReportsUser(). These methods generally start 
with "user", and indicates an action of User on the UserInterface. 

Then, userInterface calls the required system component's method like addCase 
method of the System class, addComment method of the Case class, or addRating 
method of the Contribution class, etc.. 

So the user communicates with UI, and UI communicates with system. 

Original issue reported on code.google.com by mustafat...@gmail.com on 23 Mar 2015 at 1:10

[GoogleCodeExporter]

Login flow is unnecessary for the sequence diagrams with a use case with 
precondition : "user must be logged in"

Original comment by mustafat...@gmail.com on 23 Mar 2015 at 1:22

[GoogleCodeExporter]

However, there are some redundant methods in the system. Following this 
guideline will reveal them, and we'll delete them later

Original comment by mustafat...@gmail.com on 23 Mar 2015 at 1:59

[GoogleCodeExporter]

When user requests an information like: showCommentsOfCase() from the 
interface, the interface communicates with the system component to get the 
required information like Case::getComments(), then returns the acquired 
information. 

Original comment by mustafat...@gmail.com on 23 Mar 2015 at 3:09