Skip to content

Commit 257fee1

Browse files
Add nomenclature quick reference guide
Co-authored-by: AmedeoPelliccia <164860269+AmedeoPelliccia@users.noreply.github.com>
1 parent e37603b commit 257fee1

File tree

1 file changed

+129
-0
lines changed

1 file changed

+129
-0
lines changed
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Nomenclature Standard Quick Reference
2+
3+
## Pattern
4+
5+
```
6+
[ROOT]_[BUCKET]_[TYPE]_[VARIANT]_[DESCRIPTION]_[VERSION].[EXT]
7+
```
8+
9+
## Field Rules
10+
11+
| Field | Format | Examples |
12+
|-------|--------|----------|
13+
| ROOT | 2 digits | `00`, `24`, `72` |
14+
| BUCKET | 2 digits | `00`, `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `90` |
15+
| TYPE | 2-8 uppercase | `PLAN`, `FHA`, `REQ`, `STD`, `IDX` |
16+
| VARIANT | Uppercase + hyphens | `Q100BL`, `DRAFT`, `SYS`, `LC02-Q100BL` |
17+
| DESCRIPTION | lowercase-kebab-case | `safety-program`, `propulsion`, `hazard-log` |
18+
| VERSION | v + 2 digits | `v01`, `v02`, `v10` |
19+
| EXT | lowercase | `md`, `json`, `xlsx`, `pdf` |
20+
21+
## Special Rules
22+
23+
### ⚠️ CRITICAL: BUCKET=00 requires LC prefix
24+
25+
If `BUCKET=00`, then `VARIANT` **MUST** start with `LC01` through `LC14`
26+
27+
`00_00_PLAN_LC02-Q100BL_safety-program_v01.md`
28+
`00_00_PLAN_Q100BL_safety-program_v01.md`
29+
30+
### Delimiters
31+
32+
- Use `_` **only** between fields
33+
- Use `-` **only** inside VARIANT and DESCRIPTION
34+
35+
## BUCKET Values
36+
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 |
49+
50+
## Approved TYPE Codes
51+
52+
### Planning / Control
53+
`PLAN`, `MIN`, `RPT`, `LOG`, `ACT`, `IDX`
54+
55+
### Safety Analyses
56+
`FHA`, `PSSA`, `SSA`, `FTA`, `ANA`
57+
58+
### Requirements / Allocation
59+
`REQ`, `DAL`, `TRC`
60+
61+
### Data / Reference
62+
`CAT`, `LST`, `GLO`, `MAT`, `SCH`, `DIA`, `TAB`, `STD`
63+
64+
## Validation
65+
66+
```bash
67+
# Single file
68+
python validate_nomenclature.py <filename>
69+
70+
# All files
71+
python validate_nomenclature.py --check-all
72+
```
73+
74+
## Examples
75+
76+
### ✅ Valid
77+
78+
```
79+
00_00_PLAN_LC02-Q100BL_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_Q100BL_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
85+
```
86+
87+
### ❌ Invalid
88+
89+
```
90+
00_00_PLAN_Q100BL_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
96+
```
97+
98+
## Common Mistakes
99+
100+
1. **Missing LC prefix for BUCKET=00**
101+
- Fix: Add `LC01` through `LC14` to start of VARIANT
102+
- Example: `Q100BL``LC02-Q100BL`
103+
104+
2. **Wrong delimiters**
105+
- Fix: Use `_` between fields, `-` inside fields only
106+
- Example: `00-70-FHA``00_70_FHA`
107+
108+
3. **Wrong version format**
109+
- Fix: Always use 2 digits after `v`
110+
- Example: `v1``v01`
111+
112+
4. **Uppercase in DESCRIPTION**
113+
- Fix: Use lowercase-kebab-case only
114+
- Example: `SafetyProgram``safety-program`
115+
116+
5. **Lowercase TYPE**
117+
- Fix: Use uppercase only
118+
- Example: `fha``FHA`
119+
120+
## Reference Documents
121+
122+
- **Full Standard**: `00_00_STD_LC01-Q100BL_nomenclature-standard_v01.md`
123+
- **Automation Guide**: `00_00_IDX_LC01-Q100BL_nomenclature-automation-guide_v01.md`
124+
- **Agent Instructions**: `.github/NOMENCLATURE_AGENT_INSTRUCTIONS.md`
125+
126+
---
127+
128+
**Last Updated**: 2025-12-14
129+
**Version**: 1.0

0 commit comments

Comments
 (0)