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.

Sign up for GitHub

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

Jump to bottom

[AB3: Tracing Code] Add more headers to section instructions #17

Open
UdhayaShan1 opened this issue Jun 24, 2024 · 2 comments · May be fixed by #42
Open

[AB3: Tracing Code] Add more headers to section instructions #17

UdhayaShan1 opened this issue Jun 24, 2024 · 2 comments · May be fixed by #42

Comments

@UdhayaShan1
Copy link

UdhayaShan1 commented Jun 24, 2024 •
edited
Loading

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 to AddressBookParser, 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 easily

We can also highlight it in a diagram?

drawing
@UdhayaShan1 UdhayaShan1 mentioned this issue Jul 4, 2024
Open
@damithc
Copy link
Contributor

damithc commented Jul 6, 2024

@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.
e.g.,
image

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.

@UdhayaShan1
Copy link
Author

Thanks!

This was referenced Jul 7, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[AB3: Tracing Code] Add more headers to section instructions UdhayaShan1/ab3-guides
2 participants
@damithc @UdhayaShan1