Design and document the categorization workflow #99
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matt-bernhardt
force-pushed
the
tco-69-diagrams
branch
from
9102dba to
05f0e57
Compare
matt-bernhardt
force-pushed
the
tco-69-diagrams
branch
from
05f0e57 to
3d2ca27
Compare
matt-bernhardt
force-pushed
the
tco-69-diagrams
branch
from
3d2ca27 to
bba7881
Compare
matt-bernhardt
force-pushed
the
tco-69-diagrams
branch
from
bba7881 to
287b1e2
Compare
matt-bernhardt
changed the title
JPrevost
approved these changes
Sep 6, 2024
jazairi
approved these changes
Sep 6, 2024
** Why are these changes being introduced: * We need to sketch out how the categorization and validation processes will work in this application, given the choices we've already made. We've talked about a few different options in general terms, and the time has come to start getting specific. ** Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/tco-69 ** How does this address that need: * This change includes some initial content added to the class diagram (where we started talking through this options). It also includes new variations on the class diagram describing two different prototypes. Each diagram is accompanied by a description of the workflow for that approach. Each approach was also accompanied by a quick implementation, but those are in a separate branch. They are not preserved here because the focus was on the design choices, not their implementation in code. A very minimal third prototype ("prototype zero") is also included, but this was abandoned within minutes. ** Document any side effects to this change: * There is a small change to the Work Activity Analysis diagram, to update some language used.
After a design review meeting with the full team, Jeremy wanted to think through the design space in a bit more detail. During that process, he created some additional prototype diagrams for consideration: - Simplified "A-minus" (no fundamental changes from A, but focusing on the heart of that prototype) - C, a variation that attempted to further simplify the A prototype - D, a variation on the B prototype that reduces some duplicate modeling These prototypes were informally discussed, which resulted in some changes that are also reflected here. Following this commit, the full team discussed the options again, and came to a decision about how we would proceed.
** Why are these changes being introduced: After the final set of options was discussed, the team decided which option we would pursue for the time being. This decision needed to be documented in a clear way. ** Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/tco-69 ** How does this address that need: This combines all the individual class diagrams into an ADR document, which summarizes each option - including the principle diagram which includes its key characteristics. This document summarizes our decisioin to pursue prototype D. The original class diagram is updated to reflect only this selected approach. Additionally, the workflow is summarized in a new explanation document of the Categorization Workflow. ** Document any side effects to this change: None in this commit (the first commit in this PR still includes a small wording change to the Work Activity Analysis).
matt-bernhardt
force-pushed
the
tco-69-diagrams
branch
from
1dd3a8d to
b23dc97
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a joint effort between all of us in EngX to design and document how the categorization workflow is going to function. It includes the following elements:
classes.mdfile to incorporate the chosen design in the context of our already existing classes.This PR also includes a small side effect of a change to the work activity analysis explanation.
Please note. I have not yet squashed this PR down to a single commit. The earlier commits on this branch include some additional documents, which I've attempted to summarize into the files named above. As part of your review, please consider whether I've omitted details from those contributing documents which should be added back to the final changeset.
Developer
Ticket(s)
https://mitlibraries.atlassian.net/browse/TCO-69
Accessibility
all issues introduced by these changes have been resolved or opened
as new issues (link to those issues in the Pull Request details above)
Documentation
ENV
Stakeholders
Dependencies and migrations
NO dependencies are updated
NO migrations are included
Reviewer
Code
added technical debt.
Documentation
(not just this pull request message).
Testing