Merge pull request #22 from mleute/main

Two common viewpoints added
GfSE · Oct 6, 2023 · 0329924 · 0329924
2 parents 05b8ec4 + d049c5f
commit 0329924
Show file tree

Hide file tree

Showing 5 changed files with 99 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -160,7 +160,7 @@ For traceability the Physical Domain defines diagrams showing the mapping of the
 * [Physical Internal Exchange Viewpoint](viewpoints/Physical-Internal-Exchange-Viewpoint.md)
 #### Physical Domain Aspect Interface
 * [Physical Interface Definition Viewpoint](viewpoints/Physical-Interface-Definition-Viewpoint.md)
-* Physical Protocol Stack Definition Viewpoint
+* [Physical Protocol Stack Definition Viewpoint](viewpoints/Physical-Protocol-Stack-Definition-Viewpoint.md)
 #### Physical Domain Aspect Traceability & Mapping
 * [Physical Functional Mapping Viewpoint](viewpoints/Physical-Functional-Mapping-Viewpoint.md)
 ## Common Domain
@@ -169,9 +169,12 @@ The SAF Common Domain provides viewpoints addressing model information that is c
 
 ### Common Domain Concerns
 * Provides information on standards and documents that are applicable or are referred to within the model.
+* Provides definition and overview of abbreviations and terms used throughout the model
 
 ### Common Domain Viewpoints
 * [Argumentation Assurance Viewpoint](viewpoints/Argumentation-Assurance-Viewpoint.md)
+* [Common-Standards-Definition-Viewpoint](viewpoints/Common-Standards-Definition-Viewpoint.md)
+* [Common-Terms-And-Abbreviations-Viewpoint](viewpoints/Common-Terms-And-Abbreviations-Viewpoint.md)
 
 # Stakeholder Definition
 * [List of Stakeholders](stakeholders.md)

