Skip to content

Commit

Permalink
add concept overview diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
haarer committed Oct 10, 2024
1 parent 24c0743 commit a5c0963
Show file tree
Hide file tree
Showing 82 changed files with 37,741 additions and 1,486 deletions.
145 changes: 145 additions & 0 deletions src/_data/concept-diags.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
[ {
"ID" : "_2021x_2_6d8019d_1701080157136_976247_25019",
"Documentation" : "",
"Name" : "SAF_security_concept_Definition"
}, {
"ID" : "_2021x_2_8710274_1701721296364_339819_14679",
"Documentation" : "Overview about the relationships between concepts used in the SAF Operational Domain and the SAF Functional Domain",
"Name" : "SAF_cross-domain FD-OD-mapping-wallpaper"
}, {
"ID" : "_19_0_2_26f0132_1561750267221_345412_48257",
"Documentation" : "",
"Name" : "SAF_need_concept_Definition"
}, {
"ID" : "_19_0_2_6d8019d_1578394565730_677039_58929",
"Documentation" : "",
"Name" : "SAF_requirement_F_Definition"
}, {
"ID" : "_19_0_2_26f0132_1558075019807_638764_44681",
"Documentation" : "Describes concepts used to describe system contexts in the SAF Physical Domain and related concepts.",
"Name" : "SAF_context_P_Definition"
}, {
"ID" : "_2021x_2_8710274_1697453573357_725014_28760",
"Documentation" : "",
"Name" : "SAF_framework_Definition"
}, {
"ID" : "_19_0_2_26f0132_1561752958641_615073_50263",
"Documentation" : "",
"Name" : "SAF_interaction_O_Definition"
}, {
"ID" : "_19_0_2_26f0132_1562303524176_255359_91092",
"Documentation" : "Basic concepts of system elements in the logical and physical domain.",
"Name" : "SAF_structural_P_Definition"
}, {
"ID" : "_19_0_4_6d8019d_1630754051112_668386_1238",
"Documentation" : "\n",
"Name" : "SAF_structural_O_Definition"
}, {
"ID" : "_19_0_4_6d8019d_1654515739900_178967_136",
"Documentation" : "",
"Name" : "SAF_domain_kind_O_Definition"
}, {
"ID" : "_19_0_3_26f0132_1582314561045_987074_55831",
"Documentation" : "",
"Name" : "SAF_interaction_F_Definition"
}, {
"ID" : "_19_0_4_6d8019d_1627138960892_222015_2705",
"Documentation" : "",
"Name" : "SAF_interaction_L_Definition"
}, {
"ID" : "_2021x_2_8710274_1700810074468_724882_47626",
"Documentation" : "",
"Name" : "SAF_term_and_standard_C_Definition"
}, {
"ID" : "_2021x_2_8710274_1698693782035_545301_46389",
"Documentation" : "",
"Name" : "SAF_general_concept_Definition"
}, {
"ID" : "_2021x_2_8710274_1681801250811_140159_24329",
"Documentation" : "Overview about the relationships between interface related concepts used in the SAF Functional/Logical Domain and the SAF Physical Domain",
"Name" : "SAF_cross-domain-interface-wallpaper"
}, {
"ID" : "_19_0_2_26f0132_1561750845871_402382_48509",
"Documentation" : "Describes concepts used to describe operational contexts in the SAF Operational Domain and related concepts.",
"Name" : "SAF_context_O_Definition"
}, {
"ID" : "_19_0_3_8710274_1583764858043_48179_57333",
"Documentation" : "",
"Name" : "SAF_interface_O_Definition"
}, {
"ID" : "_19_0_3_6d8019d_1611088881975_654543_7",
"Documentation" : "",
"Name" : "SAF_safety_concept_Definition"
}, {
"ID" : "_2021x_2_6d8019d_1674232168056_447500_23376",
"Documentation" : "Describes the concepts used for the CAE pattern.",
"Name" : "SAF_argumentation_C_Definition"
}, {
"ID" : "_19_0_2_26f0132_1572502159277_127751_54042",
"Documentation" : "Overview over concepts used to describe contexts.",
"Name" : "SAF_context_concept_Definition"
}, {
"ID" : "_19_0_3_ebf0350_1581848717751_213364_53834",
"Documentation" : "Basic concepts of system elements in the logical and physical domain.",
"Name" : "SAF_structural_L_Definition"
}, {
"ID" : "_19_0_3_26f0132_1605540516391_996561_23",
"Documentation" : "",
"Name" : "SAF_operational_domain_wallpaper"
}, {
"ID" : "_19_0_2_26f0132_1562307188137_987571_141163",
"Documentation" : "Describes concepts used to describe exchanged items in the SAF Functional and SAF Logical Domain and related concepts",
"Name" : "SAF_domain_kind_F_Definition"
}, {
"ID" : "_19_0_2_26f0132_1562303525223_309444_91601",
"Documentation" : "distinguish between allocation of usage and allocation of definition \nallocate function to Logical Element \n",
"Name" : "SAF_structural_F_Definition"
}, {
"ID" : "_19_0_3_6d8019d_1608887779426_398261_327",
"Documentation" : "Describes the relationships between system capabilities and to other related concepts.",
"Name" : "SAF_capability_F_Definition"
}, {
"ID" : "_19_0_2_26f0132_1562303526333_701268_92004",
"Documentation" : "",
"Name" : "SAF_state_F_Definition"
}, {
"ID" : "_19_0_4_26f0132_1624610770336_606347_183",
"Documentation" : "",
"Name" : "SAF_functional_domain_wallpaper"
}, {
"ID" : "_19_0_2_26f0132_1575319251778_396196_62439",
"Documentation" : "",
"Name" : "SAF_requirement_O_Definition"
}, {
"ID" : "_19_0_2_26f0132_1562312605244_52130_147227",
"Documentation" : "",
"Name" : "SAF_interface_P_Definition"
}, {
"ID" : "_2021x_2_6d8019d_1691312997335_772335_24273",
"Documentation" : "",
"Name" : "SAF_functional_concept_Definition"
}, {
"ID" : "_19_0_2_26f0132_1562312646505_809606_147806",
"Documentation" : "",
"Name" : "SAF_interface_F_Definition"
}, {
"ID" : "_19_0_2_ebf0350_1578263528322_79798_55227",
"Documentation" : "Describes concepts used to describe the system context in the SAF Functional Domain and related concepts.",
"Name" : "SAF_context_F_Definition"
}, {
"ID" : "_2021x_2_8710274_1700811159302_777311_48920",
"Documentation" : "",
"Name" : "SAF_process_C_Definition"
}, {
"ID" : "_19_0_3_8710274_1581665834898_520724_48775",
"Documentation" : "Describes the relationships between operational capabilities and to other related concepts.",
"Name" : "SAF_capability_O_Definition"
}, {
"ID" : "_2021x_2_6d8019d_1699202352882_744717_24615",
"Documentation" : "",
"Name" : "SAF_general_concept_wallpaper"
}, {
"ID" : "_19_0_2_26f0132_1575560338657_954734_55853",
"Documentation" : "",
"Name" : "SAF_cross-domain-LD-FD-mapping-wallpaper"
} ]
10 changes: 10 additions & 0 deletions src/_includes/concept.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

