Create use case - Githubissues

ZiggyMaes commented 8 years ago

Create a use case to visualize the functional analysis of the project.

ZiggyMaes commented 8 years ago

@axd1967 Can you suggest software to design this use case? Or shall I write it down in plain text ( we obviously have the assignment document already, so I guess no?)?

axd1967 commented 8 years ago

(I liked StarUML http://sourceforge.net/projects/staruml/ but that is Windows, and now paying)
a flat text file Project/doc/usecases.md or something (advantage over the wiki: it will evolve together with the repo code)
list all the use cases
see https://en.wikipedia.org/wiki/Use_case#Examples, limit to
- Title (include an ID )
- Brief, short description
how about using http://www.planttext.com/planttext, and copy-paste the text in one or more text files?

axd1967 commented 8 years ago

tip: when creating branches such as Analysis, usually this goes together with some task, or issue.

So, make sure to have an issue that goes with a branch. also, make a habit to name your branches like this: issue/<issuenumer>_sometext, e.g. issue/234_analysis

you will discover in you .git/refs/ (look under heads and remotes) that all your branches are grouped in a subdirectory "issues/". some IDE also allow to take profit from this (e.g. SourceTree).

axd1967 commented 8 years ago

[x] make sure that each use case refers to a GitHub issue where the use case is implemented so you are sure all use cases are covered
[x] make sure that each issue refers to a use case (and maybe create a "use case" label, and I think your label "feature" is ok for that) so you are sure all issues are relevant. this requires to number the use cases (UC-001, UC-002); more handy is to use the issue number as use case number (UC-123 refers to issue/123).
[x] each use case could be checklisted in a single test issue

ZiggyMaes commented 8 years ago

See 9863b61 for use cases, this okay? Seems good enough for this project.

axd1967 commented 8 years ago

there are file extensions missing?

ZiggyMaes commented 8 years ago

Apologies: fa3a362

axd1967 commented 8 years ago

a user has many ratings
a message has many ratings
a system user is not a superuser
a superuser is a user (otherwise a superuser cannot behave like a normal user)

ZiggyMaes commented 8 years ago

System is not a user. It is meant to illustrate that superusers can be appointed either manually by an administrator, or automatically by an automated script ( #8 ).

Could you please indicate what part of the analysis you're referring to?

axd1967 commented 8 years ago

I would not say that "system IS A SuperUser", because System will never create threads, for example
but a Superuser should also be a user, otherwise he can't participate as normal user.

axd1967 commented 8 years ago

indeed , system will appoint a Superuser, but that is a use case; don't use inheritance (from Systemuser --> Superuser) for that.

ZiggyMaes commented 8 years ago

That makes sense :).

Patched cd327791dac130997a21838e02b0372e11b89f78 . Okay to merge with master?

axd1967 commented 8 years ago

yup

axd1967 commented 8 years ago

(btw, you removed the System user and the (promote) case? )

axd1967 commented 8 years ago

careful: there are also changes in the other diagram: (see remote 64fafe53cfa443986e2c2cb085655713794040c2)

class_analysis

ZiggyMaes commented 8 years ago

Added relation between user and rating (93aab3ca9b2075274292a91bd89165fdc4602f9f). Did not implement area since all areas are static and hard scripted.

ZiggyMaes commented 8 years ago

Assuming closed and merging if no reply follows.

ZiggyMaes commented 8 years ago

Merged.

axd1967 commented 8 years ago

(fetch 01d80be3f5f3dced2e99046472e7980c73086647 -> I've added a few more ideas)

(BTW, I can use a PyCharm/Android Studio IDE plugin : maybe there is a plugin for your IDE, check http://plugins.jetbrains.com/plugin/?idea&id=7017)

class_analysis use_cases

axd1967 commented 8 years ago

about Area: you probably need to add two fields to User class fetch! clipboard01

ZiggyMaes commented 8 years ago

Thanks! :) I cannot seem to find your commit though, are you referring to 76e01ee ?

ZiggyMaes commented 8 years ago

I'm still having doubts regarding the area class. The properties you mention are irrelevant since they are hardcoded directly into the html. I'm not dynamically loading any area content (except for the messages). The only good reason I can think of for creating a separate area class, is if we had any plans to increase the amount of available domains. But since we're definitely not doing that, I fail to see any purpose for the extra class.

axd1967 commented 8 years ago

you will have to refer to specific areas from user records (area1, area2). now you are using strings for that, but you will have to store the area information "somehow", probably in a directory, or in a table.

when I write "class", I don't mean that you have to end up with a class in your code (C#, C++, Java, db table...). A class in analysis is simply a concept, an object that has properties. In the implementation there might be no physical class, but somewhere you will be able to say: "here is an (instance of an) area" and be able to refer to it (eg by using its name, as you intend to do). therefore, that is an object, that has properties, and thus it is an instance of a class, and that is how you can document it in the Class analysis diagram.

ZiggyMaes commented 8 years ago

Thank you for the clarification! :+1:

axd1967 commented 8 years ago

(idem here, add a link to the Use case diagram in the top comment. not necessary)

ZiggyMaes / NMCT-Server-Side-Applications

Create use case #25