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

docs: update DG to reflect user stories and use cases to reflect all implemented functions #390

Conversation

jayllo-c
Copy link

@jayllo-c jayllo-c commented Apr 9, 2024

Fixes #311

Currently, the DG has the user stories relevant only to v1.2, meaning
all exam and score related implementations have been excluded from
the user stories and use cases.

As such, the user stories and use cases are outdated and need to be
refurbished.

Let's update the user stories and use cases to correctly reflect the
current functionality implemented into Avengers Assemble.

By maintaining the user stories and use cases, future developers
will be able to understand the motivation and logic behind the current
suite of features.

Note: this commit also contains minor changes to the UG from feedback
given from the PE-D.

jayllo-c added 3 commits April 7, 2024 16:40
Currently, the DG has the user stories relevant only to v1.2, meaning
all exam and score related implementations have been excluded from
the user stories and use cases.

As such, the user stories and use cases are outdated and need to be
refurbished.

Let's update the user stories and use cases to correctly reflect the
current functionality implemented into Avengers Assemble.

By maintaining the user stories and use cases, future developers
will be able to understand the motivation and logic behind the current
suite of features.

Note: this commit also contains minor changes to the UG from feedback
given from the PE-D.
@jayllo-c jayllo-c added type.Task Something that needs to be done, but not a story, bug, or an epic. e.g. Move testing code into a new priority.High Must do labels Apr 9, 2024
@jayllo-c jayllo-c added this to the v1.4 milestone Apr 9, 2024
@jayllo-c jayllo-c self-assigned this Apr 9, 2024
Copy link

@Zer0Legion Zer0Legion left a comment

Choose a reason for hiding this comment

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

The new phrasing is much clearer and consistent. UG changes look good as well.

Copy link

@delishad21 delishad21 left a comment

Choose a reason for hiding this comment

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

Very comprehensive changes to the DG. Well Done!

@Zer0Legion Zer0Legion merged commit 2cad064 into AY2324S2-CS2103T-T10-1:master Apr 10, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority.High Must do type.Task Something that needs to be done, but not a story, bug, or an epic. e.g. Move testing code into a new
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: update DG to reflect user stories and use cases to reflect all implemented functions
3 participants