platform-admin/boc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Glossary + Sanity Review + Normative Words

Browse Source 
- GLOSSARY.md (v1.0, LOCKED):
  - Normative words: MUST, MUST NOT, SHOULD, SHOULD NOT, MAY (RFC 2119)
  - Core concepts: Component, Variant, State, Token, Primitive/Semantic/Component
  - Layout: Page, View, Screen, Panel, Module, Overlay, Drawer, Modal, Dialog, Sheet
  - Visual: Layer, Elevation, Surface, Backdrop
  - Interaction: Focus, Hover, Active, Disabled, Loading
  - Tokens: Brand, Semantic, Status, Neutral
  - Governance: Constitution, Doctrine, Specification, DDR

- Sanity Review completed:
  1. Terminology: Component (not Widget/Control), Token (not Variable),
     Panel (consistent usage)
  2. Normative words: Normalized MUST/MUST NOT/SHOULD/MAY across all docs
  3. Naming: surface-primary, text-secondary, border-default (consistent)
  4. Document hierarchy: correct upward references
  5. Acceptance Criteria: consistent template (Button as reference)

- TOKEN_PHILOSOPHY.md: Replaced informal rules with RFC 2119 normative words
- DESIGN_SPECIFICATION.md: Replaced Rule: with MUST/MUST NOT
- ANTI_PATTERNS.md: Replaced Rule:/Forbidden: with MUST/MUST NOT

Rationale: Reproducible sanity checklist. Common language prevents
misunderstandings. Normative words make requirements unambiguous.
This commit is contained in:
Bernt
2026-07-02 09:02:41 +00:00
parent 500d9c052b
commit 2e62e5fb80
4 changed files with 154 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/design/DESIGN_ANTI_PATTERNS.md
+6 -6
View File
@@ -20,7 +20,7 @@ This document lists patterns that are **explicitly forbidden** in the Landvex de
- Accelerate design reviews ("see Anti-Pattern #7")
- Maintain consistency as the team grows
**Rule:** If a pattern is listed here, it may not be used. No exceptions without Architecture Review.
**MUST NOT:** Use any pattern listed here. Exceptions require Architecture Review.
---
@@ -32,7 +32,7 @@ This document lists patterns that are **explicitly forbidden** in the Landvex de
**Why:** Duplication, inconsistency, bloat.
**Rule:** AI must search the component library (Tier 1–3) and verify no existing component can be extended before proposing anything new.
**MUST:** AI search the component library (Tier 1–3) and verify no existing component can be extended before proposing anything new.
### AP-018: AI-Hardcoded Values
@@ -40,7 +40,7 @@ This document lists patterns that are **explicitly forbidden** in the Landvex de
**Why:** Violates Token Philosophy, creates technical debt.
**Rule:** AI must always reference existing tokens or propose new ones through the Design Review Gate.
**MUST:** AI always reference existing tokens or propose new ones through the Design Review Gate.
### AP-019: AI-Skipping Token Lifecycle
@@ -48,7 +48,7 @@ This document lists patterns that are **explicitly forbidden** in the Landvex de
**Why:** Bypasses governance, risks breaking changes.
**Rule:** All new tokens start as Draft. Promotion requires review.
**MUST:** All new tokens start as Draft. Promotion requires review.
### AP-020: AI-Multiple Icon Libraries
@@ -56,7 +56,7 @@ This document lists patterns that are **explicitly forbidden** in the Landvex de
**Why:** Inconsistent stroke weight, style, and metaphor.
**Rule:** One icon library. Period.
**MUST:** Use exactly one icon library.
### AP-021: AI-Breaking Document Hierarchy
@@ -64,7 +64,7 @@ This document lists patterns that are **explicitly forbidden** in the Landvex de
**Why:** Destroys governance structure.
**Rule:** AI must verify hierarchy compliance before any proposal.
**MUST:** AI verify hierarchy compliance before any proposal.
---