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 feature (change) request [wp__feat_request]
           architecture/           -> Feature architecture [wp__feature_arch]
           requirements/           -> Feature requirements [wp__requirements_feat]
           safety_analysis/        -> Safety analysis on feature level [wp__feature_fmea], [wp__feature_dfa]
           safety_planning/        -> Feature specific safety workproducts planning
           security_analysis/      -> Security analysis on feature level [wp__feature_security_analysis]
           verification/           -> Feature verification, consisting of Architecture review [wp__sw_arch_verification],
              integration_tests/   -> Feature Integration tests [wp__verification_feat_int_test]

    glossary/                      -> Glossary of abbreviations used in the platform context
    introduction/                  -> Background, scope and high-level architecture of the platform features
    manuals/                       -> User and integration manual(s)
    modules/                       -> Modules of the SW platform.
    platform_management_plan/      -> Overall Platform Management Plan [wp__platform_mgmt]
    quality/                       -> Quality documentation on platform level:
                                         [wp__qms_report]
    requirements/                  -> Requirements on platform level
        stakeholder/               -> Stakeholder requirements [wp__requirements_stkh]
        tool/                      -> Tool requirements (not covered in tool repositories)
    safety/                        -> Safety documentation on platform level (SEooC):
                                         [wp__platform_dfa], [wp__platform_safety_manual],
                                         [wp__platform_safety_package], [wp__fdr_reports],
                                         [wp__audit_report]
    score_releases/                -> [wp__platform_sw_release_note]
    score_tools/                   -> Tool list and [wp__tool_verification_report]
    security/                      -> Security documentation on platform level:
                                         [wp__platform_security_manual], [wp__platform_security_package], [wp__sw_platform_sbom]
    verification_report/           -> Platform verification report (reporting all platform feature's verifications)
                                         [wp__verification_platform_ver_report]

platform_integration_tests/        -> Integration tests on reference hardware verifying stakeholder requirements. [wp__verification_platform_int_test]
tools/                             -> Platform tools (not covered in tool repositories)

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 [wp__requirements_comp_aou],
                                          [wp__module_safety_manual],
                                          security_manual [wp__module_security_manual].
      release/                      -> Module release note [wp__module_sw_release_note],
      safety_mgt/                   -> Module safety plan [wp__module_safety_plan],
                                          module safety package [wp__module_safety_package],
                                          formal documents reviews [wp__fdr_reports]
      security_mgt/                 -> Module security plan [wp__module_security_plan],
                                          module securty package [wp__module_security_package],
                                          formal documents reviews [wp__fdr_reports_security],
                                          module SW bill of material [wp__sw_module_sbom]
      verification_report/          -> Module verification report
                                          components verifications [wp__verification_module_ver_report],
                                          safety analysis formal reviews [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
                                          Unit tests [wp__verification_sw_unit_test]
                                          Test doubles
         <lower_level_comp>/        -> lower level component following <component_name> folder structure
         details/                   -> Private implementation details of the component following <component_name> folder structure

      docs/                         -> Documentation of the component
         architecture/              -> Component architecture (only if lower level components exist)
                                          [wp__component_arch].
         detailed_design/           -> Detailed Design [wp__sw_implementation]
         requirements/              -> Component requirements [wp__requirements_comp]
         safety_analysis/           -> Safety analysis on component level (only if component architecture exists)
                                          [wp__sw_component_fmea], [wp__sw_component_dfa]
         security_analysis/         -> Security analysis on component level (only if component architecture exists)
                                          [wp__sw_component_security_analysis]
         verification/              -> Component verification, consisting of Architecture review [wp__sw_arch_verification],
                                       code inspection [wp__sw_implementation_inspection],
            integration_tests/      -> Component integration tests [wp__verification_comp_int_test]
         <lower_level_comp>/        -> Lower level component following <component_name> folder structure