-
Notifications
You must be signed in to change notification settings - Fork 26
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
[AB3: Tracing Code] Add more headers to section instructions #17
Comments
@UdhayaShan1 MarkBind's image annotations feature is likely useful here. That way, we can cite the same UML diagram (directly referred from AB3) while annotating it as necessary to fit the tutorial. Feel free to submit a PR. Initially, the PR can add just 1-2 diagrams. After discussing the initial change set, it can proceed to add more. |
Thanks! |
This was referenced Jul 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Current:
The current tutorial is a chain of many steps going up to 28 steps. It is told in the form of narration from start to finish.
Problem
It becomes challenging to link each step during tracing to the sequence diagram.
Proposed
We can add headers to highlight which logic interaction is currently being traced, for example, when
LogicManager
passes control toAddressBookParser
, we can explicitly mention this in header in whatever is the best form. It is hoped this can allow them to relate it to the introduced sequence diagram in high level overview in #16 easilyWe can also highlight it in a diagram?
The text was updated successfully, but these errors were encountered: