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

Doc improvements for sequence diagram examples #2795

Closed
riaanduplessis opened this issue Mar 5, 2022 · 1 comment · Fixed by #2836
Closed

Doc improvements for sequence diagram examples #2795

riaanduplessis opened this issue Mar 5, 2022 · 1 comment · Fixed by #2836
Labels
Status: Triage Needs to be verified, categorized, etc Type: Other Not an enhancement or a bug

Comments

@riaanduplessis
Copy link
Contributor

The issue

In a lot of cases, sequence diagrams would be beneficial for making documentation around systems more clear, in which case, the 'Actors' or 'Participants' would be presented as components of an application, system, module or even network. Showing the interaction between these various components.

The current documentation around sequence diagrams builds upon the premise of 'Actors' and 'Participants' by using examples where they are represented as people and the interactions are simple communications.

This fails to provide a clear and deeper technical understanding to the reader as to the true use-cases of these diagrams.

The Question

I'd like to add more technical diagrams to the sequenceDiagram.md page that give examples more orientated towards software, such as inner workings of classes in OOP, or instance communication in a cloud network.

Are there be any suggestions, or objections, to this before I submit work on this?

@riaanduplessis riaanduplessis added the Type: Other Not an enhancement or a bug label Mar 5, 2022
@github-actions github-actions bot added the Status: Triage Needs to be verified, categorized, etc label Mar 5, 2022
@chrismetz09
Copy link
Contributor

More examples of sequence diagrams would be great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Other Not an enhancement or a bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants