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

Sequence diagram #1

Open
InoMurko opened this issue Oct 31, 2023 · 0 comments
Open

Sequence diagram #1

InoMurko opened this issue Oct 31, 2023 · 0 comments
Assignees

Comments

@InoMurko
Copy link

Hey Jia,

at this point it might make sense to describe the interactions in zkdvrf with sequence diagrams.
https://en.wikipedia.org/wiki/Sequence_diagram
A good example of a sequence diagram https://github.com/ethereum-optimism/optimism/blob/develop/specs/fault-proof.md

In general, the way I would approach this is to first define happy path flows. What is the purpose of this software?
https://en.wikipedia.org/wiki/Happy_path

Based on (one or more) happy paths, you start with high level sequence diagram:
For example - happy path of visiting a new page:

  • a user visits a page
  • a user is displayed a logo
  • the user clicks the logo
  • the user is brought to a new page

Then you go deeper, and describe interactions between components, omitting details.
The third sequence diagram breaks down this one, by providing sequence diagrams within components (imagine API interactions).

Hope this helps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants