diff --git a/conformance/example1/README.md b/conformance/example1/README.md index 078df55f0..1b85aa180 100644 --- a/conformance/example1/README.md +++ b/conformance/example1/README.md @@ -24,6 +24,56 @@ data (digital and physical identifiers) and packaging the product: - Model - Serial Number +## Demonstrated System Engineering Process and Tools + +### System Engineering Body of Knowledge (SEBoK) + +This example is attempting to follow the best practices described in the +[Guide to the Systems Engineering Body of Knowledge (SEBoK)](https://sebokwiki.org/wiki/Guide_to_the_Systems_Engineering_Body_of_Knowledge_(SEBoK)). + +The SEBoK Wiki Glossary quotes the following definition for the +[Vee (V) Model](https://sebokwiki.org/wiki/Vee_(V)_Model_(glossary)): + +> The technical aspect of the project cycle is envisioned as a "Vee", starting with User needs on the upper left and ending with a User-validated system on the upper right. (Forsberg and Mooz 1991) + +The SEBoK considers Users to be a subset of the set of Stakeholders. +This results in approximately the following Vee Model: + +``` + Stakeholder Needs + ^ + \ Stakeholder Requirements <-- proven met by -- System Validations + \ (solution constraints) ^ + \ / + +--> System Requirements <--- verified by ---- System Verifications + | repeat ^ ^ + | until \ System Architecture / + | directly \ decomposes System into / + | implement \ / + +--------- SysElement Requirements <------ sysElement Verification +``` + +Each resulting SysElement then is treated as a new System-of-interest (SOI) +and is further decomposed until it is small enough to be directly implemented +and verified. + + +### International Council on System Engineering (INCOSE) + +This example also attempts to write requirements following the +[International Council on Systems Engineering](https://www.incose.org/) recommendations. +A soft copy of their [Guide to Writing Requirements Summary Sheet](https://portal.incose.org/commerce/store?productId=commerce-merchandise%23INCOSE-GUIDEWRITINGREQSUM) +may be purchased from the INCOSE store by non-members for $0.00 (zero). + +The example content is initially being captured using the open-source +tool [StrictDoc](https://github.com/strictdoc-project/strictdoc), +which is a FOSS software tool for technical documentation and requirements management. +StrictDoc has been successfully used for technical documentation certified by +the European Space Agency. It supports the following features key to this example: +- document creators can specify their own document node types, +- node relationship directions and trace analysis, +- support for generating graphs from editable textual graph descriptions (Mermaid UML) + ## Comments diff --git a/conformance/example1/content/src/.gitignore b/conformance/example1/content/src/.gitignore new file mode 100644 index 000000000..bee8a64b7 --- /dev/null +++ b/conformance/example1/content/src/.gitignore @@ -0,0 +1 @@ +__pycache__ diff --git a/conformance/example1/content/src/SOI/SAMPLE/interface_requirements/sdoc/index.sdoc b/conformance/example1/content/src/SOI/SAMPLE/interface_requirements/sdoc/index.sdoc new file mode 100644 index 000000000..7e50d89c4 --- /dev/null +++ b/conformance/example1/content/src/SOI/SAMPLE/interface_requirements/sdoc/index.sdoc @@ -0,0 +1,26 @@ +[DOCUMENT] +MID: 43b3bf7d570d4089b3cd76a4c765cd62 +TITLE: Interface Requirements +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_interface_requirements_grammar + +[TEXT] +MID: 9be29edda6c5401fbb2a05ff71cd0fd0 +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: 1d78c62fa24740e49fd245550e11dd13 +STATEMENT: >>> +From `SEBoK Wiki Glossary - interface `_: + +- A shared boundary between two functional units, defined by various characteristics pertaining to the functions, physical signal exchanges, and other characteristics. (ISO/IEC 1993) + +- A hardware or software component that connects two or more other components for the purpose of passing information from one to the other. (ISO/IEC 1993) + +- To connect two or more components for the purpose of passing information from one to the other. (ISO/IEC/IEEE 2009) +<<< diff --git a/conformance/example1/content/src/SOI/SAMPLE/sdoc/index.sdoc b/conformance/example1/content/src/SOI/SAMPLE/sdoc/index.sdoc new file mode 100644 index 000000000..9ea11bedb --- /dev/null +++ b/conformance/example1/content/src/SOI/SAMPLE/sdoc/index.sdoc @@ -0,0 +1,51 @@ +[DOCUMENT] +TITLE: SAMPLE + +[TEXT] +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +STATEMENT: >>> +The System-of-Interest named SAMPLE is the top-level system in this example. + +It is expected to be composed of the following subsystems: + +.. raw:: html + + 
+    ---
+    title: Topology of Systems-of-Interest
+    ---
+    stateDiagram-v2
+
+        state SAMPLE {
+            TBD_Security_Vulnerability_Reporting: TBD 
 Security 
 Vulnerability 
 Reporting 
 Server
+            TBD_Desktop_SW: TBD 
 Desktop SW
+            TBD_Mobile_SW: TBD 
 Mobile SW
+            TBD_Devices: TBD 
 Device(s)
+            TBD_Cloud_SW: TBD 
 Cloud SW
+            TBD_Digital_Component_Update_Server: TBD 
 Digital 
 Component 
 Update 
 Server
+        }
+
+
+<<< + +[DOCUMENT_FROM_FILE] +FILE: ../system_requirements/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: ../system_verifications/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: ../system_architectures/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: ../interface_requirements/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: ../system_element_requirements/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: ../system_element_verifications/sdoc/index.sdoc diff --git a/conformance/example1/content/src/SOI/SAMPLE/system_architectures/sdoc/index.sdoc b/conformance/example1/content/src/SOI/SAMPLE/system_architectures/sdoc/index.sdoc new file mode 100644 index 000000000..85729e8c0 --- /dev/null +++ b/conformance/example1/content/src/SOI/SAMPLE/system_architectures/sdoc/index.sdoc @@ -0,0 +1,26 @@ +[DOCUMENT] +MID: af66c5de119447b58b950dd710d34b8a +TITLE: System Architecture(s) +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_system_architectures_grammar + +[TEXT] +MID: 84713f51e27b4ea4bc3242a8e2f1fba7 +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: 0f68a238be874bdcb25a5fbb9f9bcb5c +STATEMENT: >>> +From `SEBoK Wiki Glossary - Architecture `_: + +- fundamental concepts or properties of a system in its environment embodied in its elements, relationships, and in the principles of its design and evolution (ISO/IEC/IEEE 2015, Section 4.5) + +- The organizational structure of a system or component; the organizational structure of a system and its implementation guidelines. (ISO/IEC 2009, 1) + +- Fundamental concepts or properties of a system in its environment embodied in its elements, relationships, and in the principles of its design and evolution. (ISO/IEC 2011, section 3.2) +<<< diff --git a/conformance/example1/content/src/SOI/SAMPLE/system_element_requirements/sdoc/index.sdoc b/conformance/example1/content/src/SOI/SAMPLE/system_element_requirements/sdoc/index.sdoc new file mode 100644 index 000000000..9932fe507 --- /dev/null +++ b/conformance/example1/content/src/SOI/SAMPLE/system_element_requirements/sdoc/index.sdoc @@ -0,0 +1,22 @@ +[DOCUMENT] +MID: 9a5689a75c354b019acf55761ae02ca7 +TITLE: System Element Requirements +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_system_element_requirements_grammar + +[TEXT] +MID: 2f9e70c900604e35a4a61961afb6e19b +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: 49ebfa8c1d414aa2aa66aff2153c2f13 +STATEMENT: >>> +From `SEBoK Wiki Glossary - system element `_: + +- A member of a set of elements that constitutes a system. A system element is a discrete part of a system that can be implemented to fulfill specified requirements. A system element can be hardware, software, data, humans, processes (e.g., processes for providing service to users), procedures (e.g., operator instructions), facilities, materials, and naturally occurring entities (e.g., water, organisms, minerals), or any combination. (ISO/IEC 15288:2015) +<<< diff --git a/conformance/example1/content/src/SOI/SAMPLE/system_element_verifications/sdoc/index.sdoc b/conformance/example1/content/src/SOI/SAMPLE/system_element_verifications/sdoc/index.sdoc new file mode 100644 index 000000000..7ac80c674 --- /dev/null +++ b/conformance/example1/content/src/SOI/SAMPLE/system_element_verifications/sdoc/index.sdoc @@ -0,0 +1,30 @@ +[DOCUMENT] +MID: 97fadfb8f97a481a8205cf619c53f4f6 +TITLE: System Element Verifications +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_system_element_verifications_grammar + +[TEXT] +MID: 715801b3dc784aefab88fe5afc443e3e +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: 849ea88ccbf040bcbce53b9c15dbf7f8 +STATEMENT: >>> +From `SEBoK Wiki Glossary - verification `_: + +- Confirmation, through the provision of objective evidence, that specified (system) requirements have been fulfilled. (ISO/IEC 2008, section 4.38) + +- Verification is a set of activities that compares a system or system element against the required characteristics. This includes, but is not limited to, specified requirements, design description and the system itself. The system was built right. (ISO/IEC/IEEE 2015, 1, Section 6.4.6) + +- The evaluation of whether or not a product, service, or system complies with a regulation, requirement, specification, or imposed condition. It is often an internal process. Contrast with validation. (PMI 2013) + +- The process of evaluating a system or component to determine whether the products of a given development phase satisfy the conditions imposed at the start of that phase. (IEEE 1012-2004, 3.1.36) + +- Process of providing objective evidence that the software and its associated products comply with requirements for all life cycle activities during each life cycle process, satisfy standards, practices, and conventions during life cycle processes, and successfully complete each life cycle activity and satisfy all the criteria for initiating succeeding life cycle activities. (IEEE 829-2008, 3.1.54) +<<< diff --git a/conformance/example1/content/src/SOI/SAMPLE/system_requirements/sdoc/index.sdoc b/conformance/example1/content/src/SOI/SAMPLE/system_requirements/sdoc/index.sdoc new file mode 100644 index 000000000..5957b5c26 --- /dev/null +++ b/conformance/example1/content/src/SOI/SAMPLE/system_requirements/sdoc/index.sdoc @@ -0,0 +1,24 @@ +[DOCUMENT] +MID: 85ae378632b7425589c55bed12493f99 +TITLE: System Requirements +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_system_requirements_grammar + +[TEXT] +MID: caf6ea3cac33409b990281d4d820cc27 +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: ccbf7caa1def41da93bd3fb1e1f1d760 +STATEMENT: >>> +From `SEBoK Wiki Glossary - system requirement `_: + +- A statement that transforms the stakeholder, user-oriented view of desired capabilities into a technical view, of a solution that meets the operational needs of the user. (ISO/IEC/IEEE, 2015, section 6.4.2) + +- The System Requirement Definition process creates a set of measurable system requirements that specify, from the supplier’s perspective, what characteristics, attributes, and functional and performance requirements the system is to possess, in order to satisfy stakeholder requirements. (ISO/IEC/IEEE, 2015, section 6.4.2) +<<< diff --git a/conformance/example1/content/src/SOI/SAMPLE/system_verifications/sdoc/index.sdoc b/conformance/example1/content/src/SOI/SAMPLE/system_verifications/sdoc/index.sdoc new file mode 100644 index 000000000..c313e3be1 --- /dev/null +++ b/conformance/example1/content/src/SOI/SAMPLE/system_verifications/sdoc/index.sdoc @@ -0,0 +1,30 @@ +[DOCUMENT] +MID: 48e1355c717642e2bca757865187eda6 +TITLE: System Verifications +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_system_verifications_grammar + +[TEXT] +MID: 1aa664e9e0174cea9c59734ce2a23f2a +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: ddd4ee5dd24949c6813408d550a982b3 +STATEMENT: >>> +From `SEBoK Wiki Glossary - verification `_: + +- Confirmation, through the provision of objective evidence, that specified (system) requirements have been fulfilled. (ISO/IEC 2008, section 4.38) + +- Verification is a set of activities that compares a system or system element against the required characteristics. This includes, but is not limited to, specified requirements, design description and the system itself. The system was built right. (ISO/IEC/IEEE 2015, 1, Section 6.4.6) + +- The evaluation of whether or not a product, service, or system complies with a regulation, requirement, specification, or imposed condition. It is often an internal process. Contrast with validation. (PMI 2013) + +- The process of evaluating a system or component to determine whether the products of a given development phase satisfy the conditions imposed at the start of that phase. (IEEE 1012-2004, 3.1.36) + +- Process of providing objective evidence that the software and its associated products comply with requirements for all life cycle activities during each life cycle process, satisfy standards, practices, and conventions during life cycle processes, and successfully complete each life cycle activity and satisfy all the criteria for initiating succeeding life cycle activities. (IEEE 829-2008, 3.1.54) +<<< diff --git a/conformance/example1/content/src/SOI/sdoc/index.sdoc b/conformance/example1/content/src/SOI/sdoc/index.sdoc new file mode 100644 index 000000000..1e300ac6b --- /dev/null +++ b/conformance/example1/content/src/SOI/sdoc/index.sdoc @@ -0,0 +1,19 @@ +[DOCUMENT] +TITLE: System-of-Interest Catalog + +[TEXT] +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +STATEMENT: >>> +From `SEBoK Wiki Glossary - system-of-interest `_: + +- The system whose life cycle is under consideration. (ISO/IEC/IEEE 15288, 2015) + +- The system of interest to an observer. (von Bertalanffy, L. 1968. General system theory: Foundations, development, applications, revised ed. New York, NY: Braziller.) +<<< + +[DOCUMENT_FROM_FILE] +FILE: ../SAMPLE/sdoc/index.sdoc diff --git a/conformance/example1/content/src/index.sdoc b/conformance/example1/content/src/index.sdoc new file mode 100644 index 000000000..5bb21466e --- /dev/null +++ b/conformance/example1/content/src/index.sdoc @@ -0,0 +1,17 @@ +[DOCUMENT] +TITLE: SEBoK Product as System - Commodity Consumer Electronics + +[DOCUMENT_FROM_FILE] +FILE: problem_space/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: system_concept_of_operations/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: system_validations/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: shared/interface_specifications/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: SOI/sdoc/index.sdoc diff --git a/conformance/example1/content/src/problem_space/personas/sdoc/index.sdoc b/conformance/example1/content/src/problem_space/personas/sdoc/index.sdoc new file mode 100644 index 000000000..a26db9a7f --- /dev/null +++ b/conformance/example1/content/src/problem_space/personas/sdoc/index.sdoc @@ -0,0 +1,24 @@ +[DOCUMENT] +MID: dba1eb04ad064dafbc9b7115c9e04985 +TITLE: Personas +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_personas_grammar + +[TEXT] +MID: d495970e0ad34b9995417f85b90522f6 +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: 05ec8177ef09485bab9276d64d2cc4a5 +STATEMENT: >>> +From ISO/IEC/IEEE 24765:2017(en) Systems and software engineering - Vocabulary definition (2): + + representation of a type of user that includes a concise summary of the characteristics of the user that is most informative to the design or illustrative of specific user requirements *[ISO/IEC 25063:2014 Systems and software engineering — Systems and software product Quality Requirements and Evaluation (SQuaRE) Common Industry Format (CIF) for usability: Context of use description]* + + Note 1 to entry: A persona typically includes behavior patterns, goals, skills, attitudes, and environment, with a few fictional personal details to make the persona a realistic character.` +<<< diff --git a/conformance/example1/content/src/problem_space/sdoc/index.sdoc b/conformance/example1/content/src/problem_space/sdoc/index.sdoc new file mode 100644 index 000000000..917c7a811 --- /dev/null +++ b/conformance/example1/content/src/problem_space/sdoc/index.sdoc @@ -0,0 +1,28 @@ +[DOCUMENT] +TITLE: Problem Space Catalog + +[TEXT] +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +STATEMENT: >>> +The Problem Space Catalog contains Stakeholder-level content +(i.e., characteristics, needs and requirements) +that describes the potential problem space under consideration for a solution. +This problem space is likely larger than what will be addressed by a specific solution +(e.g., product, product-line, or business). +<<< + +[DOCUMENT_FROM_FILE] +FILE: ../stakeholders/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: ../personas/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: ../stakeholder_needs/sdoc/index.sdoc + +[DOCUMENT_FROM_FILE] +FILE: ../stakeholder_requirements/sdoc/index.sdoc diff --git a/conformance/example1/content/src/problem_space/stakeholder_needs/sdoc/index.sdoc b/conformance/example1/content/src/problem_space/stakeholder_needs/sdoc/index.sdoc new file mode 100644 index 000000000..502d5ebfe --- /dev/null +++ b/conformance/example1/content/src/problem_space/stakeholder_needs/sdoc/index.sdoc @@ -0,0 +1,22 @@ +[DOCUMENT] +MID: e27425f14a3548dcbdad3a8057117401 +TITLE: Stakeholder Needs +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_stakeholder_needs_grammar + +[TEXT] +MID: 8a9d00f76be647858c56f3c9a31cff0d +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: 695a3cb9a9bf4f30bf57f1469bc6c8eb +STATEMENT: >>> +From `SEBoK Wiki Glossary - stakeholder needs `_: + +- Stakeholder needs include elicitation of needs, wants, desires, expectations and perceived constraints of identified stakeholders. Needs concentrate on system purpose and behavior, and are described in the context of the operational environment and conditions. (ISO/IEC/IEEE 15288, 2023, Section 6.4.2) +<<< diff --git a/conformance/example1/content/src/problem_space/stakeholder_requirements/sdoc/index.sdoc b/conformance/example1/content/src/problem_space/stakeholder_requirements/sdoc/index.sdoc new file mode 100644 index 000000000..461ec17ce --- /dev/null +++ b/conformance/example1/content/src/problem_space/stakeholder_requirements/sdoc/index.sdoc @@ -0,0 +1,24 @@ +[DOCUMENT] +MID: 6a4553bc55b944b9a60c3c760d07ea76 +TITLE: Stakeholder Requirements +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_stakeholder_requirements_grammar + +[TEXT] +MID: 91e3de0e259e43ecbc9dc4c3987d5f8e +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: 974887912703457da5e0bc2022cf29d7 +STATEMENT: >>> +From `SEBoK Wiki Glossary - stakeholder requirement `_: + +- Stakeholder requirements are transformed from the stakeholder needs to objectively adequate, structured and more formal statements. (ISO/IEC/IEEE 29148, 2018, Section 5.2.3) + +- Stakeholder requirements express the intended interaction the system will have with its operational environment and that are the reference against which each resulting operational capability is validated. The stakeholder requirements are defined considering the context of the system of interest with the interoperating systems and enabling systems. This also includes consideration of laws and regulations, environmental restrictions, and ethical values. (ISO/IEC/IEEE 15288, 2023, Section 6.4.2) +<<< diff --git a/conformance/example1/content/src/problem_space/stakeholders/sdoc/index.sdoc b/conformance/example1/content/src/problem_space/stakeholders/sdoc/index.sdoc new file mode 100644 index 000000000..e018e3a31 --- /dev/null +++ b/conformance/example1/content/src/problem_space/stakeholders/sdoc/index.sdoc @@ -0,0 +1,28 @@ +[DOCUMENT] +MID: 90d096aedd3f4da2bad360c4a22baca9 +TITLE: Stakeholders +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_stakeholders_grammar + +[TEXT] +MID: 35a45c0a0c5b44dab052f074184f1ac6 +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: afff7b00985542258da8885cfbc9e452 +STATEMENT: >>> +From `SEBoK Wiki Glossary - stakeholder `_: + +- Individual or organization having a right, share, claim, or interest in a system or in its possession of characteristics that meet their needs and expectations (ISO/IEC/IEEE 2015) + +- Individual or organization having a right, share, claim, or interest in a system or in its possession of characteristics that meet their needs and expectations; N.B. Stakeholders include, but are not limited to end users, end user organizations, supporters, developers, producers, trainers, maintainers, disposers, acquirers, customers, operators, supplier organizations and regulatory bodies. (ISO/IEC June 2010) + +- An individual, team, or organization (or classes thereof) with interests in, or concerns relative to, a system. (ISO/IEC 2007) + +- A stakeholder in an organisation is (by definition) any group or individual who can affect or is affected by the achievement of the organisation's objectives. (Freeman 1984) +<<< diff --git a/conformance/example1/content/src/requirements.txt b/conformance/example1/content/src/requirements.txt new file mode 100644 index 000000000..7db7220bb --- /dev/null +++ b/conformance/example1/content/src/requirements.txt @@ -0,0 +1 @@ +strictdoc>=0.16.1 diff --git a/conformance/example1/content/src/shared/interface_specifications/sdoc/index.sdoc b/conformance/example1/content/src/shared/interface_specifications/sdoc/index.sdoc new file mode 100644 index 000000000..d036ee0d0 --- /dev/null +++ b/conformance/example1/content/src/shared/interface_specifications/sdoc/index.sdoc @@ -0,0 +1,26 @@ +[DOCUMENT] +MID: 40559692c69c4186b2988f397fae3705 +TITLE: Interface Specifications +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_interface_specifications_grammar + +[TEXT] +MID: 25e15526eef84b76b402e4ee758a48d6 +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: 4b16cedcc0fd4ff39a7816b32ebbe4e4 +STATEMENT: >>> +From `SEBoK Wiki Glossary - interface `_: + +- A shared boundary between two functional units, defined by various characteristics pertaining to the functions, physical signal exchanges, and other characteristics. (ISO/IEC 1993) + +- A hardware or software component that connects two or more other components for the purpose of passing information from one to the other. (ISO/IEC 1993) + +- To connect two or more components for the purpose of passing information from one to the other. (ISO/IEC/IEEE 2009) +<<< diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_interface_requirements.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_interface_requirements.sgra new file mode 100644 index 000000000..0782a851d --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_interface_requirements.sgra @@ -0,0 +1,57 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: REQUIREMENT + PROPERTIES: + PREFIX: IFCREQ- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: VERIFICATION + TYPE: MultipleChoice(Review, Analysis, Inspection, Test) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + - TITLE: RATIONALE + TYPE: String + REQUIRED: True + RELATIONS: + - TYPE: Parent + ROLE: Refines + diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_interface_specifications.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_interface_specifications.sgra new file mode 100644 index 000000000..ad0a5b2da --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_interface_specifications.sgra @@ -0,0 +1,54 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: SPECIFICATION + PROPERTIES: + PREFIX: IFCSPEC- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + - TITLE: RATIONALE + TYPE: String + REQUIRED: False + RELATIONS: + - TYPE: Parent + ROLE: Specifies + diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_personas.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_personas.sgra new file mode 100644 index 000000000..1c6f19638 --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_personas.sgra @@ -0,0 +1,74 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: PERSONA + PROPERTIES: + PREFIX: PERSONA- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: NAME + TYPE: String + REQUIRED: True + - TITLE: AGE + TYPE: String + REQUIRED: True + - TITLE: EDUCATION + TYPE: String + REQUIRED: False + - TITLE: BEHAVIOR_PATTERNS + TYPE: String + REQUIRED: False + - TITLE: GOALS + TYPE: String + REQUIRED: False + - TITLE: SKILLS + TYPE: String + REQUIRED: False + - TITLE: ATTITUDES + TYPE: String + REQUIRED: False + - TITLE: ENVIRONMENT + TYPE: String + REQUIRED: False + - TITLE: COMMENT + TYPE: String + REQUIRED: False + RELATIONS: + - TYPE: Parent + ROLE: Personifies diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_stakeholder_needs.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_stakeholder_needs.sgra new file mode 100644 index 000000000..ab2bb9f1b --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_stakeholder_needs.sgra @@ -0,0 +1,59 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: NEED + PROPERTIES: + PREFIX: STKNEED- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: SOURCE + TYPE: String + REQUIRED: True + - TITLE: PRIORITY + TYPE: SingleChoice(Must, HighWant, Want) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + - TITLE: RATIONALE + TYPE: String + REQUIRED: False + RELATIONS: + - TYPE: Parent + ROLE: Refines diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_stakeholder_requirements.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_stakeholder_requirements.sgra new file mode 100644 index 000000000..1bce3a031 --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_stakeholder_requirements.sgra @@ -0,0 +1,57 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: REQUIREMENT + PROPERTIES: + PREFIX: STKREQ- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: VERIFICATION + TYPE: MultipleChoice(Review, Analysis, Inspection, Test) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + - TITLE: RATIONALE + TYPE: String + REQUIRED: True + RELATIONS: + - TYPE: Parent + ROLE: Refines + diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_stakeholders.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_stakeholders.sgra new file mode 100644 index 000000000..f97286e4e --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_stakeholders.sgra @@ -0,0 +1,50 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: STAKEHOLDER + PROPERTIES: + PREFIX: STKHLDR- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: DESCRIPTION + TYPE: String + REQUIRED: False + - TITLE: COMMENT + TYPE: String + REQUIRED: False diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_system_architectures.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_architectures.sgra new file mode 100644 index 000000000..bfd6ba9e8 --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_architectures.sgra @@ -0,0 +1,53 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: ARCH_DECISION + PROPERTIES: + PREFIX: SYSARCH- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: DECISION + TYPE: String + REQUIRED: True + - TITLE: RATIONALE + TYPE: String + REQUIRED: True + RELATIONS: + - TYPE: Parent + diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_system_concept_of_operations.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_concept_of_operations.sgra new file mode 100644 index 000000000..02bba27d6 --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_concept_of_operations.sgra @@ -0,0 +1,50 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: CONOPS + PROPERTIES: + PREFIX: SYSCONOPS- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + RELATIONS: + - TYPE: Parent + ROLE: Refines diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_system_element_requirements.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_element_requirements.sgra new file mode 100644 index 000000000..38b01b937 --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_element_requirements.sgra @@ -0,0 +1,59 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: REQUIREMENT + PROPERTIES: + PREFIX: ELEMREQ- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: VERIFICATION + TYPE: MultipleChoice(Review, Analysis, Inspection, Test) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + - TITLE: RATIONALE + TYPE: String + REQUIRED: True + RELATIONS: + - TYPE: Parent + ROLE: Refines + - TYPE: File + ROLE: Implements + diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_system_element_verifications.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_element_verifications.sgra new file mode 100644 index 000000000..0cbb266dc --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_element_verifications.sgra @@ -0,0 +1,50 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: VERIFICATION + PROPERTIES: + PREFIX: ELEMVRFY- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + RELATIONS: + - TYPE: Parent + ROLE: Verifies diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_system_requirements.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_requirements.sgra new file mode 100644 index 000000000..42c0700de --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_requirements.sgra @@ -0,0 +1,57 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: REQUIREMENT + PROPERTIES: + PREFIX: SYSREQ- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: VERIFICATION + TYPE: MultipleChoice(Review, Analysis, Inspection, Test) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + - TITLE: RATIONALE + TYPE: String + REQUIRED: True + RELATIONS: + - TYPE: Parent + ROLE: Refines + diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_system_validations.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_validations.sgra new file mode 100644 index 000000000..beb351f95 --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_validations.sgra @@ -0,0 +1,50 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: VALIDATION + PROPERTIES: + PREFIX: SYSVALID- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + RELATIONS: + - TYPE: Parent + ROLE: Validates diff --git a/conformance/example1/content/src/shared/sdoc/grammars/sample_system_verifications.sgra b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_verifications.sgra new file mode 100644 index 000000000..d77ec9fc1 --- /dev/null +++ b/conformance/example1/content/src/shared/sdoc/grammars/sample_system_verifications.sgra @@ -0,0 +1,50 @@ +[GRAMMAR] +ELEMENTS: +- TAG: TEXT + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATEMENT + TYPE: String + REQUIRED: True +- TAG: SECTION + PROPERTIES: + IS_COMPOSITE: True + PREFIX: None + VIEW_STYLE: Narrative + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: TITLE + TYPE: String + REQUIRED: True +- TAG: VERIFICATION + PROPERTIES: + PREFIX: SYSVRFY- + FIELDS: + - TITLE: MID + TYPE: String + REQUIRED: True + - TITLE: UID + TYPE: String + REQUIRED: False + - TITLE: STATUS + TYPE: SingleChoice(Draft, Active, Deleted) + REQUIRED: True + - TITLE: TITLE + TYPE: String + REQUIRED: True + - TITLE: STATEMENT + TYPE: String + REQUIRED: True + RELATIONS: + - TYPE: Parent + ROLE: Verifies diff --git a/conformance/example1/content/src/strictdoc_config.py b/conformance/example1/content/src/strictdoc_config.py new file mode 100644 index 000000000..d408ad970 --- /dev/null +++ b/conformance/example1/content/src/strictdoc_config.py @@ -0,0 +1,77 @@ +from strictdoc.core.project_config import ProjectConfig + + +def create_config() -> ProjectConfig: + config = ProjectConfig( + project_title="SPDX Regulation Conformance Example 1: SEBoK Product as System : Commodity Consumer Electronics", + dir_for_sdoc_assets="assets", + dir_for_sdoc_cache="output/_cache", + + project_features=[ + # Stable features. + "DEEP_TRACEABILITY_SCREEN", + # "MATHJAX", - not used by this project + "SEARCH", + "TABLE_SCREEN", + "TRACEABILITY_SCREEN", + + # Experimental features + "DIFF", + "HTML2PDF", + "MERMAID", + "PROJECT_STATISTICS_SCREEN", + # "REQIF", + # "REQUIREMENT_TO_SOURCE_TRACEABILITY", + # "SOURCE_FILE_LANGUAGE_PARSERS", + # "STANDALONE_DOCUMENT_SCREEN", + "TRACEABILITY_MATRIX_SCREEN", + ], + + include_doc_paths=[ + "/*", + "/*/sdoc/**", + "/*/*/sdoc/**", + "/SOI/*/*/sdoc/**", + ], + + exclude_doc_paths=[ + "/.*/", + "/output", + ], + + include_source_paths=[ + ], + + exclude_source_paths=[ + ], + + grammars={ + "@sample_stakeholders_grammar": "shared/sdoc/grammars/sample_stakeholders.sgra", + "@sample_personas_grammar": "shared/sdoc/grammars/sample_personas.sgra", + "@sample_stakeholder_needs_grammar": "shared/sdoc/grammars/sample_stakeholder_needs.sgra", + "@sample_stakeholder_requirements_grammar": "shared/sdoc/grammars/sample_stakeholder_requirements.sgra", + "@sample_system_concept_of_operations_grammar": "shared/sdoc/grammars/sample_system_concept_of_operations.sgra", + "@sample_system_validations_grammar": "shared/sdoc/grammars/sample_system_validations.sgra", + "@sample_interface_specifications_grammar": "shared/sdoc/grammars/sample_interface_specifications.sgra", + "@sample_system_requirements_grammar": "shared/sdoc/grammars/sample_system_requirements.sgra", + "@sample_system_verifications_grammar": "shared/sdoc/grammars/sample_system_verifications.sgra", + "@sample_system_architectures_grammar": "shared/sdoc/grammars/sample_system_architectures.sgra", + "@sample_interface_requirements_grammar": "shared/sdoc/grammars/sample_interface_requirements.sgra", + "@sample_system_element_requirements_grammar": "shared/sdoc/grammars/sample_system_element_requirements.sgra", + "@sample_system_element_verifications_grammar": "shared/sdoc/grammars/sample_system_element_verifications.sgra", + }, + + # test_report_root_dict={ + # "reports/tests_integration.lit.junit.xml": "tests/integration", + # "reports/tests_integration_html2pdf.lit.junit.xml": "tests/integration", + # }, + + # Waiting for a fix to be released soon. + html2pdf_strict=False, + reqif_multiline_is_xhtml=True, + reqif_enable_mid=True, + section_behavior="[[SECTION]]", + statistics_generator="docs.sdoc_project_statistics.SDocStatisticsGenerator", + ) + return config + diff --git a/conformance/example1/content/src/system_concept_of_operations/sdoc/index.sdoc b/conformance/example1/content/src/system_concept_of_operations/sdoc/index.sdoc new file mode 100644 index 000000000..5d6eda3be --- /dev/null +++ b/conformance/example1/content/src/system_concept_of_operations/sdoc/index.sdoc @@ -0,0 +1,32 @@ +[DOCUMENT] +MID: c8df4cbae54e405e81ad87764b262a6b +TITLE: System Concept of Operations +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_system_concept_of_operations_grammar + +[TEXT] +MID: 5941c5c81aa74c8497b9051a7ee0856d +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: 47f7749075a74956b4160114edab0f05 +STATEMENT: >>> +From `SEBoK Wiki Glossary - Concept of Operations `_: + + *Verbal and graphic statement, in broad outline, of an organization’s assumptions or intent in regard to an operation or series of operations.* (ISO/IEC 2011) + + Source + ISO/IEC 2011. *Systems and software engineering - Life cycle processes - Requirements engineering*. Geneva, Switzerland: International Organization for Standardization/International Electrotechnical Commissions. ISO/IEC 29148. + + Discussion + The concept of operations frequently is embodied in long-range strategic plans and annual operational plans. In the latter case, the concept of operations in the plan covers a series of connected operations to be carried out simultaneously or in succession. The concept is designed to give an overall picture of the organization operations. + + It provides the basis for bounding the operating space, system capabilities, interfaces and operating environment. + + See also operational concept which is slightly different. +<<< diff --git a/conformance/example1/content/src/system_validations/sdoc/index.sdoc b/conformance/example1/content/src/system_validations/sdoc/index.sdoc new file mode 100644 index 000000000..d21988c7e --- /dev/null +++ b/conformance/example1/content/src/system_validations/sdoc/index.sdoc @@ -0,0 +1,28 @@ +[DOCUMENT] +MID: 1fc8c097e16142d39970f9c9c77159df +TITLE: System Validations +OPTIONS: + ENABLE_MID: True + +[GRAMMAR] +IMPORT_FROM_FILE: @sample_system_validations_grammar + +[TEXT] +MID: 351a8ff3670143cfb2ba0ff0da9f5aa0 +STATEMENT: >>> +SPDX-License-Identifier: Apache-2.0 +<<< + +[TEXT] +MID: c4966c44dd5e4e90910c6dfa467696ca +STATEMENT: >>> +From `SEBoK Wiki Glossary - validation `_: + +- Confirmation, through the provision of objective evidence, that the (stakeholder) requirements for a specific intended use or application have been fulfilled. (ISO 9000:2015) + +- The set of activities ensuring and gaining confidence that a system is able to accomplish its intended use, goals and objectives (i.e., meet stakeholder requirements) in the intended operational environment. The right system was built. (ISO/IEEE 2015, 1, Section 6.4.8) + +- The assurance that a product, service, or system meets the needs of the customer and other identified stakeholders. It often involves acceptance and suitability with external customers. Contrast with verification. (PMI 2013) + +- The process of providing evidence that the software and its associated products satisfy system requirements allocated to software at the end of each life cycle activity, solve the right problem, and satisfy intended use and user needs. (IEEE 1012-2004, 3.1.35) +<<<