https://github.com/carolyncole/i_love_mermaid
A repo for I love mermaid talk
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 2 committers (50.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (7.3%) to scientific vocabulary
Repository
A repo for I love mermaid talk
Basic Info
- Host: GitHub
- Owner: carolyncole
- License: mit
- Default Branch: main
- Size: 51.8 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Talk Outline
Example Mermaid Diagrams
Will change diagrams to more complex eaxmples * State Diagram * Flow Diagram * System Interaction Digram
System Scenario
What would a diagram(s) help me with? * Verifing my understaning of the requirements * A diagram that reflects the requirements to the stakeholders is a low impact way of validating understanding. * Document the system for future developers (including yourself) * Future developers do not need to read the entire set of requirements to get an idea of what the system does * understand how the requirements interact and help to expose implicit requirements
Questions I might ask given the scenario above:
- What types of user do we have in the system?
- What are the states an object can go through?
- What systems do we need to interact with?
What type of diagrams would help us to answer the above questions?
- Flow diagram
- State diagram
- Interaction diagram
Lets build a flow diagram
- Start with an Empty Diagram
- Add in the Actors
- Add in the Steps and system reactions
Why mermaid is so great! Lets add a requirement
The system should notify the user when an administrator approves the object.
Style the Diagram
Colors can draw your attention and add clarity
Cheat sheet
See my cheat sheet for flow/sequence diagrams that I used for the presentation: https://github.com/carolyncole/ilovemermaid/blob/main/cheat-sheet.md
Owner
- Login: carolyncole
- Kind: user
- Repositories: 13
- Profile: https://github.com/carolyncole
GitHub Events
Total
Last Year
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| carolyncole | 1****e | 41 |
| Carolyn Cole | c****9@p****u | 10 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: over 1 year ago
All Time
- Total issues: 0
- Total pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: 3 months
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- carolyncole (1)