11# Nomenclature Standard Quick Reference
22
3- ## Pattern
3+ ## Pattern (v2.0 - 8 Fields)
44
55```
6- [ROOT]_[BUCKET]_[TYPE]_[VARIANT]_[DESCRIPTION]_[VERSION].[EXT]
6+ [ROOT]_[BUCKET]_[TYPE]_[LC_OR_SUBBUCKET]_[ VARIANT]_[DESCRIPTION]_[VERSION].[EXT]
77```
88
99## Field Rules
1313| ROOT | 2-3 digits | ` 00 ` , ` 24 ` , ` 72 ` , ` 115 ` , ` 116 ` |
1414| BUCKET | 2 digits | ` 00 ` , ` 10 ` , ` 20 ` , ` 30 ` , ` 40 ` , ` 50 ` , ` 60 ` , ` 70 ` , ` 80 ` , ` 90 ` |
1515| TYPE | 2-8 uppercase | ` PLAN ` , ` FHA ` , ` REQ ` , ` STD ` , ` IDX ` |
16- | VARIANT | Uppercase + hyphens | ` SPACET ` , ` DRAFT ` , ` SYS ` , ` LC02-SPACET ` |
16+ | LC_OR_SUBBUCKET | LC01-LC14 or SB15-SB99 | ` LC01 ` , ` LC14 ` , ` SB15 ` , ` SB99 ` |
17+ | VARIANT | Uppercase + hyphens | ` SPACET ` , ` DRAFT ` , ` SYS ` , ` HW-01 ` |
1718| DESCRIPTION | lowercase-kebab-case | ` safety-program ` , ` propulsion ` , ` hazard-log ` |
1819| VERSION | v + 2 digits | ` v01 ` , ` v02 ` , ` v10 ` |
1920| EXT | lowercase | ` md ` , ` json ` , ` xlsx ` , ` pdf ` |
2021
2122## Special Rules
2223
23- ### ⚠️ CRITICAL: BUCKET=00 requires LC prefix
24+ ### ⚠️ CRITICAL: Subject Category Rules
2425
25- If ` BUCKET=00 ` , then ` VARIANT ` ** MUST** start with ` LC01 ` through ` LC14 `
26+ ** If ` BUCKET=00 ` ** → Use ** LC** (Lifecycle) category:
27+ - ` LC_OR_SUBBUCKET ` ** MUST** be ` LC01 ` through ` LC14 `
28+ - Example: ✅ ` 00_00_PLAN_LC02_SPACET_safety-program_v01.md `
29+ - Invalid: ❌ ` 00_00_PLAN_SB15_SPACET_safety-program_v01.md `
2630
27- ✅ ` 00_00_PLAN_LC02-SPACET_safety-program_v01.md `
28- ❌ ` 00_00_PLAN_SPACET_safety-program_v01.md `
31+ ** If ` BUCKET≠00 ` ** → Use ** SB** (Sub-bucket) category:
32+ - ` LC_OR_SUBBUCKET ` ** MUST** be ` SB15 ` through ` SB99 `
33+ - Example: ✅ ` 00_70_FHA_SB15_SYS_propulsion_v01.md `
34+ - Invalid: ❌ ` 00_70_FHA_SB00_SYS_propulsion_v01.md `
35+ - Invalid: ❌ ` 00_70_FHA_LC01_SYS_propulsion_v01.md `
2936
3037### Delimiters
3138
@@ -34,18 +41,18 @@ If `BUCKET=00`, then `VARIANT` **MUST** start with `LC01` through `LC14`
3441
3542## BUCKET Values
3643
37- | Code | Domain |
38- | ------| --------|
39- | ` 00 ` | Lifecycle (requires LC prefix in VARIANT) |
40- | ` 10 ` | Operations |
41- | ` 20 ` | Primary Subsystem |
42- | ` 30 ` | Circularity |
43- | ` 40 ` | Software |
44- | ` 50 ` | Structures |
45- | ` 60 ` | Storages |
46- | ` 70 ` | Propulsion |
47- | ` 80 ` | Energy |
48- | ` 90 ` | Tables/Schemas/Diagrams/Reference |
44+ | Code | Domain | Allowed Subbuckets |
45+ | ------| --------| ------------------- |
46+ | ` 00 ` | Lifecycle | LC01-LC14 |
47+ | ` 10 ` | Operations | SB15-SB19, SB80-SB85 |
48+ | ` 20 ` | Primary Subsystem | SB20-SB29 |
49+ | ` 30 ` | Circularity | SB30-SB39 |
50+ | ` 40 ` | Software | SB40-SB49 |
51+ | ` 50 ` | Structures | SB50-SB59 |
52+ | ` 60 ` | Storages | SB60-SB69 |
53+ | ` 70 ` | Propulsion | SB70-SB79 |
54+ | ` 80 ` | Energy | SB86-SB89 |
55+ | ` 90 ` | Tables/Schemas/Diagrams/Reference | SB90-SB99 |
4956
5057## Approved TYPE Codes
5158
@@ -76,40 +83,55 @@ python validate_nomenclature.py --check-all
7683### ✅ Valid
7784
7885```
79- 00_00_PLAN_LC02-SPACET_safety-program_v01.md
80- 00_70_FHA_SYS_propulsion_v01.md
81- 00_40_REQ_SW_software-safety-reqs_v01.md
82- 00_20_TRC_SPACET_traceability-matrix_v01.xlsx
83- 00_90_SCH_GEN_hazard-log-schema_v01.json
84- 24_40_REQ_SW-01_electrical-power-software_v01.md
86+ 00_00_PLAN_LC02_SPACET_safety-program_v01.md
87+ 00_70_FHA_SB70_SYS_propulsion_v01.md
88+ 00_40_REQ_SB40_SW_software-safety-reqs_v01.md
89+ 00_20_TRC_SB20_SPACET_traceability-matrix_v01.xlsx
90+ 00_90_SCH_SB90_GEN_hazard-log-schema_v01.json
91+ 24_40_REQ_SB40_SW_electrical-power-software_v01.md
92+ 00_10_PLAN_SB15_GEN_operations-plan_v01.md
93+ 00_80_FHA_SB86_SYS_energy-system_v01.md
8594```
8695
8796### ❌ Invalid
8897
8998```
90- 00_00_PLAN_SPACET_safety-program_v01.md # Missing LC prefix
91- 00-70-FHA-SYS-propulsion-v01.md # Wrong delimiter
92- 00_70_FHA_SYS_propulsion_v1.md # VERSION must be vNN
93- 00_99_LST_GEN_glossary_v01.md # Invalid BUCKET
94- 00_70_FHA_SYS_PropulsionFHA_v01.md # Uppercase in DESCRIPTION
95- 00_70_fha_SYS_propulsion_v01.md # Lowercase TYPE
99+ 00_00_PLAN_SB15_SPACET_safety-program_v01.md # BUCKET=00 requires LC, not SB
100+ 00_70_FHA_SB00_SYS_propulsion_v01.md # SB00 not allowed (reserved)
101+ 00_70_FHA_SB40_SYS_propulsion_v01.md # BUCKET=70 requires SB70-SB79
102+ 00_70_FHA_LC01_SYS_propulsion_v01.md # BUCKET≠00 requires SB, not LC
103+ 00_40_REQ_SB70_SW_software_v01.md # BUCKET=40 requires SB40-SB49
104+ 00-70-FHA-SB70-SYS-propulsion-v01.md # Wrong delimiter
105+ 00_70_FHA_SB70_SYS_propulsion_v1.md # VERSION must be vNN
106+ 00_99_LST_SB90_GEN_glossary_v01.md # Invalid BUCKET
107+ 00_70_FHA_SB70_SYS_PropulsionFHA_v01.md # Uppercase in DESCRIPTION
108+ 00_70_fha_SB70_SYS_propulsion_v01.md # Lowercase TYPE
96109```
97110
98111## Common Mistakes
99112
100- 1 . ** Missing LC prefix for BUCKET=00**
101- - Fix: Add ` LC01 ` through ` LC14 ` to start of VARIANT
102- - Example: ` SPACET ` → ` LC02-SPACET `
113+ 1 . ** Wrong subject category for BUCKET=00** : Must use LC01-LC14, not SB
114+ - Fix: Use LC_OR_SUBBUCKET field with LC01-LC14
115+ - Example: ` 00_00_PLAN_SB15_SPACET_... ` → ` 00_00_PLAN_LC02_SPACET_... `
103116
104- 2 . ** Wrong delimiters**
117+ 2 . ** Using wrong subbucket range for bucket** : Each bucket has specific ranges
118+ - Fix: Use the correct subbucket range for your bucket
119+ - Example: ` 00_70_FHA_SB40_SYS_... ` → ` 00_70_FHA_SB70_SYS_... `
120+ - Example: ` 00_40_REQ_SB20_SW_... ` → ` 00_40_REQ_SB40_SW_... `
121+
122+ 3 . ** Using SB00-SB14** : These are reserved and not allowed
123+ - Fix: Use bucket-specific ranges starting from SB15
124+ - Example: ` 00_70_FHA_SB00_SYS_... ` → ` 00_70_FHA_SB70_SYS_... `
125+
126+ 4 . ** Wrong delimiters**
105127 - Fix: Use ` _ ` between fields, ` - ` inside fields only
106128 - Example: ` 00-70-FHA ` → ` 00_70_FHA `
107129
108- 3 . ** Wrong version format**
130+ 5 . ** Wrong version format**
109131 - Fix: Always use 2 digits after ` v `
110132 - Example: ` v1 ` → ` v01 `
111133
112- 4 . ** Uppercase in DESCRIPTION**
134+ 6 . ** Uppercase in DESCRIPTION**
113135 - Fix: Use lowercase-kebab-case only
114136 - Example: ` SafetyProgram ` → ` safety-program `
115137
0 commit comments