From 243524b5177a310c85502e64d08d0afce9473eec Mon Sep 17 00:00:00 2001 From: Michael Haufe Date: Fri, 1 Nov 2024 16:34:01 -0500 Subject: [PATCH] 407 create mockups (#413) * Added mockup.drawio * Created mockup and process document * Created workbox mockups --------- Signed-off-by: Michael Haufe --- .devcontainer/devcontainer.json | 3 + _docs/worbox/mockup.drawio | 1153 +++++++++++++++++++++++++++++++ _docs/worbox/process.md | 59 ++ 3 files changed, 1215 insertions(+) create mode 100644 _docs/worbox/mockup.drawio create mode 100644 _docs/worbox/process.md diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 9a00e57a..54cc537f 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -30,6 +30,9 @@ "github.vscode-github-actions", "AlexShen.classdiagram-ts", "ms-azuretools.vscode-bicep", + "bierner.markdown-mermaid", + "bpruitt-goddard.mermaid-markdown-syntax-highlighting", + "hediet.vscode-drawio", "vitest.explorer", "kingwl.vscode-vitest-runner" ] diff --git a/_docs/worbox/mockup.drawio b/_docs/worbox/mockup.drawio new file mode 100644 index 00000000..c46bddc0 --- /dev/null +++ b/_docs/worbox/mockup.drawio @@ -0,0 +1,1153 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/_docs/worbox/process.md b/_docs/worbox/process.md new file mode 100644 index 00000000..630b1f56 --- /dev/null +++ b/_docs/worbox/process.md @@ -0,0 +1,59 @@ +```mermaid +%% Doc: https://mermaid.js.org/syntax/flowchart.html +flowchart LR + UserContrib@{ shape: circle, label: "Contributor" } + SilenceReq@{ shape: win-pane, label: "Silence Requirements"} + KB@{ shape: proc, label: "Add to KnowledgeBase" } + RejReq@{ shape: proc, label: "Reject Requirement" } + + UserContrib --> NLInput + UserContrib --> FormReq + NLInput --> ParseReq + ParseReq --> SilenceReq + FormReq --> SilenceReq + + subgraph Elicitation + FormReq@{ shape: manual-input, label: "Form entry" } + NLInput@{ shape: manual-input, label: "Natural Language Statement" } + ParseReq@{ shape: proc, label: "Parse Requirements
(LLM)"} + end + + subgraph Verification + ReqFork@{ shape: fork } + + Correctness@{ shape: proc, label: "Evaluate Correctness\n(HoRaBA Ch. 4.1)"} + Justifiability@{ shape: proc, label: "Evaluate Justifiability\n(HoRaBA Ch. 4.2)" } + Completeness@{ shape: proc, label: "Evaluate Completeness\n(HoRaBA Ch. 4.3)"} + Consistency@{ shape: proc, label: "Evaluate Consistency\n(HoRaBA Ch. 4.4)"} + NonAmbiguity@{ shape: proc, label: "Evaluate Non-ambiguity\n(HoRaBA Ch. 4.5)" } + Feasability@{ shape: proc, label: "Evaluate Feasability\n(HoRaBA Ch. 4.6)" } + Abstractness@{ shape: proc, label: "Evaluate Abstractness\n(HoRaBA Ch. 4.7)"} + Traceability@{ shape: proc, label: "Evaluate Traceability\n(HoRaBA Ch. 4.8)"} + Delimitedness@{ shape: proc, label: "Evaluate Delimitedness\n(HoRaBA Ch. 4.9)"} + Readability@{ shape: proc, label: "Evaluate Readability\n(HoRaBA Ch. 4.10)" } + Modifiable@{ shape: proc, label: "Evaluate Modifiability\n(HoRaBA Ch. 4.11)" } + Verifiability@{ shape: proc, label: "Evaluate Verifiability\n(HoRaBA Ch. 4.12)" } + ReqJoin@{ shape: join } + Prioritization@{ shape: manual-input, label: "Prioritization\n(HoRaBA Ch. 4.13)" } + Endorsement@{ shape: decision, label: "Endorsement\n(HoRaBA Ch. 4.14)"} + end + SilenceReq --> ReqFork + + ReqFork --> Correctness --> ReqJoin + ReqFork --> Justifiability --> ReqJoin + ReqFork --> Completeness --> ReqJoin + ReqFork --> Consistency --> ReqJoin + ReqFork --> NonAmbiguity --> ReqJoin + ReqFork --> Feasability --> ReqJoin + ReqFork --> Abstractness --> ReqJoin + ReqFork --> Traceability --> ReqJoin + ReqFork --> Delimitedness --> ReqJoin + ReqFork --> Readability --> ReqJoin + ReqFork --> Modifiable --> ReqJoin + ReqFork --> Verifiability --> ReqJoin + + ReqJoin --> Prioritization --> Endorsement + + Endorsement --[Approve]--> KB + Endorsement--[Reject]--> RejReq +``` \ No newline at end of file