docs(ai): prohibit sidebar generation in production screens
This commit is contained in:
1 parent
811f51f0fe
commit
4f0b39c673
2 files changed
+30
-23
No files matched your search
@@ -9,7 +9,7 @@
|
||||
3. **Pattern 검색**: `packages/ui/src/patterns/`, `src/patterns/`, `packages/ui/src/index.ts`와 `docs/patterns/`에서 맞는 Pattern·공개 API를 찾아 구조와 상태 규칙을 따른다.
|
||||
4. **Storybook 확인**: `src/components/`, `src/patterns/`, `src/theme/`의 대표 `All` Story와 관련 문서를 확인한다. `verification` 전용 Story는 일반 화면의 기준으로 쓰지 않는다. Storybook을 실행할 수 없으면 Story 소스와 문서만 확인하고 시각 동작은 추측하지 않는다.
|
||||
5. **Theme 연결**: `themes/default.json`, `packages/ui/src/theme.css`, Runtime 계약과 Token 가이드를 확인해 기존 CSS Custom Properties 구조를 사용한다.
|
||||
6. **화면 구성**: Component와 Pattern을 조합하고 아래 단일 Navigation 정책을 지킨다. 신규 AI Production 업무 화면에는 사용자 요청에 명시된 Navigation만 사용하며, 미지정이면 Sidebar 없이 기존 화면 구조에 콘텐츠를 배치한다. 기존 구성으로 해결되지 않을 때만 새 Component를 검토한다.
|
||||
6. **화면 구성**: Component와 Pattern을 조합하고 아래 단일 Navigation 정책을 지킨다. 신규 AI Production 업무 화면에는 사용자 요청 여부와 관계없이 Sidebar·GNB 내부 Sidebar Composition·좌측 사이드 메뉴 형태의 LNB를 생성·적용하지 않는다. 허용 범위에서 요청에 명시된 Navigation만 사용하며, 미지정이면 Sidebar 없이 기존 화면 구조에 콘텐츠를 배치한다. Sidebar 대신 다른 Navigation을 임의로 추가하지 않는다. 기존 구성으로 해결되지 않을 때만 새 Component를 검토한다.
|
||||
7. **결과 확인 및 보고**: 실제 적용한 Component·Pattern, Theme 연결, Navigation Mode, 실행/화면 확인 결과와 미검증 항목을 보고한다.
|
||||
|
||||
**Storybook / 화면 생성 분리**: Storybook은 기존 Component·Pattern·Theme·Variant·State·Interaction을 확인하는 Reference 환경이다. 일반 업무 화면 생성은 Storybook Story·사이드바에 등록하지 않고, 기존 대표 Story를 생성 화면으로 교체하지 않으며, Storybook 실행을 필수 확인 경로로 요구하지 않는다. 별도의 React 화면과 독립 미리보기를 만들고 화면별 빌드·필요한 검증을 수행한다. H-2(AI 생성 화면의 자동 빌드·캡처·검증, Storybook 배포와 별도이며 구현 완료 여부는 현재 파일로 확인)나 유사 자동화가 사용 가능한 경우에도 `preview.html`·desktop/mobile 이미지 같은 독립 미리보기 산출에만 사용하며 Storybook 등록과 혼동하지 않는다. Storybook 수정은 Component/Pattern 추가·수정, 대표/Verification Story 작성 또는 Storybook Reference 개선을 사용자가 명시한 경우에만 허용한다. Storybook 전용 helper/CSS는 운영 화면에 사용하지 않는다.
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
**Story 구분**: 운영 기준은 대표 `All` Story이고 `verification`·Compatibility·Fixture Story는 운영 예제가 아니다. Storybook 문서 화면은 `StoryPage` 공통 Inner를 사용하며, 이는 Storybook 표현용으로 `@hm-design/ui` 공개 API가 아니다.
|
||||
|
||||
**화면 생성 시 필수 확인**: Navigation을 지정받으면 요청 범위에서 기존 공식 Component·Composition으로 적용하고, 미지정이면 기존 화면 구조를 유지하며 그 근거를 기록한다([선택 기준](docs/guidelines/navigation-single-mode.md#선택-근거)). GNB는 Desktop 메뉴와 `GNBMobileMenu`를 함께 구성하며, 요청된 내부 Sidebar도 모바일 Sheet 하나만 사용한다([GNB 모바일](docs/patterns/gnb.md#8-desktop--mobile)). Dashboard 운영 화면에는 Sidebar를 생성하지 않는다. `DashboardSidebar` 공개 Export와 선택적 `sidebar` slot은 기존 호환성·검증용이며 운영 허용을 뜻하지 않는다. Dashboard 상태는 Theme 다음에 공개 Status CSS를 로드하고 기존 Badge mapping을 소비한다([상태 예제](docs/patterns/dashboard-layout.md#dashboard-업무-상태-공통-계약)). FilterBar의 입력 조건과 조회 적용 조건·초기화 책임을 구분한다([조회 예제](docs/patterns/filter-bar.md#61-조회-버튼으로-적용하는-소비-예제)). `REACT_VITE` 독립 화면은 bootstrap에서 기존 앱 CSS entry(`@/index.css` → `@/hm-theme.css` → 필요 시 공개 상태 CSS)를 로드하며, `@hm-design/ui/tailwind.css`만 단독 import하지 않는다. 빌드 후 `.flex`, `.grid` 등 대표 utility의 생성·실제 적용과 캡처 레이아웃을 확인하고, 빌드 성공만으로 화면 검증을 PASS 처리하지 않는다. React 소비자는 Tailwind 검색 범위와 HM package source를 확인하고([Tailwind](docs/guidelines/runtime-portability.md#21-tailwind-v4-소비자-검색-범위)), 폰트·Asset 경로는 실행 위치별로 확인한다([Asset](docs/guidelines/runtime-portability.md#4-asset과-실행-위치)).
|
||||
**화면 생성 시 필수 확인**: Navigation을 지정받으면 AI 신규 Production 화면의 Sidebar 절대 금지 범위에서 기존 공식 Component·Composition으로 적용하고, 미지정이면 Sidebar 없이 기존 화면 구조를 유지하며 그 근거를 기록한다([선택 기준](docs/guidelines/navigation-single-mode.md#선택-근거)). 요청에 Sidebar·GNB 내부 Sidebar·좌측 사이드 메뉴 형태의 LNB가 포함되면 금지 규칙을 안내하고 해당 기능을 구현하지 않으며, 대체 Navigation을 임의로 추가하지 않는다. GNB는 Desktop 메뉴와 `GNBMobileMenu`를 함께 구성한다([GNB 모바일](docs/patterns/gnb.md#8-desktop--mobile)). Dashboard 운영 화면에는 Sidebar를 생성하지 않는다. `DashboardSidebar` 공개 Export와 선택적 `sidebar` slot은 기존 호환성·검증용이며 운영 허용을 뜻하지 않는다. Dashboard 상태는 Theme 다음에 공개 Status CSS를 로드하고 기존 Badge mapping을 소비한다([상태 예제](docs/patterns/dashboard-layout.md#dashboard-업무-상태-공통-계약)). FilterBar의 입력 조건과 조회 적용 조건·초기화 책임을 구분한다([조회 예제](docs/patterns/filter-bar.md#61-조회-버튼으로-적용하는-소비-예제)). `REACT_VITE` 독립 화면은 bootstrap에서 기존 앱 CSS entry(`@/index.css` → `@/hm-theme.css` → 필요 시 공개 상태 CSS)를 로드하며, `@hm-design/ui/tailwind.css`만 단독 import하지 않는다. 빌드 후 `.flex`, `.grid` 등 대표 utility의 생성·실제 적용과 캡처 레이아웃을 확인하고, 빌드 성공만으로 화면 검증을 PASS 처리하지 않는다. React 소비자는 Tailwind 검색 범위와 HM package source를 확인하고([Tailwind](docs/guidelines/runtime-portability.md#21-tailwind-v4-소비자-검색-범위)), 폰트·Asset 경로는 실행 위치별로 확인한다([Asset](docs/guidelines/runtime-portability.md#4-asset과-실행-위치)).
|
||||
|
||||
## AI Implementation Defaults
|
||||
|
||||
@@ -32,7 +32,7 @@
|
||||
- Storybook은 구현 Reference Catalog다. 대표/PRIMARY Story의 시각 언어와 공통 상태 mapping을 재사용하고 검증 전용 Story를 운영 예제로 삼지 않는다. 신규 업무 화면의 등록 대상이 아니며, 생성 결과는 별도 React 화면·독립 미리보기로 제공한다.
|
||||
- Theme은 구현 시작부터 적용한다. 기존 Semantic Token → 해당 Component Token → 기존 CSS Variable을 먼저 확인하고, 없을 때만 필요한 최소 Semantic 확장을 검토한다. 기존 Token이 있는 색상·spacing·값을 하드코딩하거나 같은 Token을 여러 파일에 중복 정의하지 않는다.
|
||||
- Theme 사용은 별도 승인 없이 기본 적용한다. Theme Source/값 수정은 명시적 필요성과 영향 범위를 확인한다. `themes/*.json` → Runtime Loader → CSS Custom Properties → Semantic → Component Mapping과 Primary / On Accent의 독립 fallback을 유지한다.
|
||||
- 한 페이지에 `GNB | LNB | DASHBOARD` 중 하나만 사용한다. 반응형도 같은 Navigation Mode를 유지한다.
|
||||
- 한 페이지에 `GNB | LNB | DASHBOARD` 중 하나만 사용한다. 신규 AI Production 업무 화면에는 아래 Sidebar 절대 금지를 우선 적용하며 좌측 사이드 메뉴 형태의 LNB를 선택하지 않는다. 반응형도 같은 Navigation Mode를 유지한다.
|
||||
- 화면 구현 순서는 Quick Start를 따른다. 변경 작업 범위(STORYBOOK_ONLY | PRODUCTION_UI | BOTH)는 구현 전에 정한다.
|
||||
- package exports, public props/types, package entry, Story ID, `meta.title`을 불필요하게 변경하지 않는다. 필요한 변경은 소비처·호환성 영향을 먼저 확인한다. Storybook 표현 문제와 Production 동작 문제는 해당 범위에서 해결한다.
|
||||
- Badge/Button/FilterBar를 재사용하더라도 동일한 상태 ID·라벨·필터 매칭이 반복되면 화면별 helper로 남기지 말고 Runtime-neutral 상태 계약을 먼저 검토한다. 계약은 React 구현과 분리하고 `data-status`, 독립 flag attribute, `aria-pressed` 등 다른 Runtime이 재현할 수 있는 상태 vocabulary를 정의한다.
|
||||
@@ -59,13 +59,13 @@
|
||||
|
||||
**ONE PAGE = ONE NAVIGATION MODE = ONE HEADER/NAVIGATION EXPERIENCE**
|
||||
|
||||
- 페이지 구현 전에 `navigationMode = GNB | LNB | DASHBOARD` 중 정확히 하나를 선택한다.
|
||||
- 허용: GNB ONLY, LNB ONLY, DASHBOARD ONLY.
|
||||
- GNB ONLY 내부 Sidebar는 기존 LNB 부품을 재사용하는 허용 Composition이며 독립 LNB Mode가 아니다. 브랜드·사용자와 모바일 Header/Sheet는 GNB 하나가 담당한다([상세 범위](docs/guidelines/navigation-single-mode.md#gnb-only-내부-sidebar)).
|
||||
- 페이지 구현 전에 `navigationMode = GNB | LNB | DASHBOARD` 중 정확히 하나를 선택한다. 신규 AI Production 업무 화면에는 아래 Sidebar 절대 금지를 우선 적용하며 좌측 사이드 메뉴 형태의 LNB를 선택하지 않는다.
|
||||
- 기존 Navigation 계약의 허용 모드: GNB ONLY, LNB ONLY, DASHBOARD ONLY. 신규 AI Production 업무 화면의 GNB ONLY는 Sidebar 없는 구성으로 사용하며 DASHBOARD ONLY의 기존 계약을 유지한다.
|
||||
- 기존 GNB ONLY 내부 Sidebar는 LNB 부품을 재사용하는 Composition이며 독립 LNB Mode가 아니다. 이 계약은 기존 Component·Pattern·Storybook 보존용이며 신규 AI Production 업무 화면에서는 사용을 금지한다. 기존 구성의 브랜드·사용자와 모바일 Header/Sheet는 GNB 하나가 담당한다([상세 범위](docs/guidelines/navigation-single-mode.md#gnb-only-내부-sidebar)).
|
||||
- 금지: GNB + LNB, GNB + Dashboard, LNB + Dashboard, GNB + LNB + Dashboard.
|
||||
- 이 정책은 AI 기반 코드 생성·제안, 신규 페이지 구현, 기존 화면 수정, 프로토타입, Storybook, 실제 Production 구현 전체에 동일하게 적용한다.
|
||||
- AI는 별도 요청이 없는 한 Navigation 조합을 생성하거나 제안하지 않는다. 별도 요청이 있더라도 기존 단일 모드 정책과 충돌함을 알리고 정책 변경인지 기술 검증인지 구분한다.
|
||||
- 신규 AI Production 업무 화면에 요청하지 않은 왼쪽 Sidebar나 기존 GNB 외의 Navigation 영역·Drawer·Hamburger Menu를 임의로 추가하거나 메뉴를 추측하지 않는다. Sidebar 전용 React Component·CSS·Width 규칙을 새로 만들거나 Storybook Navigation Reference를 그대로 복사해 자동 적용하지 않는다. 명시적으로 요청한 Navigation은 기존 공식 GNB/LNB Component·Composition과 Production Layout 계약을 따르며, 기존 Sidebar API·Variant는 유지한다. 상세 기준은 [AI Sidebar 생성 정책](docs/guidelines/navigation-single-mode.md#ai-sidebar-생성-정책)을 따른다.
|
||||
- 신규 AI Production 업무 화면에서는 사용자 요청 여부와 관계없이 Sidebar 생성·사용을 절대 금지한다. 기존 GNB Sidebar Composition과 좌측 사이드 메뉴 형태의 LNB도 생성·적용하지 않는다. 임의 Drawer·Collapsible Sidebar 및 Sidebar 전용 Component·CSS·Width 규칙을 생성하지 않는다. 요청에 Sidebar가 포함되면 금지 규칙을 안내하고 해당 기능을 구현하지 않으며, Sidebar 대신 다른 Navigation을 임의로 추가하거나 메뉴를 추측하지 않는다. 이 정책은 AI의 신규 Production 업무 화면 생성에만 적용하고, 기존 HMDesign Component·Pattern·Storybook의 Sidebar/LNB 기능과 API·Variant는 삭제하거나 변경하지 않는다. 상세 기준은 [AI Sidebar 생성 정책](docs/guidelines/navigation-single-mode.md#ai-sidebar-생성-정책)을 따른다.
|
||||
- 반응형에서도 선택한 체계를 유지한다. LNB Desktop(≥1024px) → LNB Mobile Header(≤1023px)는 같은 LNB Mode이며 GNB로 전환하지 않는다.
|
||||
- Dashboard 운영 화면은 전용 Header/Menu와 Content만 사용하며 Sidebar는 금지한다. 외부 GNB나 일반 LNB를 slot에 넣지 않는다. 기존 `DashboardSidebar`와 `sidebar` slot은 호환성·검증용으로 유지하며 신규 운영 화면에 사용하지 않는다.
|
||||
- Dashboard Header는 GNB가 아니다. Dashboard 화면은 Dashboard Pattern과 대표 Story를 따르고, Header의 역할을 GNB로 대체하지 않는다.
|
||||
|
||||
Reference in new issue
Block a user