review-software-architecture
정보
이 스킬은 결합도, 응집도, SOLID 원칙, 확장성과 같은 핵심 품질 속성에 대해 소프트웨어 아키텍처를 검토합니다. 제안된 설계를 평가하고, 기존 시스템의 기술 부채를 분석하며, 아키텍처 결정 기록(ADR)을 검토합니다. 구현 전이나 시스템 확장 시 실행 가능한 개선 권고사항을 얻기 위해 활용하세요.
빠른 설치
Claude Code
추천npx skills add pjt222/agent-almanac -a claude-code/plugin add https://github.com/pjt222/agent-almanacgit clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/review-software-architectureClaude Code에서 이 명령을 복사하여 붙여넣어 스킬을 설치하세요
문서
審軟構
於系級評構於質屬、設律守、長維。
用
- 估擬構於實前
- 估現系於擴、維、安
- 審項 ADR
- 行技債估
- 估系備大擴或功擴乎
- 異於行級碼審(注 PR 級變)
入
- 必:系庫或構文(圖、ADR、README)
- 必:系旨、模、限脈
- 可:非功需(延、流、可用標)
- 可:隊大與技組
- 可:技限或偏
- 可:知痛點或顧域
行
一:解系脈
圖系界與接:
## System Context
- **Name**: [System name]
- **Purpose**: [One-line description]
- **Users**: [Who uses it and how]
- **Scale**: [Requests/sec, data volume, user count]
- **Age**: [Years in production, major versions]
- **Team**: [Size, composition]
## External Dependencies
| Dependency | Type | Criticality | Notes |
|-----------|------|-------------|-------|
| PostgreSQL | Database | Critical | Primary data store |
| Redis | Cache | High | Session store + caching |
| Stripe | External API | Critical | Payment processing |
| S3 | Object storage | High | File uploads |
得:明系所為與所依。 敗:構文缺→自碼構、配、發檔導脈。
二:估構質
耦估
察模間依密:
- 依向:依一向流(層)抑環?
- 接界:模經定接/契連抑直實引?
- 共態:可變態跨模共乎?
- 庫耦:多服直讀寫同表乎?
- 時耦:業必特序而無明調乎?
# Detect circular dependencies (JavaScript/TypeScript)
npx madge --circular src/
# Detect import patterns (Python)
# Look for deep cross-package imports
grep -r "from app\." --include="*.py" | sort | uniq -c | sort -rn | head -20
聚估
評各模有單明責乎:
- 模命:名準述模所為乎?
- 檔大:檔或類過大(>500 行示多責)?
- 變頻:無關功需改同模乎?
- 神物:類/模諸皆依乎?
| Coupling Level | Description | Example |
|---|---|---|
| Low (good) | Modules communicate through interfaces | Service A calls Service B's API |
| Medium | Modules share data structures | Shared DTO/model library |
| High (concern) | Modules reference each other's internals | Direct database access across modules |
| Pathological | Modules modify each other's internal state | Global mutable state |
得:耦與聚估含庫特例。 敗:庫過大不能手審→抽 3-5 關模與最改檔。
三:估 SOLID 律
| Principle | Question | Red Flags |
|---|---|---|
| Single Responsibility | Does each class/module have one reason to change? | Classes with >5 public methods on unrelated concerns |
| Open/Closed | Can behavior be extended without modifying existing code? | Frequent modifications to core classes for each new feature |
| Liskov Substitution | Can subtypes replace their base types without breaking behavior? | Type checks (instanceof) scattered through consumer code |
| Interface Segregation | Are interfaces focused and minimal? | "Fat" interfaces where consumers implement unused methods |
| Dependency Inversion | Do high-level modules depend on abstractions, not details? | Direct instantiation of infrastructure classes in business logic |
## SOLID Assessment
| Principle | Status | Evidence | Impact |
|-----------|--------|----------|--------|
| SRP | Concern | UserService handles auth, profile, notifications, and billing | High — changes to billing risk breaking auth |
| OCP | Good | Plugin system for payment providers | Low |
| LSP | Good | No type-checking anti-patterns found | Low |
| ISP | Concern | IRepository has 15 methods, most implementors use 3-4 | Medium |
| DIP | Concern | Controllers directly instantiate database repositories | Medium |
得:各律估含至少一特例。 敗:非諸律於各構式皆等。律少相時記之(如 ISP 於函碼少要)。
四:審 API 設
為露 API 之系(REST、GraphQL、gRPC):
- 恆:命約、錯格、頁模一
- 版:策存且施(URL、頭、容議)
- 錯處:錯應結構、恆、不漏內
- 認/授:於 API 層正執
- 限率:護防濫
- 文:OpenAPI/Swagger、GraphQL 模、protobuf 定維
- 冪:變業(POST/PUT)安處重試
## API Design Review
| Aspect | Status | Notes |
|--------|--------|-------|
| Naming consistency | Good | RESTful resource naming throughout |
| Versioning | Concern | No versioning strategy — breaking changes affect all clients |
| Error format | Good | RFC 7807 Problem Details used consistently |
| Auth | Good | JWT with role-based scopes |
| Rate limiting | Missing | No rate limiting on any endpoint |
| Documentation | Concern | OpenAPI spec exists but 6 months out of date |
得:API 設對常準審含特發見。 敗:無 API 露→略此步、注內模接。
五:估擴與信
- 無態:應可橫擴乎(無局態)?
- 庫擴:問索乎?模合數量乎?
- 快策:快施於應層乎(庫、應、CDN)?
- 敗處:依不可達時何發(路斷、重試、退)?
- 可察:誌、指、跡實乎?
- 數恆:終恆受乎抑強恆需?
得:擴與信對所述非功需估。 敗:非功需未書→薦定為首步。
六:估技債
## Technical Debt Inventory
| Item | Severity | Impact | Estimated Effort | Recommendation |
|------|----------|--------|-----------------|----------------|
| No database migrations | High | Schema changes are manual and error-prone | 1 sprint | Adopt Alembic/Flyway |
| Monolithic test suite | Medium | Tests take 45 min, developers skip them | 2 sprints | Split into unit/integration/e2e |
| Hardcoded config values | Medium | Environment-specific values in source code | 1 sprint | Extract to env vars/config service |
| No CI/CD pipeline | High | Manual deployment prone to errors | 1 sprint | Set up GitHub Actions |
得:技債錄含重、影、力估。 敗:債錄淹→序首五於影/力比。
七:審 ADR
ADR 存→估:
- 決有明脈(解何問)
- 替考且書
- 衡明
- 決仍當(未代而無書)
- 新顯決有 ADR
ADR 無→薦立之為關決。
八:書構審
## Architecture Review Report
### Executive Summary
[2-3 sentences: overall health, key concerns, recommended actions]
### Strengths
1. [Specific architectural strength with evidence]
2. ...
### Concerns (by severity)
#### Critical
1. **[Title]**: [Description, impact, recommendation]
#### Major
1. **[Title]**: [Description, impact, recommendation]
#### Minor
1. **[Title]**: [Description, recommendation]
### Technical Debt Summary
[Top 5 debt items with prioritized recommendations]
### Recommended Next Steps
1. [Actionable recommendation with clear scope]
2. ...
得:審報可動含序薦。 敗:審時限→明述何覆何餘。
驗
- 系脈書(旨、模、依、隊)
- 耦與聚估含特碼例
- SOLID 適用處估
- API 設審(適用)
- 擴與信對需估
- 技債錄序
- ADR 審或其缺記
- 薦特、序、可動
忌
- 審碼非構:此技為系級設、非行級碼質。PR 級饋用
code-reviewer - 令特技:構審宜識問、勿命特具除非有明技由
- 忽隊脈:3 人隊「最佳」構異 30 人。顧組限
- 完美:諸系皆有技債。注於實致痛或阻後工之債
- 設模:勿薦分系於 100 用之應。構合實需
參
security-audit-codebase— 安注碼與配審configure-git-repository— 庫構與約design-serialization-schema— 數模設與化review-data-analysis— 析正審(補角)
GitHub 저장소
연관 스킬
executing-plans
디자인executing-plans 스킬은 검토 체크포인트가 포함된 통제된 배치로 실행할 완전한 구현 계획이 있을 때 사용합니다. 이 스킬은 계획을 불러와 비판적으로 검토한 후, 소규모 배치(기본값 3개 작업)로 작업을 실행하면서 각 배치 사이에 진행 상황을 아키텍트 검토를 위해 보고합니다. 이를 통해 내재된 품질 관리 체크포인트를 갖춘 체계적인 구현이 보장됩니다.
requesting-code-review
디자인이 스킬은 코드 변경 사항을 요구 사항에 따라 분석하기 위해 코드 리뷰어 하위 에이전트를 호출합니다. 작업 완료 후, 주요 기능 구현 후, 또는 메인 브랜치에 병합하기 전에 사용해야 합니다. 이 리뷰는 현재 구현체와 원래 계획을 비교하여 문제를 조기에 발견하는 데 도움이 됩니다.
connect-mcp-server
디자인이 스킬은 개발자들이 HTTP, stdio 또는 SSE 전송 방식을 통해 MCP 서버를 Claude Code에 연결하는 포괄적인 가이드를 제공합니다. GitHub, Notion 및 사용자 정의 API와 같은 외부 서비스를 통합하기 위한 설치, 구성, 인증 및 보안을 다룹니다. MCP 통합 설정, 외부 도구 구성 또는 Claude의 모델 컨텍스트 프로토콜 작업 시 활용하세요.
web-cli-teleport
디자인이 스킬은 작업 분석을 기반으로 개발자가 Claude Code 웹 인터페이스와 CLI 인터페이스 중 선택할 수 있도록 돕고, 두 환경 간 원활한 세션 텔레포트를 가능하게 합니다. 웹, CLI 또는 모바일 환경 전환 시 세션 상태와 컨텍스트를 관리하여 워크플로를 최적화합니다. 다양한 단계에서 서로 다른 도구가 필요한 복잡한 프로젝트에 사용하세요.
