Skip to content

Commit fc14a43

Browse files
RolandJentschETASRolandJentschETAS
authored
Merge pull request #2990 from etas-contrib/improvement_manuals_folders
add more detailed user centric manuals
2 parents ebc1b8f + 40ef67f commit fc14a43

1 file changed

Lines changed: 25 additions & 9 deletions

File tree

‎docs/contribute/general/folder.rst‎

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ The following shows the folder structure of the platform repository (ordered alp
4242
├── handbook/ -> Background, scope, high-level architecture of the platform features
4343
│ and handbook for the platform [:need:`wp__platform_handbook`],
4444
│ (e.g., onboarding, development guidelines, etc.)
45-
├── manuals/ -> User and integration manual(s)
45+
├── manuals/ -> User and integration manual(s) of the platform,
46+
│ may refer in the reference integration repository to the manuals for the modules.
4647
├── modules/ -> Modules of the SW platform. [:need:`wp__platform_arch`]
4748
├── platform_management_plan/ -> Overall Platform Management Plan [:need:`wp__platform_mgmt`]
4849
│ containing: [:need:`wp__project_mgt`], [:need:`wp__platform_safety_plan`],
@@ -142,10 +143,16 @@ See also `module template repository <https://github.com/eclipse-score/module_te
142143
│ │ └── security_planning/ -> Feature specific security workproducts planning
143144
│ │ [:need:`wp__platform_security_plan`]
144145
│ ├── manuals/ -> Module manual, e.g. integration manual, assumptions of use,
145-
│ │ safety manual [:need:`wp__requirements_comp_aou`],
146-
│ │ [:need:`wp__requirements_feat_aou`],
147-
│ │ [:need:`wp__module_safety_manual`],
148-
│ │ security_manual [:need:`wp__module_security_manual`].
146+
│ │ │ safety manual [:need:`wp__requirements_comp_aou`],
147+
│ │ │ [:need:`wp__requirements_feat_aou`],
148+
│ │ │ [:need:`wp__module_safety_manual`],
149+
│ │ │ security_manual [:need:`wp__module_security_manual`].
150+
│ │ │ -> Additional optional user centric documentation (e.g. configuration guide,
151+
│ │ │ examples user guide, APIs & usage, performance analysis)
152+
│ │ ├── config/ -> Configuration guide (optional)
153+
│ │ ├── examples/ -> Examples user guide (optional)
154+
│ │ ├── api_description/ -> API detail description (optional)
155+
│ │ └── performance/ -> Performance analysis (optional)
149156
│ ├── release/ -> Module release note [:need:`wp__module_sw_release_note`],
150157
│ │ module release plan [:need:`wp__module_sw_release_plan`],
151158
│ ├── safety_mgt/ -> Module safety plan [:need:`wp__module_safety_plan`],
@@ -170,6 +177,8 @@ See also `module template repository <https://github.com/eclipse-score/module_te
170177
│ │ │ Detail design + code inspection [:need:`wp__sw_implementation_inspection`],
171178
│ │ ├── manuals/ -> User documentation of a single component
172179
│ │ │ (e.g., user manual of a library, optional)
180+
│ │ │ (could contain optional subfolders for configuration guide,
181+
│ │ │ examples user guide, APIs & usage, performance analysis, see module manual folder)
173182
│ │ ├── requirements/ -> Component requirements [:need:`wp__requirements_comp`],
174183
│ │ │ requirements inspection [:need:`wp__requirements_inspect`]
175184
│ │ ├── safety_analysis/ -> Safety analysis on component level (only if component architecture exists)
@@ -213,10 +222,15 @@ For identification of the single feature, the repository name or module name sho
213222
│ ├── security_planning/ -> Feature specific security workproducts planning
214223
│ │ [:need:`wp__platform_security_plan`]
215224
│ ├── manuals/ -> Module manual, e.g. integration manual, assumptions of use,
216-
│ │ safety manual [:need:`wp__requirements_comp_aou`],
217-
│ │ [:need:`wp__requirements_feat_aou`],
218-
│ │ [:need:`wp__module_safety_manual`],
219-
│ │ security_manual [:need:`wp__module_security_manual`].
225+
│ │ │ safety manual [:need:`wp__requirements_comp_aou`],
226+
│ │ │ [:need:`wp__requirements_feat_aou`],
227+
│ │ │ [:need:`wp__module_safety_manual`],
228+
│ │ │ security_manual [:need:`wp__module_security_manual`].
229+
│ │ │ -> Additional optional user centric documentation (e.g. configuration guide, examples user guide, APIs & usage, performance analysis)
230+
│ │ ├── config/ -> Configuration guide (optional)
231+
│ │ ├── examples/ -> Examples user guide (optional)
232+
│ │ ├── api_description/ -> APIs detail description (optional)
233+
│ │ └── performance/ -> Performance analysis (optional)
220234
│ ├── release/ -> Module release note [:need:`wp__module_sw_release_note`],
221235
│ │ module release plan [:need:`wp__module_sw_release_plan`],
222236
│ ├── safety_mgt/ -> Module safety plan [:need:`wp__module_safety_plan`],
@@ -241,6 +255,8 @@ For identification of the single feature, the repository name or module name sho
241255
│ │ │ Detail design + code inspection [:need:`wp__sw_implementation_inspection`],
242256
│ │ ├── manuals/ -> User documentation of a single component
243257
│ │ │ (e.g., user manual of a library, optional)
258+
│ │ │ (could contain optional subfolders for configuration guide,
259+
│ │ │ examples user guide, APIs & usage, performance analysis, see module manual folder)
244260
│ │ ├── requirements/ -> Component requirements [:need:`wp__requirements_comp`],
245261
│ │ │ requirements inspection [:need:`wp__requirements_inspect`]
246262
│ │ ├── safety_analysis/ -> Safety analysis on component level (only if component architecture exists)

0 commit comments

Comments
 (0)