Skip to content

Commit

Permalink
#1 added mermaid support plus content for concept and use case
Browse files Browse the repository at this point in the history
  • Loading branch information
jgeluk committed Feb 3, 2022
1 parent eae552c commit 4060261
Show file tree
Hide file tree
Showing 9 changed files with 98 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
site/
.DS_Store
.texpadtmp
*.aux
*.bbl
*.bcf
*.blg
*.fls
*.glo
*.glg
*.gls
*.glsdefs
*.idx
*.ilg
*.ind
*.ist
*.labelTags
*.lof
*.log
*.out
*.pdf
*.run.xml
*.synctex*
*.tdo
*.sta
*.gz
*.toc
*.acn
*.acr
*.alg
*.dvi
*.lot
*.maf
*.mtc
*.mtc1
.fdb_latexmk
!images/*.pdf
!images/*.pdf_tex
images/svg-inkscape/
svg-inkscape/
ekg-mm/images/svg-inkscape/
out/
/.project
.uuid
*.tlg
*.olg
*.tld
*.old
*.tdn
*.odn
*.pandoc.docx
.idea
*.fdb_latexmk
*.xdy
Empty file added docs/concept/.pages.yaml
Empty file.
34 changes: 34 additions & 0 deletions docs/concept/concept.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Concept

For every given Use Case we want to start with capturing the concepts and
terms that the user or "the business" uses or wants to use.

Most of these concepts and their terms will be pre-defined in all kinds of
vocabularies but for brand-new use cases in a new domain concepts and their
terms will have to be created.

```mermaid
classDiagram
direction RL
class Concept {
- type : ConceptType
}
class UseCase {
- vocabulary: Vocabulary
- stories: Story[]
}
link UseCase "http://localhost:8000/concept/use-case/"
UseCase --> UseCase : requires
Vocabulary "*" --> "*" Concept
Vocabulary "*" --> "*" Term
Story --> "*" Concept : input
Story --> "*" Concept : output
Term --> "1..*" Concept
%% Concept --> OntologyAxiom
Vocabulary <--> Concept
UseCase --> "1..*" Story
Persona --|> Concept
Concept --> Concept : broader
Concept --> Term : preferred
UseCase --> "1" Vocabulary : use case vocabulary
```
3 changes: 3 additions & 0 deletions docs/concept/dataset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Input Concept


3 changes: 3 additions & 0 deletions docs/concept/outcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Concept


1 change: 1 addition & 0 deletions docs/concept/persona.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Use Case
3 changes: 3 additions & 0 deletions docs/concept/story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Input Concept


Empty file added docs/concept/use-case.md
Empty file.
Empty file.

0 comments on commit 4060261

Please sign in to comment.