Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct folder structure guidance #61

Merged
merged 1 commit into from
Dec 12, 2024
Merged

docs: correct folder structure guidance #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 17 additions & 19 deletions docs/process/guidelines/general/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,7 @@ can be in a different order.
docs/ -> Global documentation of the platform.
concepts/ -> Description of overall concepts.
glossary/ -> Glossary of abbreviations used in the platform context.
guidelines/ -> Guidelines regarding ...
architecture/ -> ... architecture, e.g., documentation and tracing.
coding/ -> ... coding rules, style, formatting, best practices for the languages C++, Rust & Python.
detailed_design/ -> ... detailed design of the software components.
general/ -> ... general topics, e.g. naming conventions or the folder structure.
integration/ -> ... platform integration manual
tutorials/ -> ... general tutorials.

manual/ -> user and integration manual(s)
overview/ -> Introduction and high-level description of the platform features.
platform_management_plan/ -> Overall Platform Management Plan [WP_PLATFORM_MGMT], consisting of ...
project_management.rst -> ... Project Management.
Expand All @@ -57,14 +50,19 @@ can be in a different order.
software_development.rst -> ... Development [WP_SW_DEV_PLAN].
software_verification.rst -> ... Verification [WP_VERIFICATION_PLAN].
documentation_management.rst -> ... Documentation Management.
security_management.rst -> ... Security Management.
release/ -> [WP_PLATFORM_SW_RELEASE_NOTE]
safety/ -> safety documentation on platform level (SEooC): [WP_FEATURE_DFA], [WP_PLATFORM_SW_SAFETY_MANUAL], [WP_PLATFORM_SAFETY_CASE], [WP_CMR_REPORTS], [WP_ASSESSMENT_REPORT]
stakeholder_requirements/ -> Stakeholder requirements of the platform [WP_STAKEHOLDER_REQ].
security/ -> security documentation on platform level
requirements/ -> requirements on platform level ...
stakeholder/ -> ... Stakeholder requirements [WP_STAKEHOLDER_REQ].
tool/ -> ... Tool requirements [WP_TOOL_REQ]
tutorials/ -> General tutorials.

examples/ -> examples how a C++, Rust, Python module can be set up

features/ -> All features of the platform.
<feature-name>/ -> Folder containing all sub-folders corresponding to one feature and the contribution request [WP_CONT_REQUEST]
<feature_name>/ -> Folder containing all sub-folders corresponding to one feature and the contribution request [WP_CONT_REQUEST]
docs/ -> Documentation of the feature consisting of ...
architecture/ -> ... Feature architecture [WP_FEATURE_ARCHITECTURE].
requirements/ -> ... Feature requirements [WP_FEATURE_REQ].
Expand All @@ -73,10 +71,10 @@ can be in a different order.
verification/ -> ... Feature verification report (reporting all feature verifications) [WP_PLATFORM_SW_VERIFICATION_REPORT]
tests/ -> Feature tests, consisting of ...
integration-tests/ -> ... integration tests [WP_FEATURE_INTEGRATION_TEST].
toolchain/ -> Definition of toolchain incl. their requirements [WP_TOOL_REQ]
toolchain/ -> Definition of toolchain

modules/ -> Modules of the SW platform.
<module-name>/ -> Folder containing all artifacts corresponding to one module.
<module_name>/ -> Folder containing all artifacts corresponding to one module.
docs/ -> Documentation of the module consisting of ...
manual/ -> ... Module manual, e.g. integration manual, assumptions of use and safety manual [WP_SW_COMPONENT_AOU], [WP_MODULE_SW_SAFETY_MANUAL].
release/ -> ... Module release note [WP_MODULE_SW_RELEASE_NOTE] plus safety assessment [WP_ASSESSMENT_REPORT]
Expand All @@ -85,7 +83,7 @@ can be in a different order.
verification/ -> ... Module verification report (reporting all module's components verifications) [WP_MODULE_SW_VERIFICATION_REPORT] plus safety analysis conformance reviews [WP_CMR_REPORTS]

components/ -> Components of the module.
<component-name>/ -> Folder containing all artifacts corresponding to one component.
<component_name>/ -> Folder containing all artifacts corresponding to one component.
docs/ -> Documentation of the component consisting of ...
architecture/ -> ... Component architecture (only if sub-components exist) [WP_SW_COMPONENT_ARCHITECTURE].
requirements/ -> ... Component requirements [WP_SW_COMPONENT_REQ] and HSI (if relevant) [WP_HSI].
Expand All @@ -94,15 +92,15 @@ can be in a different order.
src/ -> Source files of the component (incl. detailed design) [WP_SW_IMPLEMENTATION].
include/ -> Include files of the component
tests/ -> Component tests, consisting of ...
unit_tests/ -> ... unit tests [WP_SW_UNIT_TEST] (for lowest level of components).
integration_tests/ -> ... integration tests [WP_SW_COMPONENT_INTEGRATION_TEST].
verification-tests/ -> ... verification tests [WP_SW_COMPONENT_TEST].
<sub-component-name>/ -> Sub-Component of the Component.
unit/ -> ... unit tests [WP_SW_UNIT_TEST] (for lowest level of components).
integration/ -> ... integration tests [WP_SW_COMPONENT_INTEGRATION_TEST].
verification/ -> ... verification tests [WP_SW_COMPONENT_TEST].
<sub_component_name>/ -> Sub-Component of the Component.
copy the relevant folders below <component-name> if applicable (example: no code inspection needed for sub-components from the Open Source)

platform-integration-tests/ -> Integration tests on reference hardware.
platform_integration_tests/ -> Integration tests on reference hardware.

process -> process definition including workflows, workproducts, roles, guidance [WP_PROCESS_DEFINITION]
process/ -> process definition including workflows, workproducts, roles, guidance [WP_PROCESS_DEFINITION]

registry/ -> infrastructure configuration

Expand Down
Loading