|
| 1 | +.. |
| 2 | + # ******************************************************************************* |
| 3 | + # Copyright (c) 2025 Contributors to the Eclipse Foundation |
| 4 | + # |
| 5 | + # See the NOTICE file(s) distributed with this work for additional |
| 6 | + # information regarding copyright ownership. |
| 7 | + # |
| 8 | + # This program and the accompanying materials are made available under the |
| 9 | + # terms of the Apache License Version 2.0 which is available at |
| 10 | + # https://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + # |
| 12 | + # SPDX-License-Identifier: Apache-2.0 |
| 13 | + # ******************************************************************************* |
| 14 | +
|
| 15 | +.. _glossary: |
| 16 | + |
| 17 | +Glossary |
| 18 | +######## |
| 19 | + |
| 20 | +Overview |
| 21 | +======== |
| 22 | + |
| 23 | +The glossary is intended to provide a common vocabulary for all project participants |
| 24 | +and to ensure clarity and consistency in the use of terminology across the project. |
| 25 | + |
| 26 | +It includes definitions for terms related to the building blocks concept, |
| 27 | +development phases, roles, work products, and other relevant concepts. |
| 28 | + |
| 29 | +Terms |
| 30 | +===== |
| 31 | + |
| 32 | +.. list-table:: Process Description Glossary |
| 33 | + :header-rows: 1 |
| 34 | + :widths: 20,80, 80 |
| 35 | + |
| 36 | + * - **Term** |
| 37 | + - **Definition** |
| 38 | + - **Comment/Link** |
| 39 | + |
| 40 | + * - **Assumptions of Use (AoU)** |
| 41 | + - Constraints and conditions under which a component, feature, or platform element can be safely and correctly used. AoUs must be documented and considered by users of the element. |
| 42 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 43 | + |
| 44 | + * - **Building Blocks** |
| 45 | + - Fundamental structural elements of the platform including Features, Components, Units, and Dependable Elements that form the basis of the system architecture. |
| 46 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 47 | + |
| 48 | + * - **Change Request (CR)** |
| 49 | + - A formal request to modify, add, or remove features or components in the platform. Change requests drive the development lifecycle and must be tracked and approved. |
| 50 | + - :ref:`Process change management<change_management>` |
| 51 | + |
| 52 | + * - **Committer** |
| 53 | + - A developer role who reviews and accepts contributions (pull requests) to the main codebase. Committers maintain code quality and enforce project processes. |
| 54 | + - :ref:`Roles<roles>` |
| 55 | + |
| 56 | + * - **Component** |
| 57 | + - A major building block of the platform consisting of one or more Units. Components are defined by Component Requirements and Component Architecture, and are tested through Component Integration Tests. |
| 58 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 59 | + |
| 60 | + * - **Component Architecture** |
| 61 | + - The design specification that defines how a component is structured, including its internal organization, interfaces, and relationships with other components. |
| 62 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 63 | + |
| 64 | + * - **Component Integration Tests** |
| 65 | + - Verification tests that verifies component requirements and architecture, as well as the integration of multiple Units into a single Component. |
| 66 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 67 | + |
| 68 | + * - **Component Safety/Security Analysis** |
| 69 | + - Systematic analysis performed on component architecture to verify compliance with safety and security requirements, documenting any violations or potential faults. |
| 70 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 71 | + |
| 72 | + * - **Concept Phase** |
| 73 | + - Initial development phase where feasibility and decision criteria are established for a new feature or component request. Only Change Management is mandatory in this phase. |
| 74 | + - :ref:`Lifecycle concept<general_concepts_lifecycle>` |
| 75 | + |
| 76 | + * - **Contributor** |
| 77 | + - An individual who contributes to the project by submitting code, documentation, processes, or other work products. Contributors work within defined workflows and processes. |
| 78 | + - :ref:`Roles<roles>` |
| 79 | + |
| 80 | + * - **Delivery Container** |
| 81 | + - A packaging mechanism for delivering Dependable Elements (e.g., executable code or libraries) to users or integrators of the platform. |
| 82 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 83 | + |
| 84 | + * - **Dependable Element** |
| 85 | + - The highest abstraction level in the building blocks model. A Dependable Element consists of one or more Components and can be developed as a Safety Element out of Context (SEooC). It is delivered in a Delivery Container. |
| 86 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 87 | + |
| 88 | + * - **Dependable Element View** |
| 89 | + - Documentation that maps components to Dependable Elements, showing how components are grouped for delivery. |
| 90 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 91 | + |
| 92 | + * - **Detailed Design** |
| 93 | + - The comprehensive design specification for a Unit, including implementation details and algorithms. Verified through Unit Tests. |
| 94 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 95 | + |
| 96 | + * - **Development Phase** |
| 97 | + - The phase where accepted features or components are planned, implemented, and verified according to defined project processes. May include iterative implementation cycles. |
| 98 | + - :ref:`Lifecycle concept<general_concepts_lifecycle>` |
| 99 | + |
| 100 | + * - **Feature** |
| 101 | + - A collection of related components that provide a specific capability to the platform. Features are defined by Feature Requirements and Feature Architecture. |
| 102 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 103 | + |
| 104 | + * - **Feature Architecture** |
| 105 | + - The design specification that defines how a feature is structured, including its components, interfaces, and logical architecture interfaces. |
| 106 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 107 | + |
| 108 | + * - **Feature Integration Tests** |
| 109 | + - Verification tests that verifies feature requirements and architecture, ensuring proper integration of multiple components within the feature. |
| 110 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 111 | + |
| 112 | + * - **Feature Requirements** |
| 113 | + - Specifications defining what a feature must accomplish, derived from higher-level stakeholder requirements and allocated to components. |
| 114 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 115 | + |
| 116 | + * - **Feature Safety/Security Analysis** |
| 117 | + - Systematic analysis performed on feature architecture to verify compliance with safety and security requirements at the feature level, documenting any violations or potential faults. |
| 118 | + - ::ref:`Building blocks concept<general_concepts_building_blocks>` |
| 119 | + |
| 120 | + * - **Impact Analysis** |
| 121 | + - The process of evaluating the effects and consequences of proposed changes on work products. |
| 122 | + - :ref:`Process change management<change_management>` |
| 123 | + |
| 124 | + * - **Inspection** |
| 125 | + - A formal review of work products supported by a checklist with documented conduct and outcome. Inspections verify quality and compliance of requirements, architecture, and implementation. |
| 126 | + - ::ref:`Review concept<review_concept>` |
| 127 | + |
| 128 | + * - **Logical Architecture Interfaces** |
| 129 | + - Abstract interfaces defined at the feature level that specify how components communicate and interact within a feature. |
| 130 | + - ::ref:`Building blocks concept<general_concepts_building_blocks>` |
| 131 | + |
| 132 | + * - **Maintenance Phase** |
| 133 | + - Development phase following the first major release, where released features and components are maintained. Triggered by problem reports requiring fixes. |
| 134 | + - :ref:`Lifecycle concept<general_concepts_lifecycle>` |
| 135 | + |
| 136 | + * - **Module** |
| 137 | + - An synonym term for Dependable Element |
| 138 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 139 | + |
| 140 | + * - **Module Team** |
| 141 | + - Cross-functional team responsible for all artifacts within a Module, including development, quality, safety, and security activities. |
| 142 | + - :ref:`Roles<roles>` |
| 143 | + |
| 144 | + * - **Platform** |
| 145 | + - The complete software platform consisting of features, components, and supporting infrastructure. |
| 146 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 147 | + |
| 148 | + * - **Platform Integration Tests** |
| 149 | + - Verification tests performed on reference hardware platforms to test stakeholder requirements and overall platform functionality. |
| 150 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 151 | + |
| 152 | + * - **Platform Safety/Security Analysis** |
| 153 | + - Systematic analysis of the complete platform architecture to verify compliance with stakeholder-level safety and security requirements, documenting any violations or potential faults. |
| 154 | + - ::ref:`Building blocks concept<general_concepts_building_blocks>` |
| 155 | + |
| 156 | + * - **Problem Report** |
| 157 | + - A report documenting issues found in released features or components, including bugs, quality issues, or safety/security anomalies. Initiates the Maintenance Phase. |
| 158 | + - :ref:`Workflows<workflows>` |
| 159 | + |
| 160 | + * - **Project Lead** |
| 161 | + - Executive role responsible for strategic decisions, approving feature requests, performing project management, and high-level coordination between software modules. |
| 162 | + - :ref:`Roles<roles>` |
| 163 | + |
| 164 | + * - **Quality Manager** |
| 165 | + - Role responsible for quality assurance, process compliance, work product reviews, quality audits, and continuous process improvement. |
| 166 | + - :ref:`Process quality management<quality_management>` |
| 167 | + |
| 168 | + * - **Role** |
| 169 | + - A defined position within the project with specific responsibilities, authorities, and required competencies. Examples include Project Lead, Developer, Tester, Safety Manager. |
| 170 | + - :ref:`Roles<roles>` |
| 171 | + |
| 172 | + * - **Safety Element out of Context (SEooC)** |
| 173 | + - A software element developed and analyzed independently but intended to be integrated into specific applications, as defined by functional safety standards. |
| 174 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 175 | + |
| 176 | + * - **Safety Manager** |
| 177 | + - Role responsible for ensuring functional safety compliance (e.g., ISO 26262), conducting safety analyses, approving safety work products, and providing safety guidance. |
| 178 | + - :ref:`Process safety management<process_safety_management>` |
| 179 | + |
| 180 | + * - **Security Manager** |
| 181 | + - Role responsible for security management, vulnerability handling, cybersecurity compliance (e.g., ISO SAE 21434), and security analysis approvals. |
| 182 | + - :ref:`Process security management<security_management>` |
| 183 | + |
| 184 | + * - **Source Code** |
| 185 | + - The actual implementation of a Unit, typically written in a programming language and version-controlled in the repository. |
| 186 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 187 | + |
| 188 | + * - **Stakeholder Requirements** |
| 189 | + - High-level requirements specified at the platform level that define what the platform must accomplish for its intended users. |
| 190 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 191 | + |
| 192 | + * - **SW Platform Assumptions of Use** |
| 193 | + - Constraints and conditions defined at the platform level that must be considered by users integrating the platform into their applications. |
| 194 | + - :ref:`Building blocks concept<general_concepts_building_blocks>` |
| 195 | + |
| 196 | + * - **Traceability** |
| 197 | + - The documented relationship between work products at different levels (requirements, architecture, design, code, tests) enabling impact analysis and coverage determination. |
| 198 | + - :ref:`Traceability concept<general_concepts_traceability>` |
| 199 | + |
| 200 | + * - **Unit** |
| 201 | + - The lowest level in the building blocks model, representing source code that implements a specific function or feature. Units are verified through Unit Tests. |
| 202 | + - :ref:`Implementation process<implementation>` |
| 203 | + |
| 204 | + * - **Unit Tests** |
| 205 | + - Verification tests that verifies the detailed design and implementation of individual Units. |
| 206 | + - :ref:`Verification process<process_verification>` |
| 207 | + |
| 208 | + * - **Verification** |
| 209 | + - The process of confirming that work products (requirements, architecture, design, code) correctly implement and satisfy higher-level specifications through testing and analysis. |
| 210 | + - :ref:`Verification process<process_verification>` |
| 211 | + |
| 212 | + * - **Work Product** |
| 213 | + - Any tangible output produced during development, including requirements, architecture documents, design specifications, source code, test cases, and analysis reports. |
| 214 | + - :ref:`Work products<work_products>` |
| 215 | + |
| 216 | + * - **Workflow** |
| 217 | + - A defined sequence of activities with inputs, outputs, responsible roles, and supporting guidance. Workflows form the central building blocks of the process description. |
| 218 | + - :ref:`Workflows<workflows>` |
0 commit comments