Folder Structure

Platform Folder Structure

The following shows the folder structure of the platform repository (ordered alphabetically). The ordering of the documentation in the rendered documentation can be in a different order.

docs/                              -> Global documentation of the platform
    contribute/                    -> Description on how to contribute
    features/                      -> All features of the platform
        <feature_name>/            -> Features including sub-folders and contribution request
           docs/                   -> Documentation of the feature
               architecture/       -> Feature architecture [Feature Architecture (wp__feature_arch)]
               requirements/       -> Feature requirements [Feature Requirements (wp__requirements__feat)]
               safety_analysis/    -> Safety analysis on feature level [Feature Safety Analysis (wp__feature_safety_analysis)]
               safety_planning/    -> Feature specific safety workproducts planning
               verification/       -> Feature verification report (reporting all feature verifications)
                                         [Platform Verification Report (wp__verification__platform_ver_report)]
           tests/                  -> Feature tests, consisting of
              integration-tests/   -> Integration tests [Feature Integration test (wp__verification__feat_int_test)]

        toolchain/                 -> Definition of toolchain
    glossary/                      -> Glossary of abbreviations used in the platform context
    manuals/                       -> user and integration manual(s)
    overview/                      -> Introduction and high-level description
                                      of the platform features.
    platform_management_plan/      -> Overall Platform Management Plan [Platform Management Plan (wp__platform_mgmt)]
    score_releases/                -> [Platform Release Notes (wp__platform_sw_release_note)]
    safety/                        -> safety documentation on platform level (SEooC):
                                         [Feature DFA (wp__feature_dfa)], [Platform Safety Manual (wp__platform_safety_manual)],
                                         [Platform Safety Package (wp__platform_safety_package)], [Formal Document Review Reports (wp__fdr_reports)],
                                         [Process Safety Audit Report (wp__audit_report)]
    security/                      -> security documentation on platform level
    requirements/                  -> requirements on platform level
        stakeholder/               -> Stakeholder requirements [Stakeholder Requirements (wp__requirements__stkh)]

modules/                           -> Modules of the SW platform.
platform_integration_tests/        -> Integration tests on reference hardware verifying stakeholder requirements.

process/                           -> process definition including workflows, workproducts,
                                         roles, guidance [Process Definition (wp__process_definition)]

registry/                          -> infrastructure configuration

README.md                          -> Entrypoint of the repository

Module Folder Structure

The modules and components shall follow the folder structure which was presented. However if there are good reasons the structure can be adapted.

<module_name>/                      -> Folder containing all artifacts corresponding to one module.
   docs/                            -> Documentation of the module
      manual/                       -> Module manual, e.g. integration manual, assumptions of use,
                                          safety manual [Component Assumptions of Use (wp__requirements__comp_aou)],
                                          [Module Safety Manual (wp__module_safety_manual)].
      release/                      -> Module release note [Module Release Notes (wp__module_sw_release_note)],
                                          safety assessment [Process Safety Audit Report (wp__audit_report)]
      safety_plan/                  -> Module safety plan [Module Safety Plan (wp__module_safety_plan)],
                                          module safety case [Module Safety Package (wp__module_safety_package)],
                                          conformance reviews [Formal Document Review Reports (wp__fdr_reports)]
      safety_analysis/              -> Safety analysis on module level [Component DFA (wp__sw_component_dfa)]
      verification/                 -> Module verification report
                                          components verifications [Module Verification Report (wp__verification__module_ver_report)],
                                          safety analysis conformance reviews [Formal Document Review Reports (wp__fdr_reports)]

   <component_name>/                -> Components of the module.
                                          Folder containing all artifacts corresponding to one component.

      src/                          -> Source files of the component consisting of
                                          Include files
                                          Source Files
                                          Detailed Design [Implementation (wp__sw_implementation)]
                                          Unit tests [Unit test (wp__verification__sw_unit_test)]
         <lower_level_comp>/        -> lower level component following <component_name> folder structure

      docs/                         -> Documentation of the component
         architecture/              -> Component architecture (only if lower level components exist)
                                          [Component Architecture (wp__component_arch)].
         requirements/              -> Component requirements [Component Requirements (wp__requirements__comp)],
                                          HSI (if relevant) [Hardware-software interface... (wp__hsi)]
         safety_analysis/           -> Safety analysis on component level
                                          [Component Safety Analysis (wp__sw_component_safety_analysis)]
         verification/              -> Architecture review [Architecture Verification (wp__sw_arch_verification)],
                                          code inspection [Implementation Inspection (wp__sw_implementation_inspection)]
         <lower_level_comp>/        -> Lower level component following <component_name> folder structure

      tests/                        -> Feature level tests, consisting of
                                          integration tests [Component Integration test (wp__verification__comp_int_test)]
                                          verification tests [Component test (wp__verification__component_test)]