@simplysm/sd-claude 14.0.63 → 14.0.64

package/claude/skills/sd-deliverable/SKILL.md

@@ -1,320 +0,0 @@
----
-name: sd-deliverable
-description: 코드 분석 기반으로 사용자 매뉴얼(md)과 SIT 문서(md)를 생성·업데이트하는 스킬. "매뉴얼 만들어줘", "SIT 문서 만들어줘", "산출물 생성", "매뉴얼 업데이트" 등을 요청할 때 사용한다.
-effort: low
----
-
-# sd-deliverable: 매뉴얼 & SIT 생성
-
-코드베이스를 분석하여 **사용자 매뉴얼**과 **SIT(시스템 통합 테스트) 문서**를 md 파일로 생성한다.
-기존 문서가 있으면 코드 변경 사항을 반영하여 증분 업데이트한다.
-
-## 산출물 구조
-
-```
-{출력 디렉토리}/
-├── 00-목차.md
-├── 01-개요.md
-├── 02-{기능1}.md
-├── 03-{기능2}.md
-├── ...
-└── SIT.md
-```
-
-- 매뉴얼은 기능 단위로 파일을 분리한다. 목차 파일(`00-목차.md`)에서 각 파일로 링크한다.
-- SIT는 단일 파일(`SIT.md`)로 생성한다.
-
-## Step 1: 입력 확인
-
-### 인자 해석
-
-```
-/sd-deliverable {대상 경로} [--ref {참조 문서 경로}] [--out {출력 디렉토리}]
-```
-
-| 인자 | 필수 | 설명 |
-|------|:---:|------|
-| 대상 경로 | O | 분석할 코드 경로 (패키지 또는 모듈 디렉토리) |
-| `--ref` | X | 참조할 스펙/문서 경로 (`.tasks/` 디렉토리 등). 비즈니스 용어와 범위 고정에 사용 |
-| `--out` | X | 출력 디렉토리. 미지정 시 `.docs/{yyMMddHHmmss}_{topic}/` |
-
-- `{yyMMddHHmmss}`: **반드시 Bash 도구로 `date +%y%m%d%H%M%S`를 실행하여 얻는다.**
-- `{topic}`: 대상 경로에서 추출한 모듈명을 영어 kebab-case로 (예: `scheduling`, `inventory`)
-- 대상 경로가 없으면 AskUserQuestion으로 질문한다.
-
-### 기존 문서 탐지
-
-출력 디렉토리에 `00-목차.md` 또는 `SIT.md`가 이미 존재하면 **업데이트 모드**로 진입한다.
-사용자가 `--out`으로 기존 문서가 있는 디렉토리를 지정한 경우도 업데이트 모드이다.
-
-## Step 2: 코드 분석
-
-대상 경로의 코드를 **계층적으로** 분석한다. 이 단계에서 수집한 정보가 매뉴얼과 SIT의 원본 데이터가 된다.
-
-### 분석 순서
-
-#### 1단계: 구조 파악
-
-| 대상 | 목적 |
-|------|------|
-| 라우트/메뉴 정의 | 화면 목록과 계층 구조 파악 |
-| 패키지/모듈 구조 | 기능 그룹 파악 |
-
-- 이 프로젝트: `packages/client-common/src/commons/app-structure-items.ts`에서 메뉴 구조, `packages/client-admin/src/routes.ts`에서 라우트 확인
-
-#### 2단계: 데이터 모델
-
-| 대상 | 목적 |
-|------|------|
-| DB 엔티티 정의 | 필드명, 타입, 관계, 제약조건 파악 |
-| 관계(FK, 1:N, N:M) | 드롭다운 연동, 종속 관계 파악 |
-
-- 이 프로젝트: `packages/db-main/src/models/` 하위의 엔티티 파일
-
-#### 3단계: 비즈니스 로직
-
-| 대상 | 목적 |
-|------|------|
-| 상수/열거형 | 드롭다운 선택지, 상태값, 고정값 |
-| 유틸/검증 함수 | 유효성 검증 규칙, 계산 로직 |
-| 서비스/API | 데이터 흐름, 처리 순서 |
-
-- 이 프로젝트: `packages/common/src/` 하위의 상수·유틸 파일
-
-#### 4단계: UI 상세
-
-| 대상 | 목적 |
-|------|------|
-| 페이지/컴포넌트 | 화면 레이아웃, 입력 필드, 버튼, 그리드 컬럼 |
-| 모달/다이얼로그 | 보조 화면 흐름 |
-| 드롭다운 연동 | 선택에 따른 데이터 필터링 |
-
-분석 대상 파일이 20개 이상이면 Agent 도구로 병렬 분석한다.
-
-### `--ref` 참조 문서 활용
-
-참조 문서가 지정된 경우:
-
-1. 참조 문서를 먼저 읽어 비즈니스 용어 사전과 기능 범위를 파악한다.
-2. 코드 분석 시 참조 문서의 용어를 우선 사용한다.
-3. 코드에는 있지만 참조 문서에 없는 기능은 분석 결과에 포함하되, 참조 문서 범위 외임을 표시한다.
-
-### 분석 결과 출력
-
-코드 분석이 완료되면, 발견한 **기능 목록**을 사용자에게 테이블로 보여준다:
-
-```markdown
-## 분석 결과: {모듈명}
-
-| # | 기능 | 화면/메뉴 | 핵심 동작 |
-|---|------|----------|----------|
-| 1 | BOA 관리 | BOA | 파일 업로드, 변경 감지, 반영 판정 |
-| 2 | RevisePO | RevisePO 작성 | PO 변경요청 (5개 유형) |
-| ...| | | |
-
-이 기능 목록을 기반으로 매뉴얼과 SIT를 생성합니다.
-범위를 조정하려면 말씀해주세요.
-```
-
-사용자가 범위 조정 없이 진행하면 Step 3 또는 Step 4로 넘어간다.
-
-## Step 3: 신규 생성
-
-기존 문서가 없을 때 매뉴얼과 SIT를 새로 생성한다.
-
-### 3-1: 매뉴얼 생성
-
-#### 파일 구조 결정
-
-- 기능 1~3개: `00-목차.md` + 기능별 1개 파일
-- 기능 4개 이상: `00-목차.md` + `01-개요.md` + 기능별 파일
-
-#### 각 기능 파일의 구조
-
-```markdown
-# {기능명}
-
-## 개요
-{기능의 목적과 위치 (메뉴 경로)}
-
-## 화면 구성
-{화면 레이아웃, 필터, 그리드 컬럼 등}
-
-## 주요 기능
-{기능별 상세 설명 — 입력, 동작, 결과}
-
-## 유효성 검증
-{입력 제약, 상태 제약 등 — 코드의 검증 로직에서 도출}
-
-## 상태 흐름
-{상태 전이가 있는 경우 mermaid stateDiagram으로 표현}
-```
-
-이 구조는 가이드라인이다. 기능의 성격에 따라 섹션을 추가하거나 생략한다:
-- 출력/다운로드 기능이 있으면 `## 출력` 섹션 추가
-- 드롭다운 연동이 복잡하면 mermaid flowchart로 연동 관계 표현
-- 분기가 3개 이상이면 mermaid 다이어그램으로 overview 제시 후 상세 설명
-
-#### 작성 원칙
-
-- **코드에서 확인한 사실만 작성한다.** 코드에 없는 기능이나 동작을 추측하지 않는다.
-- **사용자 관점으로 작성한다.** 코드 내부 구현(클래스명, 함수명, 변수명)을 노출하지 않는다. 단, DB 필드명은 데이터 식별을 위해 괄호 안에 표기할 수 있다.
-- **표(table)를 적극 활용한다.** 컬럼 설명, 필터 항목, 선택지 목록 등은 표로 정리한다.
-- **mermaid를 활용한다.** 상태 흐름, 드롭다운 연동, 복잡한 분기 로직에 사용한다. 프로세스 설명에서 반복 혹은 분기가 3건 이상이면 반드시 mermaid 다이어그램을 먼저 제시한다.
-
-### 3-2: SIT 생성
-
-#### SIT.md 구조
-
-```markdown
-# SIT: {모듈명}
-
-> 생성일: {YYYY-MM-DD}
-> 대상: {대상 경로}
-
-## 범례
-
-| 기호 | 의미 |
-|------|------|
-| [x] | Pass |
-| [ ] | 미실행 |
-| [~] | 변경으로 인해 재테스트 필요 |
-| ~~취소선~~ | 삭제된 기능 (기록 보존) |
-
-## 1. {기능명}
-
-| No | 시나리오 | 사전 조건 | 테스트 절차 | 기대 결과 | Pass | 비고 |
-|----|---------|----------|-----------|----------|------|------|
-| 1.1 | {시나리오} | {사전 조건} | {절차} | {기대 결과} | [ ] | |
-| 1.2 | {시나리오} | {사전 조건} | {절차} | {기대 결과} | [ ] | |
-
-## 2. {기능명}
-...
-
-## E2E. 통합 시나리오
-
-| No | 시나리오 | 사전 조건 | 테스트 절차 | 기대 결과 | Pass | 비고 |
-|----|---------|----------|-----------|----------|------|------|
-| E1 | {E2E 시나리오} | {사전 조건} | {절차} | {기대 결과} | [ ] | |
-```
-
-#### 테스트 케이스 번호 규칙
-
-- 기능별: `{기능번호}.{순번}` (예: 1.1, 1.2, 2.1)
-- E2E: `E{순번}` (예: E1, E2)
-- 번호는 증분 업데이트 시에도 기존 번호를 유지한다. 삭제된 번호는 재사용하지 않는다.
-
-#### 테스트 케이스 도출 기준
-
-코드에서 확인된 다음 항목을 테스트 케이스로 변환한다:
-
-| 코드 요소 | 테스트 유형 |
-|-----------|-----------|
-| CRUD 동작 | 생성/조회/수정/삭제 정상 동작 |
-| 상태 전이 (DRAFT→COMPLETED 등) | 전이 성공 + 전이 불가 케이스 |
-| 유효성 검증 함수 | 유효한 입력 + 무효한 입력 |
-| 드롭다운 연동 (FK 관계) | 상위 선택 → 하위 필터링 |
-| 자동 계산 필드 | 입력 → 계산 결과 확인 |
-| 파일 업로드/다운로드 | 정상 파일 + 형식 오류 |
-| 권한 분기 (use/edit) | 권한별 접근 가능/불가 |
-
-#### 작성 원칙
-
-- **Happy path + Negative 균형**: 각 기능에 정상 케이스와 실패/에러 케이스를 모두 포함한다.
-- **사용자 앞에서 실행 가능**: 절차는 UI 조작 단위로 작성한다 (클릭, 입력, 선택 등). 코드 실행이나 DB 직접 조회를 절차에 포함하지 않는다.
-- **기대 결과는 관찰 가능**: 화면에서 확인할 수 있는 결과만 기재한다 (메시지, 상태 변경, 데이터 표시 등).
-- **E2E 시나리오**: 여러 기능을 횡단하는 흐름을 최소 1건 이상 포함한다.
-
-### 3-3: 목차 생성
-
-모든 파일이 생성된 후 `00-목차.md`를 작성한다.
-
-```markdown
-# {모듈명} 매뉴얼
-
-## 목차
-
-| 문서 | 설명 |
-|------|------|
-| [01-개요](01-개요.md) | ... |
-| [02-{기능}](02-{기능}.md) | ... |
-| [SIT](SIT.md) | 시스템 통합 테스트 |
-```
-
-## Step 4: 증분 업데이트
-
-기존 문서가 있을 때, 코드 변경 사항을 반영하여 문서를 업데이트한다.
-
-### 4-1: 기존 문서 읽기
-
-출력 디렉토리의 모든 md 파일을 읽어 현재 문서 상태를 파악한다:
-- 매뉴얼: 각 파일의 기능 범위와 내용
-- SIT: 각 테스트 항목의 Pass/Fail 상태, 비고 내용
-
-### 4-2: 변경 사항 식별
-
-Step 2의 코드 분석 결과와 기존 문서를 비교하여 변경 사항을 분류한다:
-
-| 분류 | 조건 | 매뉴얼 처리 | SIT 처리 |
-|------|------|-----------|---------|
-| **변경 없음** | 코드와 문서가 일치 | 그대로 유지 | Pass/Fail/비고 보존 |
-| **기능 변경** | 코드가 변경됨 (로직, 필드, 검증 등) | 해당 섹션 업데이트 | 해당 항목 `[~]`로 변경 (재테스트 필요) |
-| **기능 추가** | 코드에 있지만 문서에 없음 | 새 섹션/파일 추가 | 새 테스트 항목 추가 `[ ]` |
-| **기능 삭제** | 문서에 있지만 코드에 없음 | 해당 섹션 제거 | 해당 항목 ~~취소선~~ 처리 (기록 보존) |
-
-### 4-3: SIT 업데이트 규칙
-
-- **Pass 보존**: 변경되지 않은 항목의 `[x]`(Pass)와 비고는 절대 변경하지 않는다.
-- **재테스트 표시**: 변경된 기능의 항목은 `[x]` → `[~]`로 변경한다. `[ ]`(미실행)는 그대로 유지한다.
-- **삭제 기록**: 삭제된 기능의 항목은 행 전체를 취소선으로 감싼다. 번호는 재사용하지 않는다.
-- **추가 항목**: 기존 번호 뒤에 새 번호로 추가한다. (예: 1.5 다음에 1.6, 1.7)
-- **비고 보존**: 모든 항목의 비고 컬럼 내용은 항상 보존한다.
-
-### 4-4: 변경 요약 출력
-
-업데이트 완료 후, 변경 내역을 사용자에게 요약한다:
-
-```markdown
-## 업데이트 요약
-
-| 유형 | 건수 | 상세 |
-|------|------|------|
-| 매뉴얼 변경 | N건 | {변경된 섹션 목록} |
-| 매뉴얼 추가 | N건 | {추가된 파일/섹션} |
-| 매뉴얼 삭제 | N건 | {삭제된 파일/섹션} |
-| SIT 재테스트 | N건 | {[~]로 변경된 항목} |
-| SIT 추가 | N건 | {새로 추가된 항목} |
-| SIT 삭제 | N건 | {취소선 처리된 항목} |
-```
-
-## Step 5: 커버리지 검증
-
-매뉴얼과 SIT 간의 기능 커버리지를 검증한다.
-
-### 검증 항목
-
-1. **매뉴얼 → SIT**: 매뉴얼에 기술된 각 기능에 대응하는 SIT 테스트가 1건 이상 존재하는가?
-2. **SIT → 매뉴얼**: SIT에 있는 테스트가 매뉴얼에 기술되지 않은 기능을 참조하지 않는가?
-
-### 누락 발견 시
-
-누락된 항목을 보완하고 재검증한다. 보완 시:
-- 매뉴얼에 기능이 있고 SIT에 테스트가 없으면 → SIT에 테스트 추가
-- SIT에 테스트가 있고 매뉴얼에 기능이 없으면 → 매뉴얼에 해당 기능 설명 추가
-
-검증 결과를 사용자에게 알리지 않는다 — 누락이 없으면 완료 메시지로 직행한다. 보완이 필요했으면 보완한 내용만 간략히 알린다.
-
-## Step 6: 완료
-
-생성/업데이트된 파일 경로 목록을 출력한다.
-
-```markdown
-## 완료
-
-{출력 디렉토리}/
-├── 00-목차.md
-├── 01-개요.md
-├── 02-BOA-관리.md
-├── 03-RevisePO-작성.md
-├── SIT.md
-```