<img src="/diagrams/concept/exa{{ diag.first.ID }}.svg" />
{{ diag.first.Documentation }}

{: .todo }
print out diagram elements list with documentation

|Concept|Documentation|
|---|---|
| tbd|tbd|
8 changes: 4 additions & 4 deletions src/devdoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ There are several kinds of models around SAF serving a certain purpose
* **SAF_SCM_Profile Model**
The SAF SCM Profile is used by the SAF_Specification model. It contains Stereotypes used to specify concepts, viewpoints, framework concerns and stakeholders. It is used to specify or extend SAF.

## Conceptual Model
## Specification Model

The conceptual model is the foundation of SAF development.
It governs, which items SAF consist of and how these items are related.
It follows the concepts of ISO 42010. SAF extends ISO 42010 in a way that SAF is able to express a rationale for a Stakeholders Concern. This should possibly be added to ISO 42010.
It follows the concepts of ISO 42010. SAF extends ISO 42010 in a way that SAF is able to express a rationale for a Stakeholders Concern.

![Bild](./assets/images/Concept-Model-Definition.svg)

Expand Down Expand Up @@ -70,8 +70,8 @@ It consists of

* [Development Guideline](saf-dev-guideline.md)
* [Metamodel Guide](metamodel-guideline/modelguideline.md)
* [List of Concepts](concept/concepts.md)
* [Concept Overview Diagrams](concept/concept-overview.md)
* [List of Concepts](./devdoc/concepts.md)
* [Concept Overview Diagrams](./devdoc/concept-overview.md)
* [Development view on SAF Viewpoints](viewpoints/viewpoint-dev.md)

