Skip to content

Commit 6fbc1ce

Browse files
docs: correct folder structure guidance
Signed-off-by: aschemmel-tech <[email protected]> Issue-ref: see eclipse-score#21
1 parent 9001735 commit 6fbc1ce

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

docs/process/guidelines/general/index.rst

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,7 @@ can be in a different order.
3333
docs/ -> Global documentation of the platform.
3434
concepts/ -> Description of overall concepts.
3535
glossary/ -> Glossary of abbreviations used in the platform context.
36-
guidelines/ -> Guidelines regarding ...
37-
architecture/ -> ... architecture, e.g., documentation and tracing.
38-
coding/ -> ... coding rules, style, formatting, best practices for the languages C++, Rust & Python.
39-
detailed_design/ -> ... detailed design of the software components.
40-
general/ -> ... general topics, e.g. naming conventions or the folder structure.
41-
integration/ -> ... platform integration manual
42-
tutorials/ -> ... general tutorials.
43-
36+
manual/ -> user and integration manual(s)
4437
overview/ -> Introduction and high-level description of the platform features.
4538
platform_management_plan/ -> Overall Platform Management Plan [WP_PLATFORM_MGMT], consisting of ...
4639
project_management.rst -> ... Project Management.
@@ -57,14 +50,19 @@ can be in a different order.
5750
software_development.rst -> ... Development [WP_SW_DEV_PLAN].
5851
software_verification.rst -> ... Verification [WP_VERIFICATION_PLAN].
5952
documentation_management.rst -> ... Documentation Management.
53+
security_management.rst -> ... Security Management.
6054
release/ -> [WP_PLATFORM_SW_RELEASE_NOTE]
6155
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]
62-
stakeholder_requirements/ -> Stakeholder requirements of the platform [WP_STAKEHOLDER_REQ].
56+
security/ -> security documentation on platform level
57+
requirements/ -> requirements on platform level ...
58+
stakeholder/ -> ... Stakeholder requirements [WP_STAKEHOLDER_REQ].
59+
tool/ -> ... Tool requirements [WP_TOOL_REQ]
60+
tutorials/ -> General tutorials.
6361
6462
examples/ -> examples how a C++, Rust, Python module can be set up
6563
6664
features/ -> All features of the platform.
67-
<feature-name>/ -> Folder containing all sub-folders corresponding to one feature and the contribution request [WP_CONT_REQUEST]
65+
<feature_name>/ -> Folder containing all sub-folders corresponding to one feature and the contribution request [WP_CONT_REQUEST]
6866
docs/ -> Documentation of the feature consisting of ...
6967
architecture/ -> ... Feature architecture [WP_FEATURE_ARCHITECTURE].
7068
requirements/ -> ... Feature requirements [WP_FEATURE_REQ].
@@ -73,10 +71,10 @@ can be in a different order.
7371
verification/ -> ... Feature verification report (reporting all feature verifications) [WP_PLATFORM_SW_VERIFICATION_REPORT]
7472
tests/ -> Feature tests, consisting of ...
7573
integration-tests/ -> ... integration tests [WP_FEATURE_INTEGRATION_TEST].
76-
toolchain/ -> Definition of toolchain incl. their requirements [WP_TOOL_REQ]
74+
toolchain/ -> Definition of toolchain
7775
7876
modules/ -> Modules of the SW platform.
79-
<module-name>/ -> Folder containing all artifacts corresponding to one module.
77+
<module_name>/ -> Folder containing all artifacts corresponding to one module.
8078
docs/ -> Documentation of the module consisting of ...
8179
manual/ -> ... Module manual, e.g. integration manual, assumptions of use and safety manual [WP_SW_COMPONENT_AOU], [WP_MODULE_SW_SAFETY_MANUAL].
8280
release/ -> ... Module release note [WP_MODULE_SW_RELEASE_NOTE] plus safety assessment [WP_ASSESSMENT_REPORT]
@@ -85,7 +83,7 @@ can be in a different order.
8583
verification/ -> ... Module verification report (reporting all module's components verifications) [WP_MODULE_SW_VERIFICATION_REPORT] plus safety analysis conformance reviews [WP_CMR_REPORTS]
8684
8785
components/ -> Components of the module.
88-
<component-name>/ -> Folder containing all artifacts corresponding to one component.
86+
<component_name>/ -> Folder containing all artifacts corresponding to one component.
8987
docs/ -> Documentation of the component consisting of ...
9088
architecture/ -> ... Component architecture (only if sub-components exist) [WP_SW_COMPONENT_ARCHITECTURE].
9189
requirements/ -> ... Component requirements [WP_SW_COMPONENT_REQ] and HSI (if relevant) [WP_HSI].
@@ -94,15 +92,15 @@ can be in a different order.
9492
src/ -> Source files of the component (incl. detailed design) [WP_SW_IMPLEMENTATION].
9593
include/ -> Include files of the component
9694
tests/ -> Component tests, consisting of ...
97-
unit_tests/ -> ... unit tests [WP_SW_UNIT_TEST] (for lowest level of components).
98-
integration_tests/ -> ... integration tests [WP_SW_COMPONENT_INTEGRATION_TEST].
99-
verification-tests/ -> ... verification tests [WP_SW_COMPONENT_TEST].
100-
<sub-component-name>/ -> Sub-Component of the Component.
95+
unit/ -> ... unit tests [WP_SW_UNIT_TEST] (for lowest level of components).
96+
integration/ -> ... integration tests [WP_SW_COMPONENT_INTEGRATION_TEST].
97+
verification/ -> ... verification tests [WP_SW_COMPONENT_TEST].
98+
<sub_component_name>/ -> Sub-Component of the Component.
10199
copy the relevant folders below <component-name> if applicable (example: no code inspection needed for sub-components from the Open Source)
102100
103-
platform-integration-tests/ -> Integration tests on reference hardware.
101+
platform_integration_tests/ -> Integration tests on reference hardware.
104102
105-
process -> process definition including workflows, workproducts, roles, guidance [WP_PROCESS_DEFINITION]
103+
process/ -> process definition including workflows, workproducts, roles, guidance [WP_PROCESS_DEFINITION]
106104
107105
registry/ -> infrastructure configuration
108106

0 commit comments

Comments
 (0)