Conversation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This pull request adds Assignment 3 documentation for CPW 207, introducing analysis artifacts including features and use cases, CRC (Class-Responsibility-Collaborator) cards, and a use case diagram for what appears to be a gaming platform with social features.
Changes:
- Added features list and use case definitions for a gaming platform
- Created CRC cards documenting class responsibilities and collaborations
- Added a use case diagram visualization (PNG image)
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/analysis/features-and-usecases.md | Defines system features, 8 use cases, a traceability matrix, and references the use case diagram |
| docs/analysis/crc-cards.md | Documents 5 CRC cards (Conversation, WebSocket, Message, Notification, Friend) with their responsibilities and collaborators |
| docs/analysis/use-case-diagram.png | Binary PNG image containing the use case diagram visualization |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Primary Actor: User | ||
| - Goal: User receives the site's library of games | ||
|
|
||
| ### UC7: User searches for a specific game, genera, etc. |
There was a problem hiding this comment.
The word "genera" appears to be a typo and should be "genre" (singular) or "genres" (plural). In the context of video games, "genre" refers to a category or type of game.
| | UC4: System sends an inbox letter to user | Register, Inbox Messages | | ||
| | UC5: System alerts user of achievement | Register, Achievement system, Toast Notifications | | ||
| | UC6: User views the Game Library | Game Library | | ||
| | UC7: User searches for a specific game, genera, etc. | Game Library, Search | |
There was a problem hiding this comment.
The word "genera" appears to be a typo and should be "genre" (singular) or "genres" (plural). In the context of video games, "genre" refers to a category or type of game.
| | UC5: System alerts user of achievement | Register, Achievement system, Toast Notifications | | ||
| | UC6: User views the Game Library | Game Library | | ||
| | UC7: User searches for a specific game, genera, etc. | Game Library, Search | | ||
| | UC6: User becomes friends with another user | Register, Online Activities, Friends | |
There was a problem hiding this comment.
There's an inconsistency in the use case labeling. Line 65 uses "UC6" but this should be "UC8" to match the corresponding use case defined earlier (line 46-48). UC6 is already assigned to "User views the Game Library" on line 63.
| | UC6: User becomes friends with another user | Register, Online Activities, Friends | | |
| | UC8: User becomes friends with another user | Register, Online Activities, Friends | |
rachelkingCPTC
left a comment
rachelkingCPTC
left a comment
There was a problem hiding this comment.
Looks good overall!. I think you could have improved your use case diagram by putting the User actor to the right side of your Gaming Platform block.
| - Register | ||
| - Maintain WS connections | ||
| - Online Activities | ||
| - Inbox Messages | ||
| - Game Library | ||
| - Search | ||
| - Friends | ||
| - Achievement system | ||
| - Toast Notifications |
There was a problem hiding this comment.
This is a good list that could use just a bit more detail. For example -- Register. Register for what? Search for what? If you told someone you were working on the "Friends" feature, would they really know what you meant?
There was a problem hiding this comment.
Did we have to describe the features as we listed them out? 🤔
(Register User, Search Content, and I'm quite sure that they would know what I mean since it's common to have friend features 👍👍)
There was a problem hiding this comment.
You don't have to give a sub-description. This is just an improvement suggestion for how to name features to be more clear.
PR for Assignment 3 in CPW 207