diff --git a/diagrams/Common-Abbreviations-Table.png b/diagrams/Common-Abbreviations-Table.png
diff --git a/diagrams/Common-Terms-Table.png b/diagrams/Common-Terms-Table.png
diff --git a/viewpoints/Common-Standards-Definition-Viewpoint.md b/viewpoints/Common-Standards-Definition-Viewpoint.md
@@ -0,0 +1,53 @@
+![System Architecture Framework](../diagrams/Banner_SAF.png)
+# SAF User Documentation : Common Standards Definition Viewpoint
+|**Domain**|**Aspect**|**Maturity**|
+| --- | --- | --- |
+|[Common](../domains.md#Domain-Common)|[Taxonomy & Structure](../aspects.md#Aspect-Taxonomy-&-Structure)|![Proposed](../diagrams/Under_construction_icon-red.svg )[proposed](../using-saf/maturity.md#proposed)|
+## Example
+![Common Standards Definition](../diagrams/Common-Standards_Definition.png)
+## Purpose
+The SCV02 Standards Definition Viewpoint is used to define applicable standards, format specifications, protocol specifications, regulations and engineering documents that are used throughout the model. It provides the complete specification for the standards together with issue, version, release date and other information. The SCV02 helps to keep track of changes to the set of applicable documents and of new versions of the applied standards. Hyperlinks may be used to refer to documents external to the model.
+
+Libraries may be made available defining standards commonly used throughout the enterprise or that are specific for a certain purpose.
+## Applicability
+The SCV02 Standards Definition Viewpoint is commonly applied to identify the applicable standards and specifications that are made applicable to interfaces, the format of items exchanged, the way those items are exchanged or to any other design element that needs to adhere to a standard.
+## Stakeholder
+* [Customer](../stakeholders.md#Customer)
+* [Hardware Developer](../stakeholders.md#Hardware-Developer)
+* [IV&V Engineer](../stakeholders.md#IV&V-Engineer)
+* [Mechanic Developer](../stakeholders.md#Mechanic-Developer)
+* [Regulation Authority](../stakeholders.md#Regulation-Authority)
+* [Safety Expert](../stakeholders.md#Safety-Expert)
+* [Security Expert](../stakeholders.md#Security-Expert)
+* [Software Developer](../stakeholders.md#Software-Developer)
+* [Supplier](../stakeholders.md#Supplier)
+* [System Architect](../stakeholders.md#System-Architect)
+* [Common Concerns](../stakeholders.md#Common-Concerns)
+
+## Concern
+* Which standards and specifications are applicable to the system of interest or its system elements and their interfaces and interactions?
+* What are the relevant issues or versions of the standards to be used for the development of the system?
+* What is the complete identification of a standard or a specification?
+* Which other standards are referenced or referred to by applicable standards?
+
+## Presentation
+SCV02 Standard Definition Diagram defines the standards, their attributes and relationships.
+
+SCV02 Standard Overview Table providing a list of all standards defined in the model.
+
+
+## Profile Model Reference
+* StandardsGroup: defines a group of alternative standards
+* FormatSpecification: defines a standard applied to files and data
+* replaces: defines a relationship if one standard replaces an outdated standard
+* outdated: used to indicate, that a standard is outdated
+* composition: [UML_Standard_Profile]
+* generalization: [UML_Standard_Profile]
+* SCV02_StandardsDefinition: Applicable for the diagram
+* SCV02_StandardsOverview: Defines the overview table
+
+## Input from other Viewpoints
+### Required Viewpoints
+*none*
+### Recommended Viewpoints
+*non*
diff --git a/viewpoints/Common-Terms-And-Abbreviations-Viewpoint.md b/viewpoints/Common-Terms-And-Abbreviations-Viewpoint.md
@@ -0,0 +1,42 @@
+![System Architecture Framework](../diagrams/Banner_SAF.png)
+# SAF User Documentation : Common Terms and Abbreviations
+|**Domain**|**Aspect**|**Maturity**|
+| --- | --- | --- |
+|[Common](../domains.md#Domain-Common)|[Taxonomy & Structure](../aspects.md#Aspect-Taxonomy-&-Structure)|![Proposed](../diagrams/Under_construction_icon-red.svg )[proposed](../using-saf/maturity.md#proposed)|
+## Example
+![Abbreviations Table](../diagrams/Common-Abbreviations-Table.png)
+
+![Terms Table](../diagrams/Common-Terms-Table.png)
+## Purpose
+The viewpoint collects all the terms and abbreviations that are defined for the model.
+## Applicability
+The viepoint is used to collect and present terms and abbreviations that are used throughout the model, providing a description for each presenting the common understanding of a term or an abbreviation.
+## Stakeholder
+* [Acquirer](../stakeholders.md#Acquirer)
+* [Customer](../stakeholders.md#Customer)
+* [Hardware Developer](../stakeholders.md#Hardware-Developer)
+* [IV&V Engineer](../stakeholders.md#IV&V-Engineer)
+* [Maintainer](../stakeholders.md#Maintainer)
+* [Mechanic Developer](../stakeholders.md#Mechanic-Developer)
+* [Operator](../stakeholders.md#Operator)
+* [Regulation Authority](../stakeholders.md#Regulation-Authority)
+* [Safety Expert](../stakeholders.md#Safety-Expert)
+* [Security Expert](../stakeholders.md#Security-Expert)
+* [Software Developer](../stakeholders.md#Software-Developer)
+* [Supplier](../stakeholders.md#Supplier)
+* [System Architect](../stakeholders.md#System-Architect)
+* [Common Concerns](../stakeholders.md#Common-Concerns)
+* [User](../stakeholders.md#User)
+## Concern
+* What is the common understanding of terms and abbreviations as used throughout the model?
+## Presentation
+A common package “02_DictionaryOfTerms” contains the terms and abbreviations. Both are derived from a comment. Table views are used for presenting an overview.
+
+## Profile Model Reference
+* [SAF_Term](../stereotypes.md#SAF_Term)
+* [SAF_Abbreviation](../stereotypes.md#SAF_Abbreviation)
+## Input from other Viewpoints
+### Required Viewpoints
+*none*
+### Recommended Viewpoints
+*none*