dido:99_annexes:annex-d-requirements:part-04:p4-req-21-11-005

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

dido:99_annexes:annex-d-requirements:part-04:p4-req-21-11-005 [2026/08/07 14:16] – created owendido:99_annexes:annex-d-requirements:part-04:p4-req-21-11-005 [2026/08/07 14:17] (current) – owen
Line 1: Line 1:
-====== P4-REQ-21-11-004 ======+====== P4-REQ-21-11-005 ======
  
 [[dido:99_annexes:annex-d-requirements:part-04:start| Return to Requirements]] [[dido:99_annexes:annex-d-requirements:part-04:start| Return to Requirements]]
Line 5: Line 5:
 ===== Statement ===== ===== Statement =====
  
-The Developer Handbook SHALL define naming conventions.+The Developer Handbook SHALL define coding style requirements.
  
 ===== Source ===== ===== Source =====
Line 13: Line 13:
 ===== Rationale ===== ===== Rationale =====
  
-Naming conventions provide consistent identification across source files, modules, IDL structures, generated types, DDS Topics, QoS profiles, configuration files, scripts, and traceability artifacts.+Coding style requirements establish consistent practices for hand-authored Phase 0 implementation code.
  
-Consistent naming improves readability, reviewability, and traceability across the Phase 0 implementation baseline.+Defined style supports readability, maintainability, reviewability, dependency discipline, generated-type usage, and consistent distinction between hand-authored logic and generated code.
  
 ===== Applies To ===== ===== Applies To =====
Line 21: Line 21:
 This requirement applies to: This requirement applies to:
  
-  * repository directories; +  * hand-authored Phase 0 source code; 
-  * source files and modules; +  * implementation modules; 
-  * IDL structures and generated types; +  * supporting modules; 
-  * DDS Topics and QoS profiles; +  * wrappers and adapters; and 
-  * configuration files; and +  * applicable code-review activities.
-  * scripts and traceability artifacts.+
  
 ===== Verification ===== ===== Verification =====
  
-Verification SHALL confirm that the Developer Handbook defines naming conventions for applicable Phase 0 artifact categories.+Verification SHALL confirm that the Developer Handbook defines coding style requirements.
  
 Verification activities should include review checks confirming that: Verification activities should include review checks confirming that:
  
-  * directory naming is addressed; +  * source and module organization is addressed; 
-  * source and module naming is addressed; +  * naming of functions, methods, classes, and constants is addressed; 
-  * IDL and generated-type naming is addressed; +  * imports and dependencies are addressed; 
-  * DDS Topic and QoS naming is addressed; and +  * configuration and generated-type usage are addressed; and 
-  * script and configuration naming is addressed.+  * review expectations are addressed.
  
 ===== Traceability ===== ===== Traceability =====
  
-This requirement establishes the naming discipline used throughout the Phase 0 implementation baseline.+This requirement establishes the coding discipline applied to Phase 0 hand-authored implementation artifacts.
  
 Related requirement identifiers: Related requirement identifiers:
  
-  * [[dido:99_annexes:annex-d-requirements:part-04:p4-req-21-11-005]] +  * [[dido:99_annexes:annex-d-requirements:part-04:p4-req-21-11-004]] 
-  * [[dido:99_annexes:annex-d-requirements:part-04:p4-req-21-11-008]]+  * [[dido:99_annexes:annex-d-requirements:part-04:p4-req-21-11-006]] 
 +  * [[dido:99_annexes:annex-d-requirements:part-04:p4-req-21-11-007]]
  
 Related source section: Related source section:
  • dido/99_annexes/annex-d-requirements/part-04/p4-req-21-11-005.1786137398.txt.gz
  • Last modified: 2026/08/07 14:16
  • by owen