From edf4ff3890c4caf20404371cdc272d32f46f371b Mon Sep 17 00:00:00 2001 From: Jung Do Hyun Date: Sat, 18 Apr 2026 11:04:30 +0900 Subject: [PATCH 1/2] docs: add per-plugin README (development, security, workflow, documentation) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 각 플러그인 카테고리 루트에 README 추가: - 플러그인 목적 및 특징 설명 - 수록 스킬 테이블 + 트리거 예시 - 대표 사용 시나리오 - 설치 명령어 Co-Authored-By: Claude Opus 4.7 (1M context) --- plugins/development/README.md | 42 ++++++++++++++++++++++++++ plugins/documentation/README.md | 42 ++++++++++++++++++++++++++ plugins/security/README.md | 52 +++++++++++++++++++++++++++++++++ plugins/workflow/README.md | 46 +++++++++++++++++++++++++++++ 4 files changed, 182 insertions(+) create mode 100644 plugins/development/README.md create mode 100644 plugins/documentation/README.md create mode 100644 plugins/security/README.md create mode 100644 plugins/workflow/README.md diff --git a/plugins/development/README.md b/plugins/development/README.md new file mode 100644 index 0000000..cf4ce19 --- /dev/null +++ b/plugins/development/README.md @@ -0,0 +1,42 @@ +# Development 플러그인 (Development) + +코드 작성부터 리뷰, 테스트, 시각화까지 개발 전 단계를 지원하는 스킬 모음입니다. 품질 게이트와 설계 일관성을 Claude에게 위임하여 PR 이전에 체크리스트를 자동화할 수 있습니다. + +## 특징 + +- **TDD·품질 중심** — `code-review`와 `test-generator`가 PR 전 품질 게이트를 제공합니다. +- **API 설계 일관성** — `api-design`이 RESTful·GraphQL의 업계 모범 사례를 일관되게 적용합니다. +- **시각적 커뮤니케이션** — `draw-diagram`이 Draw.io(.drawio) 형식의 아키텍처·플로우차트·ERD를 직접 생성합니다(AWS 아이콘 지원). +- **워크플로 전 단계 커버** — 4개 스킬이 설계 → 구현 → 리뷰 → 테스트 → 문서화의 흐름을 빈틈없이 연결합니다. + +## 수록 스킬 + +| 스킬 | 용도 | 트리거 예시 | +|------|------|-------------| +| [code-review](skills/code-review) | 보안·성능·유지보수성 관점의 구조화된 코드 리뷰 | "이 PR 리뷰해줘", "이 코드 피드백 부탁해" | +| [api-design](skills/api-design) | RESTful API·GraphQL 스키마 설계 및 리소스·엔드포인트 정의 | "사용자 CRUD API 설계해줘", "GraphQL 스키마 잡아줘" | +| [test-generator](skills/test-generator) | 단위·통합·E2E 테스트 스위트 생성 및 커버리지 개선 | "이 함수 단위 테스트 작성해줘", "엣지 케이스 테스트 추가해줘" | +| [draw-diagram](skills/draw-diagram) | Draw.io 아키텍처·시퀀스·플로우차트·ERD 생성 (AWS 아이콘 포함) | "시스템 아키텍처 다이어그램 그려줘", "이 흐름 플로우차트로" | + +## 사용 예시 + +### 예시 1 — 새 REST API 엔드포인트 설계 +새 기능의 리소스·쿼리 파라미터·응답 스키마를 정의해야 할 때 `api-design`에 요청하면 자원 지향 설계 원칙과 상태 코드 관례를 반영한 엔드포인트를 제안합니다. 이어서 `code-review`가 구현된 핸들러의 입력 검증·에러 처리 누락을 잡아냅니다. + +### 예시 2 — PR 열기 전 품질 점검 +`code-review`로 변경셋 전체를 훑어 보안·성능 이슈를 선별하고, `test-generator`로 빠진 엣지 케이스 테스트를 생성한 뒤 PR을 올리는 방식으로 리뷰 사이클을 단축합니다. + +### 예시 3 — 아키텍처 설명 문서화 +설계 회의 결과나 기존 시스템 구조를 공유해야 할 때 `draw-diagram`으로 Draw.io 파일을 생성하면 팀원들이 바로 편집·확장할 수 있는 포맷으로 남습니다. + +## 설치 + +```bash +/plugin marketplace add roboco-io/plugins +/plugin install development@roboco-plugins +``` + +## 관련 문서 + +- 루트 README: [../../README.md](../../README.md) +- 플러그인 제작 가이드: [../../docs/plugin-development-guide.md](../../docs/plugin-development-guide.md) diff --git a/plugins/documentation/README.md b/plugins/documentation/README.md new file mode 100644 index 0000000..56ab0ca --- /dev/null +++ b/plugins/documentation/README.md @@ -0,0 +1,42 @@ +# Documentation 플러그인 (Documentation) + +한국어 기술 문서 작성과 Q&A 기반 지식 축적을 결합한 문서화 워크플로를 제공합니다. 대화 중 오간 질문과 답변을 문서 자산으로 전환하고, 궁극적으로 팀 지식베이스로 통합합니다. + +## 특징 + +- **한국어 기술 문서 전문** — `korean-docs`가 영어권 도구들이 놓치기 쉬운 띄어쓰기·조사 처리·전문용어 번역 기준을 반영합니다. +- **Q&A 기반 지식 축적** — `qa`, `qa-list`, `qa-merge`의 3-스킬 파이프라인으로 개별 질문·답변을 문서화·검색·병합 가능한 지식 자산으로 발전시킵니다. +- **구조화된 Q&A 관리** — 개별 Q&A 카드 → 리스트 뷰 → 병합된 통합 레퍼런스까지 단계적으로 진화시키는 파이프라인을 제공합니다. +- **국내 개발팀 지향** — 한국어 문서화와 Q&A 워크플로가 결합되어 한국어 기반 팀의 문서 자산화에 최적입니다. + +## 수록 스킬 + +| 스킬 | 용도 | 트리거 예시 | +|------|------|-------------| +| [korean-docs](skills/korean-docs) | 전문적인 한국어 기술 문서·README·API 문서·가이드 작성 | "이 README를 한국어로 다듬어줘", "한국어 기술 문서 작성해줘" | +| [qa](skills/qa) | 기술·수학·도메인 개념 Q&A를 구조화된 문서로 기록 | "이 개념 Q&A로 저장해줘", "/qa 트랜잭션 격리 수준" | +| [qa-list](skills/qa-list) | 저장된 Q&A 문서 목록 표시 (카테고리 필터 가능) | "저장된 Q&A 보여줘", "/qa-list" | +| [qa-merge](skills/qa-merge) | 개별 Q&A 문서들을 하나의 통합 레퍼런스 문서로 병합 | "Q&A 병합해서 레퍼런스 만들어줘", "/qa-merge" | + +## 사용 예시 + +### 예시 1 — 영문 기술 문서의 한국어 번역 +오픈소스 프로젝트 README나 API 문서를 한국어로 옮길 때 `korean-docs`를 호출하면 프로그래밍 언어·프레임워크 이름은 영문으로 유지하고, 일반 용어는 관례에 맞춰 번역하며, 띄어쓰기·조사 처리를 일관되게 적용합니다. + +### 예시 2 — 회의 중 나온 개념을 Q&A 카드로 저장 +"CAP 정리가 뭔지 설명해줘" 같은 질문에 답한 뒤 `/qa`로 호출하면 질문·핵심 답변·참고 자료·카테고리가 구조화된 문서 카드로 저장됩니다. 이후 `/qa-list`로 축적된 카드 목록을 훑을 수 있습니다. + +### 예시 3 — 쌓인 Q&A를 통합 레퍼런스로 병합 +분기별 혹은 토픽별로 `/qa-merge`를 실행하면 여러 개의 Q&A 카드가 하나의 통합 문서로 합쳐져 팀 위키나 온보딩 자료로 바로 사용 가능합니다. + +## 설치 + +```bash +/plugin marketplace add roboco-io/plugins +/plugin install documentation@roboco-plugins +``` + +## 관련 문서 + +- 루트 README: [../../README.md](../../README.md) +- 플러그인 제작 가이드: [../../docs/plugin-development-guide.md](../../docs/plugin-development-guide.md) diff --git a/plugins/security/README.md b/plugins/security/README.md new file mode 100644 index 0000000..89afed5 --- /dev/null +++ b/plugins/security/README.md @@ -0,0 +1,52 @@ +# Security 플러그인 (Security) + +애플리케이션 코드의 보안 취약점 검토(OWASP Top 10 2025)와 클라우드 인프라의 Well-Architected 리뷰를 한 플러그인에서 제공합니다. 오케스트레이터 + 6개 Pillar 전용 스킬의 계층 구조로 Progressive Disclosure를 실현합니다. + +## 특징 + +- **OWASP Top 10 2025 커버리지** — `owasp-review`가 2025년 공식 판을 반영하여 JavaScript/TypeScript·Python·Java·Go 코드를 점검합니다. +- **AWS Well-Architected 6 Pillar 전담 스킬** — `aws-well-architected` 오케스트레이터가 Operational Excellence / Security / Reliability / Performance / Cost / Sustainability 각각의 전용 하위 스킬을 호출하여 통합 리포트를 생성합니다. +- **IaC 정적 분석** — Terraform·CloudFormation·CDK·Pulumi 파일을 직접 스캔하여 구성 오류와 미스컨피그를 찾아냅니다. +- **Compliance 매핑 내장** — PCI-DSS·HIPAA·SOC2·GDPR·ISO 27001 매핑이 권장사항에 연동되어 audit 대응에 활용 가능합니다. +- **오케스트레이터 패턴** — 필요한 Pillar만 개별 호출하거나 오케스트레이터로 전체를 묶어 실행할 수 있습니다. + +## 수록 스킬 + +| 스킬 | 용도 | 트리거 예시 | +|------|------|-------------| +| [owasp-review](skills/owasp-review) | OWASP Top 10 2025 기반 보안 취약점 리뷰 (JS/TS, Python, Java, Go) | "이 코드 보안 리뷰해줘", "취약점 분석해줘" | +| [aws-well-architected](skills/aws-well-architected) | 6개 Pillar 하위 스킬을 호출하는 Well-Architected 리뷰 오케스트레이터 | "인프라 코드 Well-Architected 리뷰해줘", "IaC 점검해줘" | +| [aws-wa-operational-excellence](skills/aws-wa-operational-excellence) | 운영 효율성 Pillar — 모니터링·로깅·배포 자동화 점검 | "운영 효율성 Pillar만 보고 싶어" | +| [aws-wa-security](skills/aws-wa-security) | 보안 Pillar — IAM·암호화·네트워크 보안·탐지 제어 점검 | "IaC 보안 설정 점검해줘" | +| [aws-wa-reliability](skills/aws-wa-reliability) | 안정성 Pillar — HA·내결함성·백업·DR 구성 점검 | "고가용성 구성 리뷰해줘" | +| [aws-wa-performance](skills/aws-wa-performance) | 성능 효율성 Pillar — 리소스 선택·스케일링·캐싱 점검 | "성능 효율성 관점에서 리뷰" | +| [aws-wa-cost](skills/aws-wa-cost) | 비용 최적화 Pillar — 리소스 사이징·스토리지 클래스·비용 모니터링 점검 | "AWS 비용 최적화 리뷰해줘" | +| [aws-wa-sustainability](skills/aws-wa-sustainability) | 지속 가능성 Pillar — 에너지 효율·리소스 최적화 점검 | "지속 가능성 Pillar 점검" | + +## 사용 예시 + +### 예시 1 — PR 전 애플리케이션 보안 리뷰 +`owasp-review`로 인증·권한·입력 검증·시크릿 노출 등 Top 10 항목을 체크리스트로 훑어 critical/high 이슈를 PR 코멘트에 반영합니다. + +### 예시 2 — 분기별 AWS 인프라 Well-Architected 점검 +IaC 저장소를 기준으로 `aws-well-architected` 오케스트레이터를 실행하면 6개 Pillar별 점수·권장사항·우선순위 개선안이 담긴 통합 리포트가 생성됩니다. 다음 분기에 다시 실행하여 히스토리를 추적하세요. + +### 예시 3 — Compliance audit 준비 +`owasp-review`의 카테고리 매핑과 `aws-wa-security`의 IAM·암호화·로깅 권장사항을 조합하면 ISO 27001·SOC2 근거 자료로 사용할 수 있는 출력이 나옵니다. + +## 설치 + +```bash +/plugin marketplace add roboco-io/plugins +/plugin install security@roboco-plugins +``` + +## 요구사항 + +- IaC 대상 파일(Terraform/CloudFormation/CDK/Pulumi)은 저장소 내에 평문으로 존재해야 합니다. +- Compliance 매핑을 활용하려면 대상 프레임워크(PCI-DSS 등)를 프롬프트에 명시하세요. + +## 관련 문서 + +- 루트 README: [../../README.md](../../README.md) +- 플러그인 제작 가이드: [../../docs/plugin-development-guide.md](../../docs/plugin-development-guide.md) diff --git a/plugins/workflow/README.md b/plugins/workflow/README.md new file mode 100644 index 0000000..2fdf88b --- /dev/null +++ b/plugins/workflow/README.md @@ -0,0 +1,46 @@ +# Workflow 플러그인 (Workflow) + +개발의 **의도(Intent) → 프로세스(Ticket) → 실행(Git)** 을 상류에서 하류로 연결하는 메타 워크플로 스킬 모음입니다. 왜 만드는지, 어떤 티켓으로 추적되는지, 어떤 브랜치와 커밋으로 구현되는지를 일관된 규칙으로 관리합니다. + +## 특징 + +- **Git 워크플로 표준화** — `git-workflow`가 브랜치 전략·커밋 컨벤션·PR 관리에 대한 팀 공통 규칙을 안내합니다. +- **티켓 기반 개발(TiDD)** — `tidd`가 "No Ticket, No Commit" 원칙을 PreToolUse 훅으로 강제하여 티켓 번호 없는 커밋을 차단합니다. +- **의도 중심 설계** — `intent-engineering`이 INTENT.md로 프로젝트의 Why/What/Not/Learnings를 문서화하고 학습을 통해 의도를 진화시킵니다. +- **상류-하류 연결** — 의도(왜) → 티켓(무엇을, 언제) → Git(어떻게)까지 단계를 건너뛰지 않는 규율을 제공합니다. + +## 수록 스킬 + +| 스킬 | 용도 | 트리거 예시 | +|------|------|-------------| +| [git-workflow](skills/git-workflow) | 브랜치 전략·커밋 컨벤션·PR 관리 가이드 | "팀 Git 컨벤션 정리해줘", "커밋 메시지 규칙 잡아줘" | +| [tidd](skills/tidd) | No Ticket, No Commit 훅 설치 및 티켓 패턴 구성 | "TiDD 설정해줘", "티켓 없는 커밋 차단해줘" | +| [intent-engineering](skills/intent-engineering) | INTENT.md로 프로젝트 의도(Why/What/Not/Learnings) 문서화 | "INTENT.md 작성 도와줘", "프로젝트 방향 잡기" | + +## 사용 예시 + +### 예시 1 — 새 프로젝트 시작 +`intent-engineering`으로 INTENT.md를 먼저 작성하여 왜 만드는지·무엇을 만들지·무엇은 만들지 않을지를 합의합니다. 탐구와 학습이 누적되면 Learnings 섹션에 반영하여 의도를 진화시키거나 피벗·종료 판단에 근거로 삼습니다. + +### 예시 2 — 티켓 기반 개발 강제 +`tidd`를 설치하면 PreToolUse 훅이 커밋 메시지·브랜치명 중 하나에 티켓 번호가 포함되어 있는지 확인하고, 없으면 커밋을 차단합니다. 티켓 패턴과 예외 규칙은 프로젝트별로 설정 가능합니다. + +### 예시 3 — 팀 Git 컨벤션 정립 +`git-workflow`로 Conventional Commits 기반 커밋 메시지 규칙, 브랜치 네이밍, PR 템플릿 등을 한 번에 정리하여 신규 멤버 온보딩 문서로 활용합니다. + +## 설치 + +```bash +/plugin marketplace add roboco-io/plugins +/plugin install workflow@roboco-plugins +``` + +## 요구사항 + +- `tidd`는 Claude Code의 PreToolUse 훅을 사용하므로 `.claude/settings.json`에 훅 등록 권한이 필요합니다. +- 티켓 번호 패턴은 기본값(`#숫자`, `PROJ-숫자` 등) 외에 프로젝트별로 재정의 가능합니다. + +## 관련 문서 + +- 루트 README: [../../README.md](../../README.md) +- 플러그인 제작 가이드: [../../docs/plugin-development-guide.md](../../docs/plugin-development-guide.md) From 227b00c871dcdc654902210d009459105ebbed9b Mon Sep 17 00:00:00 2001 From: Jung Do Hyun Date: Sat, 18 Apr 2026 11:09:09 +0900 Subject: [PATCH 2/2] docs(workflow): add serverless-migration-advisor to plugin README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR #2 머지 후 workflow 플러그인에 추가된 4번째 스킬을 README의 특징·스킬 테이블·사용 예시에 반영. Co-Authored-By: Claude Opus 4.7 (1M context) --- plugins/workflow/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/plugins/workflow/README.md b/plugins/workflow/README.md index 2fdf88b..c6dc567 100644 --- a/plugins/workflow/README.md +++ b/plugins/workflow/README.md @@ -7,7 +7,8 @@ - **Git 워크플로 표준화** — `git-workflow`가 브랜치 전략·커밋 컨벤션·PR 관리에 대한 팀 공통 규칙을 안내합니다. - **티켓 기반 개발(TiDD)** — `tidd`가 "No Ticket, No Commit" 원칙을 PreToolUse 훅으로 강제하여 티켓 번호 없는 커밋을 차단합니다. - **의도 중심 설계** — `intent-engineering`이 INTENT.md로 프로젝트의 Why/What/Not/Learnings를 문서화하고 학습을 통해 의도를 진화시킵니다. -- **상류-하류 연결** — 의도(왜) → 티켓(무엇을, 언제) → Git(어떻게)까지 단계를 건너뛰지 않는 규율을 제공합니다. +- **서버리스 이행 조언** — `serverless-migration-advisor`가 AWS always-on 아키텍처를 서버리스+Spot 패턴으로 이행할 때 트레이드오프 평가와 단계별 계획을 제공합니다. +- **상류-하류 연결** — 의도(왜) → 티켓(무엇을, 언제) → Git(어떻게) → 아키텍처 이행(무엇으로) 단계를 건너뛰지 않는 규율을 제공합니다. ## 수록 스킬 @@ -16,6 +17,7 @@ | [git-workflow](skills/git-workflow) | 브랜치 전략·커밋 컨벤션·PR 관리 가이드 | "팀 Git 컨벤션 정리해줘", "커밋 메시지 규칙 잡아줘" | | [tidd](skills/tidd) | No Ticket, No Commit 훅 설치 및 티켓 패턴 구성 | "TiDD 설정해줘", "티켓 없는 커밋 차단해줘" | | [intent-engineering](skills/intent-engineering) | INTENT.md로 프로젝트 의도(Why/What/Not/Learnings) 문서화 | "INTENT.md 작성 도와줘", "프로젝트 방향 잡기" | +| [serverless-migration-advisor](skills/serverless-migration-advisor) | AWS always-on 아키텍처를 서버리스+Spot 패턴으로 이행하는 업스트림 어드바이저 | "EC2에서 Lambda로 이행", "ALB에서 API Gateway", "Spot 이행" | ## 사용 예시 @@ -28,6 +30,9 @@ ### 예시 3 — 팀 Git 컨벤션 정립 `git-workflow`로 Conventional Commits 기반 커밋 메시지 규칙, 브랜치 네이밍, PR 템플릿 등을 한 번에 정리하여 신규 멤버 온보딩 문서로 활용합니다. +### 예시 4 — 서버리스 이행 계획 수립 +`serverless-migration-advisor`로 기존 EC2·ALB·RDS 아키텍처를 Lambda·Fargate Spot·Aurora Serverless v2로 옮길 때 트레이드오프와 리스크를 AWS 공식문서·검증 사례 기반으로 검토하고 단계별 체크리스트 리포트를 생성합니다. 세부 구현은 `sagemaker-spot-training` 등 후속 스킬로 위임합니다. + ## 설치 ```bash