34 lines
1.0 KiB
Markdown
34 lines
1.0 KiB
Markdown
# Chanora Document Naming Convention
|
|
|
|
**Document status:** DV meeting baseline candidate
|
|
**Date:** 2026-05-29
|
|
|
|
## 1. Rule
|
|
|
|
Repository documentation uses lowercase kebab-case file names under topic directories.
|
|
|
|
Examples:
|
|
|
|
| Document type | Path pattern |
|
|
|---|---|
|
|
| Requirements | `docs/requirements/<name>.md` or canonical root file during migration |
|
|
| Architecture | `docs/architecture/<artifact>.md` |
|
|
| Verification | `docs/verification/<lifecycle>-verification-plan.md` |
|
|
| Release | `docs/release/<record-name>.md` |
|
|
| Governance | `docs/governance/<record-name>.md` |
|
|
|
|
## 2. Identifier Rules
|
|
|
|
| Identifier | Meaning |
|
|
|---|---|
|
|
| `SysRS-XXX` | System requirement |
|
|
| `SysDes-XXX` | System design item |
|
|
| `SRS-XXX` | Software requirement |
|
|
| `SAD` | Software Architecture Description / SWE.2 |
|
|
| `SDD` | Software Detailed Design / SWE.3 |
|
|
| `DV-WVR-XXX` | DV waiver |
|
|
|
|
## 3. Migration Rule
|
|
|
|
When canonical files move, path records must be replaced by the canonical content or by redirects that clearly identify the authoritative source.
|