[^1]: The question about the recommended workflow cannot be answered by a single viewpoint description, this is an overarcing topic, which is currently not covered by the SAF documentation. [See issue 14](https://github.com/GfSE/SAF-Specification/issues/14)
46 changes: 46 additions & 0 deletions src/devdoc/concept-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Concepts
parent: "Developer Documentation"
layout: default
---
# SAF Development Documentation : SAF_Concept Ontology Overview

There are some [General Concepts](./concepts/SAF_general_concept_Definition.md) forming basic patterns like requirement, structure, behavior, interaction, and exchange. However, these are not used in viewpoints directly, they form abstractions of more specific concepts. The SAF_Concepts are grouped by topics, and SAF_Concepts are shown together with related SAF_Concepts.

## Capabilities
* [Operational Level Capability](./concepts/SAF_capability_O_Definition.md)
* [System Level Capability](./concepts/SAF_capability_F_Definition.md)

## Requirements
* [Operational Level Requirements](./concepts/SAF_requirement_O_Definition.md)
* [System Level Requirements](./concepts/SAF_requirement_F_Definition.md)

## Context and Context Elements
* [Operational Level Context](./concepts/SAF_context_O_Definition.md)
* [System Level Context](./concepts/SAF_context_F_Definition.md)
* [System Level Physical Context](./concepts/SAF_context_P_Definition.md)

## Domain Items
* [Operational Level Domain Items](./concepts/SAF_domain_kind_O_Definition.md)
* [System Level Domain Items](./concepts/SAF_domain_kind_F_Definition.md)

## Structure
* [Operational Level Stucture](./concepts/SAF_structural_O_Definition.md)
* [System Level Functional Stucture](./concepts/SAF_structural_F_Definition.md)
* [System Level Logical Stucture](./concepts/SAF_structural_L_Definition.md)
* [System Level Physical Stucture](./concepts/SAF_structural_P_Definition.md)

## Exchange and Interfaces
* [Operational Level Exchange](./concepts/SAF_interface_O_Definition.md)
* [System Level Exchange](./concepts/SAF_interface_F_Definition.md)
* [System Level Physical Exchange](./concepts/SAF_interface_P_Definition.md)

## States
* [System State](./concepts/SAF_state_F_Definition.md)

## Misc
* [Terms and Standards](./concepts/SAF_term_and_standard_C_Definition.md)
* [Argumentation](./concepts/SAF_argumentation_C_Definition.md)

## SAF Development
* [Framework Definition](./concepts/SAF_framework_Definition.md)
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_argumentation_C_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_argumentation_C_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_argumentation_C_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_capability_F_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_capability_F_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_capability_F_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_capability_O_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_capability_O_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_capability_O_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_context_F_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_context_F_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_context_F_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_context_O_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_context_O_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_context_O_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_context_P_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_context_P_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_context_P_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_context_concept_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_context_concept_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_context_concept_Definition" %}
{% include concept.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_cross-domain FD-OD-mapping-wallpaper
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_cross-domain FD-OD-mapping-wallpaper" %}
{% include concept.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_cross-domain-LD-FD-mapping-wallpaper
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_cross-domain-LD-FD-mapping-wallpaper" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_cross-domain-interface-wallpaper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_cross-domain-interface-wallpaper
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_cross-domain-interface-wallpaper" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_domain_kind_F_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_domain_kind_F_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_domain_kind_F_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_domain_kind_O_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_domain_kind_O_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_domain_kind_O_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_framework_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_framework_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_framework_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_functional_concept_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_functional_concept_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_functional_concept_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_functional_domain_wallpaper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_functional_domain_wallpaper
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_functional_domain_wallpaper" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_general_concept_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_general_concept_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_general_concept_Definition" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_general_concept_wallpaper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_general_concept_wallpaper
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_general_concept_wallpaper" %}
{% include concept.md %}
7 changes: 7 additions & 0 deletions src/devdoc/concepts/SAF_interaction_F_Definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SAF_interaction_F_Definition
parent: Concepts
layout: default
---
{% assign diag = site.data.concept-diags | where: "Name","SAF_interaction_F_Definition" %}
{% include concept.md %}
Loading

0 comments on commit a5c0963

Please sign in to comment.