QA Checklist about clue HOT 18 CLOSED

Design Overview is missing.
I'm guessing our design overview should look something like this. https://wiki.csc.calpoly.edu/Surelock/wiki/DesignOverview

Additional, this overview should also appear in our javadocs overview, based on his little comment for his crazy eight example
https://xp-dev.com/trac/CrazyEights/wiki/HighLevelDesign

So the TODOs:

1. Remove the javadocs link under Design Overview
2. Create a Design Overview page like team Surelock
3. Create link for Design Overview page under Design Overview as well as javadocs overview

from clue.

Under Data Structures are all the data structures mentioned internal or external? we should clarify for both server and client.

from clue.

"Is each method name a verb phrase in active voice?"
In the server package for the AI class we have a method called play() I dont think it active voice. Should it be playTurn()?
Also for ServerController and ServerNetwork we have a method called send(), send what?

These changes will also need to be reflected in the Class Diagrams and the Interaction Diagrams. (and anywhere else)

from clue.

Interaction Diagram
"A diagram is provided for each use-case or functional requirement (that has more than two objects involved, or has more than four steps)?"
Sounds like were missing a lot of diagram..

Any comments?

from clue.

did anyone use the -private flag in their javadocs?

from clue.

for the client class diagram RevealCardRequest is overlapping AddAIRequest.

from clue.

DD and Class Diagram relationship

1. Accusation, Dealer, Deck, Location, Strategy, Template, and Theme is defined in the DD but is never mentioned in the diagram.
2. Is ClueCard the same as HintCard?

These two items need to be addressed somehow.

from clue.

Awesome job reviewing everything.

In regards to the overview document, per Dr. Dalbey's design document format: "Write this section as HTML and place it in the javadoc overview file." (http://users.csc.calpoly.edu/~jdalbey/308/Deliver/designDocFormat.html)

The javadoc overview file has our design overview.

from clue.

JAVADOCS:
He is looking for pre/post condition comment as well as error conditions.
We should be using something like a Natural class to represent data range.
Is there a comment included for each design element that traces it back to the SRS?

from clue.

So for the Design Overview, I found the overview.html in clue/Indication/src/overview.html, but its not linked to the javadocs..

from clue.

Agree on the AI change, changed play() to playTurn(), updated server UML, posted new image to wiki.

Changed ServerController, ServerNetwork, ClientController, and ClientNetwork send() and receive() and prompt() function names.

RevealCardRequest is overlapping AddAIRequest. -> this is fixed.

-private flag - is used in the compilation, we have a limited amount of javadoc comments on private variables and functions. These comments are hidden from the public javadocs.

ClueCard is the same as HintCard name changed due to copyright. I'll check with Bennett on the other common classes.

from clue.

The javadoc is missing the overview the last build must have broken the overview.html being linked in. I'll fix this and get back to you.

I still need to push the changes from my previous comment.

from clue.

Design Overview:
I had my roommate look over our design overview just now.

1. In this sentence, we should remove the word "design" because we are currently overloading game and my roommate wasn't sure what Indication was anymore.
   "The framework of the Indication game design is broken into several layers..."
2. Remove all the '.' in the first column in the Game State table.
3. Concrete example for common layer, i.e. base game object.
4. Message layer needs clarification. Are we using service calls, or are these classes serializable objects.
5. Most of the links in the tables Tools, Libraries, Extern. doesn't work.

from clue.

3-4 hours

from clue.

Added/Edit the overview file. Good recommendations, thank you.

The links will work if you right click, open new tab. I'll see if I can figure out why left click does not work.

from clue.

Brian Schacherer

4 hours editing quality.
3 hours fixing source control.

from clue.

So if anyone feels like updating the UML Class Diagrams, here are the things to change from the FTR we had last week.

Server:

1. CardDealResponse should be a composite of Player Card. Meaning at solid diamond on CardDealResponse side. An example of Player Card can be found in the bottom left corner.
2. ServerNetwork should aggregate ServerController as well. Add an additional connection between ServerController and ServerNetwork were the outlined diamond is on the ServerNetwork side.
3. Add dashed like between ServerNetwork and ServerController, arrow pointing at ServerNetwork.
4. Change Send() in ServerNetwork to sendMessage().
5. Change getSolution(): List in Game to getSolution(): List
6. Lines between ServerController and AI needs to be separated.
7. If possible combine all the Common blocks.

Client:

1. There are two ClientRequest blocks connected to ClientNetwork. one should be removed.
2. Arrow from ClientNetwork to AbstractClient goes through LeaveGameRequest. needs to be fixed.

Common:

1. Remove Interface Player.

Thank you!

from clue.

Retro
2 hours.
Edited and re-posted javadocs after fixing issues.

from clue.