Files

T

EdisonJwa f1bc9a6c85 chore(repo): initial baseline import (docs v0.9.2 + bootstrap)

Imports the v0.9.2 documentation baseline and the bootstrap files
required by docs/governance/repository-bootstrap-plan.md v0.1.0 §3,
minus the justfile (added in the next commit).

This commit establishes the git history for the project. All previous
work lived only as filesystem state with no version control.

2026-05-14 12:25:33 +08:00

2.2 KiB

Raw Blame History

Document Naming Convention

Document type: Configuration / Documentation Control
Version: 0.9.2
Status: Baseline Candidate
Language: English
Product: Chanora
Repo path: docs/governance/document-naming-convention.md

1. Purpose

This document defines the official repository documentation naming convention for Chanora.

2. Repository Path Pattern

Markdown documents under the repository shall use this pattern:

docs/<category>/<lowercase-kebab-case-title>.md

Examples:

docs/requirements/sysrs.md
docs/architecture/sad.md
docs/verification/swe4-unit-verification-plan.md
docs/release/release-readiness-go-nogo-record.md
docs/security/threat-model.md

3. Rules

Rule	Decision
Product prefix	Do not use `CHANORA_` inside repo file names.
Version in filename	Do not include document version in repo file names.
Filename style	Use lowercase kebab-case.
Directory style	Use lowercase kebab-case.
Version metadata	Keep version inside the Markdown document.
Status metadata	Keep status inside the Markdown document.
Release artifacts	ZIP/package names may include project name and version.

4. Top-Level Documentation Categories

Directory	Purpose
`docs/requirements/`	SysRS and SRS
`docs/architecture/`	SysDes, SAD, SDD
`docs/verification/`	SWE.4, SWE.5, SWE.6, SYS.4, verification master plan
`docs/release/`	Release readiness and platform release policy
`docs/security/`	Threat model, secure storage, redaction, dependency/supply-chain, security guidelines
`docs/privacy/`	Privacy policy
`docs/legal/`	Trademark and attribution review
`docs/ui-ux/`	UI/UX, Material 3, design tokens, component catalog, adaptive layout
`docs/i18n/`	Localization architecture
`docs/governance/`	Index, traceability, approval, validation, review, decisions, commit convention
`docs/references/`	External references and research notes

5. Change History

Version	Date	Description
0.9.2	2026-05-14	Replaced release-package naming convention with repository docs naming convention.

2.2 KiB Raw Blame History