Compare commits
7 Commits
0c66149373
...
872c44ea8a
| Author | SHA1 | Date |
|---|---|---|
yeomin4242
|
872c44ea8a | |
Brian
|
242dc6ef75 | |
yeomin4242
|
3e2085975a | |
|
yeomin4242
|
0674ce7381 | |
|
yeomin4242
|
1d1a4070d5 | |
|
yeomin4242
|
5cf4e72092 | |
|
yeomin4242
|
92417e748b |
|
|
@ -26,6 +26,9 @@ design-artifacts/
|
|||
__pycache__/
|
||||
.pytest_cache/
|
||||
|
||||
# BMad run artifacts (memlogs are per-run working memory, never committed)
|
||||
.memlog.md
|
||||
|
||||
# System files
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
|
|
|||
|
|
@ -0,0 +1,113 @@
|
|||
|
||||
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](LICENSE)
|
||||
[](https://nodejs.org)
|
||||
[](https://www.python.org)
|
||||
[](https://docs.astral.sh/uv/)
|
||||
[](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
[English](README.md) | [简体中文](README_CN.md) | [Tiếng Việt](README_VN.md) | 한국어
|
||||
|
||||
**Build More Architect Dreams** - BMad Method 모듈 생태계를 위한 AI 기반 애자일 개발 모듈입니다. 버그 수정부터 엔터프라이즈 시스템까지, 프로젝트 규모와 도메인에 맞춰 계획 깊이를 조절하는 포괄적인 프레임워크입니다.
|
||||
|
||||
**100% 무료 오픈 소스입니다.** 유료 장벽도, 잠긴 콘텐츠도, 폐쇄형 Discord도 없습니다. 우리는 닫힌 커뮤니티나 강좌 비용을 낼 수 있는 사람만이 아니라 모두가 더 나은 도구를 쓸 수 있어야 한다고 믿습니다.
|
||||
|
||||
## 왜 BMad Method인가요?
|
||||
|
||||
전통적인 AI 도구는 사용자를 대신해 생각하고 평균적인 결과를 내는 데 그치는 경우가 많습니다. BMad의 전문 에이전트와 안내형 워크플로는 AI와 함께 더 나은 사고를 끌어내도록 돕는 전문가 협업자처럼 작동합니다.
|
||||
|
||||
- **AI 안내 도움말** - 언제든 `bmad-help` 스킬을 호출해 다음 단계 안내를 받습니다
|
||||
- **규모와 도메인에 적응** - 프로젝트 복잡도에 맞춰 계획 깊이를 자동으로 조절합니다
|
||||
- **구조화된 워크플로** - 분석, 계획, 아키텍처, 구현 전반에 애자일 모범 사례를 적용합니다
|
||||
- **전문 에이전트** - PM, 아키텍트, 개발자, UX 등 12개 이상의 역할별 전문가를 제공합니다
|
||||
- **파티 모드** - 여러 에이전트 페르소나를 한 세션에 불러와 함께 협업하고 토론합니다
|
||||
- **전체 수명주기 지원** - 브레인스토밍부터 배포까지 함께합니다
|
||||
|
||||
[**docs.bmad-method.org**에서 더 알아보기](https://docs.bmad-method.org/ko-kr/)
|
||||
|
||||
## BMad의 다음 단계
|
||||
|
||||
**V6가 출시됐고, 이제 시작입니다!** BMad Method는 크로스 플랫폼 에이전트 팀과 서브 에이전트 통합, 스킬 아키텍처, BMad 빌더 v1, 개발 루프 자동화 등 여러 개선과 함께 빠르게 진화하고 있습니다.
|
||||
|
||||
**[전체 로드맵 보기](https://docs.bmad-method.org/ko-kr/roadmap/)**
|
||||
|
||||
## 빠른 시작
|
||||
|
||||
**필수 조건**: [Node.js](https://nodejs.org) v20+ · [Python](https://www.python.org) 3.10+ · [uv](https://docs.astral.sh/uv/)
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
> 최신 사전 릴리스 빌드를 사용하려면 `npx bmad-method@next install`을 실행하세요. 기본 설치보다 변경이 더 잦을 수 있습니다.
|
||||
|
||||
설치 프로그램의 안내를 따른 다음, Claude Code나 Cursor 같은 AI IDE를 프로젝트 폴더에서 엽니다.
|
||||
|
||||
**비대화형 설치**(CI/CD용):
|
||||
|
||||
```bash
|
||||
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
|
||||
```
|
||||
|
||||
모듈 설정 옵션은 `--set <module>.<key>=<value>`로 재정의할 수 있습니다. 여러 번 사용할 수 있습니다. 로컬에서 알려진 공식 키를 보려면 `--list-options [module]`을 실행하세요.
|
||||
|
||||
```bash
|
||||
npx bmad-method install --yes \
|
||||
--modules bmm --tools claude-code \
|
||||
--set bmm.project_knowledge=research \
|
||||
--set bmm.user_skill_level=expert
|
||||
```
|
||||
|
||||
[전체 설치 옵션 보기](https://docs.bmad-method.org/ko-kr/how-to/non-interactive-installation/)
|
||||
|
||||
> **무엇을 해야 할지 모르겠나요?** `bmad-help`에게 물어보세요. 다음에 해야 할 일과 선택 사항을 정확히 알려줍니다. `bmad-help 아키텍처를 막 끝냈는데 다음에 무엇을 해야 하나요?`처럼 질문할 수도 있습니다.
|
||||
|
||||
## 모듈
|
||||
|
||||
BMad Method는 전문 도메인을 위한 공식 모듈로 확장됩니다. 설치 중에 선택하거나 나중에 추가할 수 있습니다.
|
||||
|
||||
| 모듈 | 목적 |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
|
||||
| **[BMad Method(BMM)](https://github.com/bmad-code-org/BMAD-METHOD)** | 34개 이상의 워크플로를 제공하는 핵심 프레임워크 |
|
||||
| **[BMad 빌더(BMB)](https://github.com/bmad-code-org/bmad-builder)** | 커스텀 BMad 에이전트와 워크플로 생성 |
|
||||
| **[테스트 설계자(TEA)](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)** | 위험 기반 테스트 전략과 자동화 |
|
||||
| **[게임 개발 스튜디오(BMGD)](https://github.com/bmad-code-org/bmad-module-game-dev-studio)** | Unity, Unreal, Godot 워크플로 |
|
||||
| **[창의적 지능 제품군(CIS)](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)** | 혁신, 브레인스토밍, 디자인 사고 |
|
||||
|
||||
## 문서
|
||||
|
||||
[BMad Method 문서 사이트](https://docs.bmad-method.org/ko-kr/) - 튜토리얼, 가이드, 개념 설명, 참조 문서
|
||||
|
||||
**빠른 링크:**
|
||||
|
||||
- [시작하기 튜토리얼](https://docs.bmad-method.org/ko-kr/tutorials/getting-started/)
|
||||
- [이전 버전에서 업그레이드](https://docs.bmad-method.org/ko-kr/how-to/upgrade-to-v6/)
|
||||
- [테스트 설계자 문서](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
||||
|
||||
## 커뮤니티
|
||||
|
||||
- [Discord](https://discord.gg/gk8jAdXWmj) - 도움을 받고, 아이디어를 나누고, 협업하세요
|
||||
- [YouTube](https://youtube.com/@BMadCode) - 튜토리얼, 마스터 클래스 등
|
||||
- [X / Twitter](https://x.com/BMadCode)
|
||||
- [웹사이트](https://bmadcode.com)
|
||||
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) - 버그 제보와 기능 요청
|
||||
- [토론](https://github.com/bmad-code-org/BMAD-METHOD/discussions) - 커뮤니티 대화
|
||||
|
||||
## BMad 후원
|
||||
|
||||
BMad는 모두에게 무료이며 앞으로도 그럴 것입니다. 이 저장소에 스타를 눌러 주거나, [커피 한 잔 후원](https://buymeacoffee.com/bmad)을 보내거나, 기업 후원은 <contact@bmadcode.com>으로 문의해 주세요.
|
||||
|
||||
## 기여
|
||||
|
||||
기여를 환영합니다! 자세한 지침은 [CONTRIBUTING.md](CONTRIBUTING.md)를 확인하세요.
|
||||
|
||||
## 라이선스
|
||||
|
||||
MIT 라이선스입니다. 자세한 내용은 [LICENSE](LICENSE)를 확인하세요.
|
||||
|
||||
**BMad**와 **BMAD-METHOD**는 BMad Code, LLC의 상표입니다. 자세한 내용은 [TRADEMARK.md](TRADEMARK.md)를 확인하세요.
|
||||
|
||||
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
||||
|
||||
기여자 정보는 [CONTRIBUTORS.md](CONTRIBUTORS.md)를 확인하세요.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: 페이지를 찾을 수 없음
|
||||
template: splash
|
||||
---
|
||||
|
||||
찾으려는 페이지가 없거나 이동되었습니다.
|
||||
|
||||
[홈으로 돌아가기](./index.md)
|
||||
|
|
@ -0,0 +1,370 @@
|
|||
---
|
||||
title: "문서 스타일 가이드"
|
||||
description: Google 스타일과 Diataxis 구조를 바탕으로 한 프로젝트별 문서 작성 규칙
|
||||
---
|
||||
|
||||
이 프로젝트는 [Google Developer 문서 스타일 가이드](https://developers.google.com/style)를 따르고 [Diataxis](https://diataxis.fr/)로 콘텐츠를 구조화합니다. 아래에는 프로젝트별 규칙만 정리합니다.
|
||||
|
||||
## 프로젝트별 규칙
|
||||
|
||||
| 규칙 | 사양 |
|
||||
| --- | --- |
|
||||
| 가로 구분선(`---`) 사용 금지 | 읽기 흐름을 끊습니다 |
|
||||
| `####` 헤더 사용 금지 | 대신 굵은 글씨나 알림 상자를 사용합니다 |
|
||||
| "관련 항목" 또는 "다음:" 섹션 금지 | 사이드바가 탐색을 담당합니다 |
|
||||
| 깊게 중첩된 목록 금지 | 섹션으로 나누세요 |
|
||||
| 코드가 아닌 내용에 코드 블록 사용 금지 | 대화 예시는 알림 상자를 사용합니다 |
|
||||
| 콜아웃용 굵은 문단 금지 | 대신 알림 상자를 사용합니다 |
|
||||
| 섹션당 알림 상자 1-2개까지 | 튜토리얼은 큰 섹션당 3-4개까지 허용합니다 |
|
||||
| 표 셀 / 목록 항목 | 최대 1-2문장 |
|
||||
| 헤더 예산 | 문서당 `##` 8-12개, 섹션당 `###` 2-3개 |
|
||||
|
||||
## 알림 상자(Starlight 문법)
|
||||
|
||||
```md
|
||||
:::tip[제목]
|
||||
단축키, 모범 사례
|
||||
:::
|
||||
|
||||
:::note[제목]
|
||||
맥락, 정의, 예시, 필수 조건
|
||||
:::
|
||||
|
||||
:::caution[제목]
|
||||
주의 사항, 잠재적 문제
|
||||
:::
|
||||
|
||||
:::danger[제목]
|
||||
데이터 손실, 보안 문제 같은 중대한 경고에만 사용
|
||||
:::
|
||||
```
|
||||
|
||||
### 표준 용도
|
||||
|
||||
| 알림 상자 | 사용처 |
|
||||
| --- | --- |
|
||||
| `:::note[필수 조건]` | 시작 전 필요한 의존성 |
|
||||
| `:::tip[빠른 경로]` | 문서 상단의 짧은 요약 |
|
||||
| `:::caution[중요]` | 중요한 주의 사항 |
|
||||
| `:::note[예시]` | 명령/응답 예시 |
|
||||
|
||||
## 표준 표 형식
|
||||
|
||||
**단계:**
|
||||
|
||||
```md
|
||||
| 단계 | 이름 | 내용 |
|
||||
| --- | --- | --- |
|
||||
| 1 | 분석 | 브레인스토밍, 리서치 *(선택 사항)* |
|
||||
| 2 | 계획 | 요구사항 - PRD 또는 사양 *(필수)* |
|
||||
```
|
||||
|
||||
**스킬:**
|
||||
|
||||
```md
|
||||
| 스킬 | 에이전트 | 목적 |
|
||||
| --- | --- | --- |
|
||||
| `bmad-brainstorming` | 분석가 | 새 프로젝트 브레인스토밍 |
|
||||
| `bmad-create-prd` | PM | 제품 요구사항 문서 생성 |
|
||||
```
|
||||
|
||||
## 폴더 구조 블록
|
||||
|
||||
"달성한 것" 섹션에서는 다음처럼 표시합니다.
|
||||
|
||||
````md
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/ # BMad 설정
|
||||
├── _bmad-output/
|
||||
│ ├── planning-artifacts/
|
||||
│ │ └── PRD.md # 요구사항 문서
|
||||
│ ├── implementation-artifacts/
|
||||
│ └── project-context.md # 구현 규칙 (선택 사항)
|
||||
└── ...
|
||||
```
|
||||
````
|
||||
|
||||
## 튜토리얼 구조
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장(결과를 설명하는 1-2문장)
|
||||
2. 버전/모듈 안내(정보 또는 경고 알림 상자, 선택)
|
||||
3. 배울 내용(결과 중심 글머리표 목록)
|
||||
4. 필수 조건(정보 알림 상자)
|
||||
5. 빠른 경로(tip 알림 상자 - 짧은 요약)
|
||||
6. [주제] 이해하기(단계 전 맥락 - 단계/에이전트 표)
|
||||
7. 설치(선택)
|
||||
8. 1단계: [첫 번째 주요 작업]
|
||||
9. 2단계: [두 번째 주요 작업]
|
||||
10. 3단계: [세 번째 주요 작업]
|
||||
11. 달성한 것(요약 + 폴더 구조)
|
||||
12. 빠른 참조(스킬 표)
|
||||
13. 자주 묻는 질문(FAQ 형식)
|
||||
14. 도움 받기(커뮤니티 링크)
|
||||
15. 핵심 요약(tip 알림 상자)
|
||||
```
|
||||
|
||||
### 튜토리얼 체크리스트
|
||||
|
||||
- [ ] 후킹 문장이 결과를 1-2문장으로 설명합니다
|
||||
- [ ] "배울 내용" 섹션이 있습니다
|
||||
- [ ] 필수 조건이 알림 상자에 있습니다
|
||||
- [ ] 상단에 빠른 경로 요약 알림 상자가 있습니다
|
||||
- [ ] 단계, 스킬, 에이전트를 표로 제시합니다
|
||||
- [ ] "달성한 것" 섹션이 있습니다
|
||||
- [ ] 빠른 참조 표가 있습니다
|
||||
- [ ] 자주 묻는 질문 섹션이 있습니다
|
||||
- [ ] 도움 받기 섹션이 있습니다
|
||||
- [ ] 마지막에 핵심 요약 알림 상자가 있습니다
|
||||
|
||||
## 사용 가이드 구조
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장("`X` 워크플로를 사용해..." 한 문장)
|
||||
2. 사용 시점(3-5개 글머리표 목록)
|
||||
3. 건너뛸 시점(선택)
|
||||
4. 필수 조건(note 알림 상자)
|
||||
5. 단계(번호가 붙은 ### 하위 섹션)
|
||||
6. 얻는 결과(생성되는 산출물)
|
||||
7. 예시(선택)
|
||||
8. 팁(선택)
|
||||
9. 다음 단계(선택)
|
||||
```
|
||||
|
||||
### 사용 가이드 체크리스트
|
||||
|
||||
- [ ] 후킹 문장이 "`X` 워크플로를 사용해..."로 시작합니다
|
||||
- [ ] "사용 시점"에 3-5개 글머리표가 있습니다
|
||||
- [ ] 필수 조건이 나열되어 있습니다
|
||||
- [ ] 단계는 동작 동사로 시작하는 번호가 붙은 `###` 하위 섹션입니다
|
||||
- [ ] "얻는 결과"가 산출물을 설명합니다
|
||||
|
||||
## 개념 설명 구조
|
||||
|
||||
### 유형
|
||||
|
||||
| 유형 | 예시 |
|
||||
| --- | --- |
|
||||
| **인덱스/랜딩** | `core-concepts/index.md` |
|
||||
| **개념** | `what-are-agents.md` |
|
||||
| **기능** | `quick-dev.md` |
|
||||
| **철학** | `why-solutioning-matters.md` |
|
||||
| **FAQ** | `established-projects-faq.md` |
|
||||
|
||||
### 일반 템플릿
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장(1-2문장)
|
||||
2. 개요/정의(무엇이며 왜 중요한지)
|
||||
3. 핵심 개념(### 하위 섹션)
|
||||
4. 비교 표(선택)
|
||||
5. 사용할 때 / 사용하지 않을 때(선택)
|
||||
6. 다이어그램(선택 - mermaid, 문서당 최대 1개)
|
||||
7. 다음 단계(선택)
|
||||
```
|
||||
|
||||
### 인덱스/랜딩 페이지
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장(한 문장)
|
||||
2. 콘텐츠 표(설명이 있는 링크)
|
||||
3. 시작하기(번호 목록)
|
||||
4. 경로 선택(선택 - 의사결정 트리)
|
||||
```
|
||||
|
||||
### 개념 설명 문서
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장(무엇인지)
|
||||
2. 유형/범주(### 하위 섹션, 선택)
|
||||
3. 주요 차이 표
|
||||
4. 구성 요소/부분
|
||||
5. 무엇을 사용해야 하나요?
|
||||
6. 생성/커스터마이징(사용 가이드 링크)
|
||||
```
|
||||
|
||||
### 기능 설명 문서
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장(무엇을 하는지)
|
||||
2. 빠른 정보(선택 - "적합한 경우:", "소요 시간:")
|
||||
3. 사용할 때 / 사용하지 않을 때
|
||||
4. 작동 방식(mermaid 다이어그램 선택)
|
||||
5. 핵심 이점
|
||||
6. 비교 표(선택)
|
||||
7. 졸업/업그레이드 시점(선택)
|
||||
```
|
||||
|
||||
### 철학/근거 문서
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장(원칙)
|
||||
2. 문제
|
||||
3. 해결책
|
||||
4. 핵심 원칙(### 하위 섹션)
|
||||
5. 이점
|
||||
6. 적용 시점
|
||||
```
|
||||
|
||||
### 개념 설명 체크리스트
|
||||
|
||||
- [ ] 후킹 문장이 문서가 설명하는 내용을 말합니다
|
||||
- [ ] 스캔하기 쉬운 `##` 섹션으로 구성합니다
|
||||
- [ ] 3개 이상의 선택지가 있으면 비교 표를 사용합니다
|
||||
- [ ] 다이어그램에는 명확한 라벨이 있습니다
|
||||
- [ ] 절차적 질문에는 사용 가이드 링크를 제공합니다
|
||||
- [ ] 문서당 알림 상자는 최대 2-3개입니다
|
||||
|
||||
## 참조 문서 구조
|
||||
|
||||
### 유형
|
||||
|
||||
| 유형 | 예시 |
|
||||
| --- | --- |
|
||||
| **인덱스/랜딩** | `workflows/index.md` |
|
||||
| **카탈로그** | `agents/index.md` |
|
||||
| **심층 설명** | `document-project.md` |
|
||||
| **설정** | `core-tasks.md` |
|
||||
| **용어집** | `glossary/index.md` |
|
||||
| **종합 가이드** | `bmgd-workflows.md` |
|
||||
|
||||
### 참조 인덱스 페이지
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장(한 문장)
|
||||
2. 콘텐츠 섹션(각 범주에 ## 사용)
|
||||
- 링크와 설명이 있는 글머리표 목록
|
||||
```
|
||||
|
||||
### 카탈로그 참조
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장
|
||||
2. 항목(각 항목에 ## 사용)
|
||||
- 짧은 설명(한 문장)
|
||||
- **스킬:** 또는 **핵심 정보:** 형태의 평평한 목록
|
||||
3. 공통/공유 섹션(## 섹션, 선택)
|
||||
```
|
||||
|
||||
### 항목 심층 참조
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장(한 문장 목적)
|
||||
2. 빠른 정보(note 알림 상자, 선택)
|
||||
- 모듈, 스킬, 입력, 출력 목록
|
||||
3. 목적/개요(## 섹션)
|
||||
4. 호출 방법(코드 블록)
|
||||
5. 핵심 섹션(각 측면에 ## 사용)
|
||||
- 하위 선택지에는 ### 사용
|
||||
6. 참고/주의 사항(tip 또는 caution 알림 상자)
|
||||
```
|
||||
|
||||
### 설정 참조
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장
|
||||
2. 목차(항목이 4개 이상이면 점프 링크)
|
||||
3. 항목(각 설정/작업에 ## 사용)
|
||||
- **굵은 요약** — 한 문장
|
||||
- **사용 시점:** 글머리표 목록
|
||||
- **작동 방식:** 번호 목록(최대 3-5개)
|
||||
- **출력:** 예상 결과(선택)
|
||||
```
|
||||
|
||||
### 종합 참조 가이드
|
||||
|
||||
```text
|
||||
1. 제목 + 후킹 문장
|
||||
2. 개요(## 섹션)
|
||||
- 구성을 보여주는 다이어그램 또는 표
|
||||
3. 주요 섹션(각 단계/범주에 ## 사용)
|
||||
- 항목(각 항목에 ### 사용)
|
||||
- 표준 필드: 스킬, 에이전트, 입력, 출력, 설명
|
||||
4. 다음 단계(선택)
|
||||
```
|
||||
|
||||
### 참조 체크리스트
|
||||
|
||||
- [ ] 후킹 문장이 문서가 참조하는 내용을 말합니다
|
||||
- [ ] 구조가 참조 유형에 맞습니다
|
||||
- [ ] 항목은 전체적으로 일관된 구조를 사용합니다
|
||||
- [ ] 구조화/비교 데이터에는 표를 사용합니다
|
||||
- [ ] 개념적 깊이가 필요한 곳에는 개념 설명 문서 링크를 둡니다
|
||||
- [ ] 알림 상자는 최대 1-2개입니다
|
||||
|
||||
## 용어집 구조
|
||||
|
||||
Starlight는 헤더에서 오른쪽 "이 페이지에서" 탐색을 생성합니다.
|
||||
|
||||
- 범주는 `##` 헤더로 작성합니다. 오른쪽 탐색에 표시됩니다
|
||||
- 용어는 개별 헤더가 아니라 표 안의 간결한 행으로 작성합니다
|
||||
- 인라인 TOC는 사용하지 않습니다. 오른쪽 사이드바가 탐색을 담당합니다
|
||||
|
||||
### 표 형식
|
||||
|
||||
```md
|
||||
## 범주 이름
|
||||
|
||||
| 용어 | 정의 |
|
||||
| --- | --- |
|
||||
| **에이전트** | 특정 전문성을 갖고 워크플로 전반에서 사용자를 안내하는 특화 AI 페르소나입니다. |
|
||||
| **워크플로** | 산출물을 만들기 위해 AI 에이전트 활동을 조율하는 여러 단계의 안내형 프로세스입니다. |
|
||||
```
|
||||
|
||||
### 정의 규칙
|
||||
|
||||
| 해야 할 것 | 하지 말 것 |
|
||||
| --- | --- |
|
||||
| 무엇인지 또는 무엇을 하는지로 시작합니다 | "이것은..." 또는 "이 용어는..."으로 시작합니다 |
|
||||
| 1-2문장으로 유지합니다 | 여러 문단으로 설명합니다 |
|
||||
| 셀 안의 용어명을 굵게 표시합니다 | 용어를 일반 텍스트로 둡니다 |
|
||||
|
||||
### 컨텍스트 표시
|
||||
|
||||
범위가 제한된 용어는 정의 시작에 이탤릭 컨텍스트를 추가합니다.
|
||||
|
||||
- `*빠른 흐름 전용.*`
|
||||
- `*BMad Method/엔터프라이즈.*`
|
||||
- `*N단계.*`
|
||||
- `*BMGD.*`
|
||||
- `*기존 프로젝트.*`
|
||||
|
||||
### 용어집 체크리스트
|
||||
|
||||
- [ ] 용어는 개별 헤더가 아니라 표에 있습니다
|
||||
- [ ] 범주 안에서 용어를 사전순으로 정렬합니다
|
||||
- [ ] 정의는 1-2문장입니다
|
||||
- [ ] 컨텍스트 표시는 이탤릭입니다
|
||||
- [ ] 셀 안의 용어명은 굵게 표시합니다
|
||||
- [ ] "이것은..." 또는 "이 용어는..." 형태의 정의를 사용하지 않습니다
|
||||
|
||||
## FAQ 섹션
|
||||
|
||||
```md
|
||||
## 질문
|
||||
|
||||
- [항상 아키텍처가 필요한가요?](#항상-아키텍처가-필요한가요)
|
||||
- [나중에 계획을 바꿀 수 있나요?](#나중에-계획을-바꿀-수-있나요)
|
||||
|
||||
### 항상 아키텍처가 필요한가요?
|
||||
|
||||
BMad Method와 엔터프라이즈 트랙에서만 필요합니다. 빠른 흐름은 구현으로 바로 넘어갑니다.
|
||||
|
||||
### 나중에 계획을 바꿀 수 있나요?
|
||||
|
||||
예. `bmad-correct-course` 워크플로가 구현 중 범위 변경을 처리합니다.
|
||||
|
||||
**여기에 답이 없는 질문이 있나요?** [이슈를 열거나](...) [Discord](...)에서 물어보세요.
|
||||
```
|
||||
|
||||
## 검증 명령
|
||||
|
||||
문서 변경을 제출하기 전에 다음을 실행하세요.
|
||||
|
||||
```bash
|
||||
npm run docs:fix-links # 링크 형식 수정 미리보기
|
||||
npm run docs:fix-links -- --write # 수정 적용
|
||||
npm run docs:validate-links # 링크 존재 여부 확인
|
||||
npm run docs:build # 빌드 오류 없음 확인
|
||||
```
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
title: "고급 도출"
|
||||
description: 구조화된 추론 방법으로 LLM이 자신의 작업을 다시 생각하게 합니다
|
||||
sidebar:
|
||||
order: 9
|
||||
---
|
||||
|
||||
LLM이 방금 생성한 결과를 다시 검토하게 만드세요. 추론 방법을 선택하면 LLM이 그 방법을 자신의 출력에 적용하고, 사용자는 개선 사항을 유지할지 결정합니다.
|
||||
|
||||
## 고급 도출이란?
|
||||
|
||||
구조화된 두 번째 검토 단계입니다. AI에게 막연히 "다시 해봐" 또는 "더 좋게 만들어"라고 말하는 대신, 특정 추론 방법을 선택하고 AI가 그 렌즈를 통해 자신의 출력을 다시 살핍니다.
|
||||
|
||||
이 차이는 중요합니다. 모호한 요청은 모호한 수정을 낳습니다. 이름 있는 방법은 특정한 검토 관점을 강제해 일반적인 재시도로는 놓칠 인사이트를 드러냅니다.
|
||||
|
||||
## 사용 시점
|
||||
|
||||
- 워크플로가 콘텐츠를 생성한 뒤 대안을 보고 싶을 때
|
||||
- 출력은 괜찮아 보이지만 더 깊이가 있을 것 같을 때
|
||||
- 가정을 스트레스 테스트하거나 약점을 찾고 싶을 때
|
||||
- 다시 생각하는 과정이 도움이 되는 중요도가 높은 콘텐츠일 때
|
||||
|
||||
워크플로는 결정 지점에서 고급 도출을 제안합니다. LLM이 무언가를 생성한 뒤 실행할지 묻습니다.
|
||||
|
||||
## 작동 방식
|
||||
|
||||
1. LLM이 콘텐츠에 관련 있는 방법 5개를 제안합니다
|
||||
2. 하나를 고릅니다(또는 다른 선택지를 보려고 다시 섞습니다)
|
||||
3. 방법이 적용되고 개선 사항이 표시됩니다
|
||||
4. 수락하거나 버리고, 반복하거나 계속합니다
|
||||
|
||||
## 내장 방법
|
||||
|
||||
수십 가지 추론 방법을 사용할 수 있습니다. 예시는 다음과 같습니다.
|
||||
|
||||
- **사전 실패 분석** - 프로젝트가 이미 실패했다고 가정하고 이유를 역추적합니다
|
||||
- **제1원칙 사고** - 가정을 걷어내고 근거 사실에서 다시 세웁니다
|
||||
- **역전 사고** - 실패를 보장하는 방법을 묻고, 그 일을 피합니다
|
||||
- **레드 팀 vs 블루 팀** - 자신의 작업을 공격한 뒤 방어합니다
|
||||
- **소크라테스식 질문** - 모든 주장에 "왜?"와 "어떻게 알아?"를 던집니다
|
||||
- **제약 제거** - 모든 제약을 제거해 무엇이 바뀌는지 보고, 선택적으로 다시 추가합니다
|
||||
- **이해관계자 매핑** - 각 이해관계자 관점에서 다시 평가합니다
|
||||
- **유추 추론** - 다른 도메인의 유사점을 찾아 그 교훈을 적용합니다
|
||||
|
||||
그 밖에도 훨씬 많습니다. AI는 콘텐츠에 가장 관련 있는 선택지를 고르고, 사용자는 실행할 방법을 선택합니다.
|
||||
|
||||
:::tip[시작점]
|
||||
사전 실패 분석은 어떤 사양이나 계획에도 좋은 첫 선택입니다. 표준 리뷰가 놓치는 공백을 꾸준히 찾아냅니다.
|
||||
:::
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
---
|
||||
title: "적대적 리뷰"
|
||||
description: “괜찮아 보이네”라는 식의 대충 넘어가는 검토를 방지하는 논리적 추론 기법
|
||||
sidebar:
|
||||
order: 8
|
||||
---
|
||||
|
||||
문제를 반드시 찾게 만들어 더 깊은 분석을 강제합니다.
|
||||
|
||||
## 적대적 리뷰란?
|
||||
|
||||
리뷰어가 *반드시* 이슈를 찾아야 하는 리뷰 기법입니다. "좋아 보입니다"는 허용되지 않습니다. 리뷰어는 문제가 존재한다고 가정하고, 냉정한 태도로 그것을 찾아냅니다.
|
||||
|
||||
부정적이 되자는 뜻이 아닙니다. 제출물을 도장 찍듯 승인하는 대충 훑기가 아니라 실제 분석을 강제하기 위한 것입니다.
|
||||
|
||||
**핵심 규칙:** 이슈를 찾아야 합니다. 발견 항목이 0개면 중단하고 다시 분석하거나 이유를 설명합니다.
|
||||
|
||||
## 왜 효과적인가
|
||||
|
||||
일반 리뷰는 확증 편향에 취약합니다. 작업을 훑고, 눈에 띄는 것이 없으면 승인합니다. "문제를 찾아라"라는 요구는 이 패턴을 끊습니다.
|
||||
|
||||
- **철저함을 강제** - 충분히 열심히 살펴 이슈를 찾기 전까지 승인할 수 없습니다
|
||||
- **빠진 것을 잡아냄** - "여기에 없는 것은 무엇인가?"가 자연스러운 질문이 됩니다
|
||||
- **신호 품질 향상** - 발견 사항이 막연한 우려가 아니라 구체적이고 실행 가능해집니다
|
||||
- **정보 비대칭** - 원래 의사결정 과정을 보지 않은 새 컨텍스트에서 검토해 의도가 아니라 산출물을 평가합니다
|
||||
|
||||
## 사용 위치
|
||||
|
||||
적대적 리뷰는 코드 리뷰, 구현 준비 상태 점검, 사양 검증 등 BMad 워크플로 전반에 나타납니다. 어떤 때는 필수 단계이고, 어떤 때는 고급 도출이나 파티 모드처럼 선택 사항입니다. 검토가 필요한 산출물에 맞춰 패턴이 적응합니다.
|
||||
|
||||
## 사람의 필터링 필요
|
||||
|
||||
AI는 문제를 찾도록 *지시*받았으므로 문제를 찾습니다. 실제로는 존재하지 않을 때도 그렇습니다. 사소한 지적을 이슈처럼 포장하거나, 의도를 오해하거나, 아예 환각성 발견 사항을 낼 수 있습니다.
|
||||
|
||||
**무엇이 실제인지 사용자가 결정합니다.** 각 발견 사항을 검토하고 노이즈를 버리고 중요한 것을 고치세요.
|
||||
|
||||
## 예시
|
||||
|
||||
다음 대신:
|
||||
|
||||
> "인증 구현은 괜찮아 보입니다. 승인합니다."
|
||||
|
||||
적대적 리뷰는 다음처럼 나옵니다.
|
||||
|
||||
> 1. **HIGH** - `login.ts:47` - 실패한 로그인 시도에 속도 제한 없음
|
||||
> 2. **HIGH** - 세션 토큰이 localStorage에 저장됨(XSS 취약)
|
||||
> 3. **MEDIUM** - 비밀번호 검증이 클라이언트 측에서만 수행됨
|
||||
> 4. **MEDIUM** - 실패한 로그인 시도에 대한 감사 로깅 없음
|
||||
> 5. **LOW** - 매직 넘버 `3600`은 `SESSION_TIMEOUT_SECONDS`가 되어야 함
|
||||
|
||||
첫 번째 리뷰는 보안 취약점을 놓칠 수 있습니다. 두 번째는 네 가지를 잡았습니다.
|
||||
|
||||
## 반복과 수확 체감
|
||||
|
||||
발견 사항을 처리한 뒤 다시 실행하는 것도 고려하세요. 두 번째 실행은 대개 더 많은 것을 잡아냅니다. 세 번째도 항상 쓸모없지는 않습니다. 하지만 각 실행에는 시간이 들고, 언젠가는 사소한 지적과 거짓 발견 사항만 남는 수확 체감 구간에 들어갑니다.
|
||||
|
||||
:::tip[더 나은 리뷰]
|
||||
문제가 존재한다고 가정하세요. 잘못된 것뿐 아니라 빠진 것을 찾으세요.
|
||||
:::
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
---
|
||||
title: "분석 단계: 아이디어에서 기반까지"
|
||||
description: 브레인스토밍, 리서치, 제품 개요, PRFAQ가 무엇이며 언제 쓰는지 설명합니다
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
분석 단계(단계 1)는 제품을 만들기로 확정하기 전에 명확하게 생각하도록 돕습니다. 이 단계의 모든 도구는 선택 사항이지만, 분석을 완전히 건너뛰면 PRD가 인사이트가 아니라 가정 위에 세워집니다.
|
||||
|
||||
## 왜 계획 전에 분석이 필요한가?
|
||||
|
||||
PRD는 "무엇을 만들고 왜 만드는가?"에 답합니다. 모호한 생각을 넣으면 모호한 PRD가 나오고, 이후 모든 문서가 그 모호함을 상속합니다. 약한 PRD 위에 세운 아키텍처는 잘못된 기술적 베팅을 합니다. 약한 아키텍처에서 나온 스토리는 엣지 케이스를 놓칩니다. 비용은 누적됩니다.
|
||||
|
||||
분석 도구는 PRD를 날카롭게 만들기 위해 존재합니다. 창의적 탐색, 시장 현실, 고객 명확성, 실행 가능성 등 서로 다른 각도에서 문제를 검토해 PM 에이전트와 마주 앉을 때 무엇을 누구를 위해 만드는지 알게 합니다.
|
||||
|
||||
## 도구들
|
||||
|
||||
### 브레인스토밍
|
||||
|
||||
**무엇인가요.** 검증된 아이디어 발상 기법을 사용하는 안내형 창의 세션입니다. AI는 아이디어를 대신 생성하지 않고, 구조화된 연습으로 사용자 안의 아이디어를 끌어내는 코치 역할을 합니다.
|
||||
|
||||
**왜 있나요.** 원석 같은 아이디어는 요구사항에 고정되기 전에 발전할 공간이 필요합니다. 브레인스토밍은 그 공간을 만듭니다. 문제 도메인은 있지만 명확한 해결책이 없거나, 확정하기 전에 여러 방향을 탐색하고 싶을 때 특히 유용합니다.
|
||||
|
||||
**언제 쓰나요.** 만들고 싶은 것에 대한 막연한 감은 있지만 개념이 아직 굳지 않았을 때 사용합니다. 또는 개념은 있지만 대안과 비교해 압박 테스트하고 싶을 때 사용합니다.
|
||||
|
||||
세션 작동 방식은 [브레인스토밍](./brainstorming.md)을 참고하세요.
|
||||
|
||||
### 리서치(시장, 도메인, 기술)
|
||||
|
||||
**무엇인가요.** 아이디어의 서로 다른 차원을 조사하는 세 가지 집중 연구 워크플로입니다. 시장 조사는 경쟁자, 트렌드, 사용자 반응을 봅니다. 도메인 조사는 주제 전문성과 용어를 쌓습니다. 기술 조사는 실현 가능성, 아키텍처 선택지, 구현 접근을 평가합니다.
|
||||
|
||||
**왜 있나요.** 가정 위에 만드는 것은 아무도 필요로 하지 않는 것을 만드는 가장 빠른 길입니다. 리서치는 개념을 현실에 연결합니다. 이미 어떤 경쟁자가 있는지, 사용자가 실제로 무엇에 어려움을 겪는지, 기술적으로 가능한지, 산업별 제약이 무엇인지 확인합니다.
|
||||
|
||||
**언제 쓰나요.** 낯선 도메인에 들어가거나, 경쟁자가 있을 것 같지만 아직 파악하지 않았거나, 검증하지 않은 기술 능력에 개념이 의존할 때 사용합니다. 하나만 실행해도, 둘을 조합해도, 세 가지를 모두 실행해도 됩니다. 각각 독립적으로 의미가 있습니다.
|
||||
|
||||
### 제품 개요
|
||||
|
||||
**무엇인가요.** 제품 개념의 1-2페이지 요약을 만드는 안내형 발견 세션입니다. AI는 협업형 비즈니스 분석가로서 비전, 대상 독자, 가치 제안, 범위를 표현하도록 돕습니다.
|
||||
|
||||
**왜 있나요.** 제품 개요는 계획으로 들어가는 가벼운 경로입니다. 전략적 비전을 구조화된 형식으로 포착해 PRD 작성에 직접 공급합니다. 이미 개념에 확신이 있을 때 가장 잘 맞습니다. 고객, 문제, 대략 만들고 싶은 것을 알고 있을 때 제품 개요가 그 생각을 정리하고 날카롭게 합니다.
|
||||
|
||||
**언제 쓰나요.** 개념이 비교적 명확하고 PRD를 만들기 전에 효율적으로 문서화하고 싶을 때 사용합니다. 방향에 확신이 있고 가정을 강하게 도전받을 필요가 없을 때 적합합니다.
|
||||
|
||||
### PRFAQ Working Backwards(워킹 백워드)
|
||||
|
||||
**무엇인가요.** Amazon의 워킹 백워드 방법론을 대화형 챌린지로 적용한 것입니다. 코드 한 줄이 존재하기 전에 완성된 제품을 발표하는 보도자료를 쓰고, 고객과 이해관계자가 물을 가장 어려운 질문에 답합니다. AI는 집요하지만 건설적인 제품 코치로 행동합니다.
|
||||
|
||||
**왜 있나요.** PRFAQ는 계획으로 들어가는 엄격한 경로입니다. 모든 주장을 방어하게 만들어 고객 우선의 명확성을 강제합니다. 설득력 있는 보도자료를 쓸 수 없다면 제품은 준비되지 않은 것입니다. 고객 FAQ 답변이 공백을 드러내면, 그 공백은 구현 중 훨씬 늦고 비싸게 발견했을 것입니다. 이 관문은 약한 생각을 가장 싸게 고칠 수 있는 초기에 드러냅니다.
|
||||
|
||||
**언제 쓰나요.** 리소스를 투입하기 전에 개념을 스트레스 테스트하고 싶을 때 사용합니다. 사용자가 실제로 관심을 가질지 확신이 없거나, 명확하고 방어 가능한 가치 제안을 말할 수 있는지 검증하고 싶을 때, 또는 워킹 백워드의 규율로 생각을 날카롭게 하고 싶을 때 적합합니다.
|
||||
|
||||
## 무엇을 사용해야 하나요?
|
||||
|
||||
| 상황 | 권장 도구 |
|
||||
| --- | --- |
|
||||
| "막연한 아이디어가 있는데 어디서 시작할지 모르겠어요" | 브레인스토밍 |
|
||||
| "결정하기 전에 시장을 이해해야 해요" | 리서치 |
|
||||
| "만들고 싶은 건 알아요. 문서화만 필요해요" | 제품 개요 |
|
||||
| "이 아이디어가 정말 만들 가치가 있는지 확인하고 싶어요" | PRFAQ |
|
||||
| "탐색하고, 검증하고, 문서화하고 싶어요" | 브레인스토밍 → 리서치 → PRFAQ 또는 제품 개요 |
|
||||
|
||||
제품 개요와 PRFAQ는 둘 다 PRD 입력을 만듭니다. 얼마나 강한 챌린지를 원하는지에 따라 고르세요. 제품 개요는 협업형 발견 과정이고, PRFAQ는 더 엄격한 검증 관문입니다. 둘 다 같은 목적지로 가지만 PRFAQ는 그 개념이 그 단계로 갈 준비가 되었는지 시험합니다.
|
||||
|
||||
:::tip[확실하지 않나요?]
|
||||
`bmad-help`를 실행하고 상황을 설명하세요. 이미 한 일과 달성하려는 것에 따라 적절한 시작점을 추천합니다.
|
||||
:::
|
||||
|
||||
## 분석 후에는 무엇이 일어나나요?
|
||||
|
||||
분석 출력은 단계 2(계획)로 직접 이어집니다. PRD 워크플로는 제품 개요, PRFAQ 문서, 리서치 발견 사항, 브레인스토밍 보고서를 입력으로 받아 사용자가 만든 모든 것을 구조화된 요구사항으로 종합합니다. 분석을 더 많이 할수록 PRD는 더 날카로워집니다.
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: "브레인스토밍"
|
||||
description: 60가지 이상의 검증된 아이디어 도출 기법을 활용한 참여형 창의 세션
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
안내에 따라 직접 탐색하며 창의력을 마음껏 펼쳐보세요.
|
||||
|
||||
## 브레인스토밍이란?
|
||||
|
||||
`bmad-brainstorming`을 실행하면 아이디어를 대신 만들어 주는 AI가 아니라, 당신 안의 아이디어를 끌어내는 창의 촉진자를 얻게 됩니다. AI는 코치와 가이드로 행동하며 검증된 기법을 사용해 최고의 생각이 떠오를 조건을 만듭니다.
|
||||
|
||||
**잘 맞는 경우:**
|
||||
|
||||
- 창의적 막힘 돌파
|
||||
- 제품 또는 기능 아이디어 생성
|
||||
- 새로운 각도에서 문제 탐색
|
||||
- 날것의 개념을 실행 계획으로 발전
|
||||
|
||||
## 작동 방식
|
||||
|
||||
1. **준비** - 주제, 목표, 제약 정의
|
||||
2. **접근 방식 선택** - 직접 기법을 고르거나, AI 추천을 받거나, 무작위로 진행하거나, 점진적 흐름을 따릅니다
|
||||
3. **진행** - 탐색 질문과 협업형 코칭으로 기법을 진행합니다
|
||||
4. **정리** - 아이디어를 주제로 묶고 우선순위를 정합니다
|
||||
5. **실행** - 핵심 아이디어에 다음 단계와 성공 지표를 연결합니다
|
||||
|
||||
모든 내용은 나중에 참고하거나 이해관계자와 공유할 수 있는 세션 문서에 기록됩니다.
|
||||
|
||||
:::note[당신의 아이디어]
|
||||
모든 아이디어는 당신에게서 나옵니다. 워크플로는 통찰이 생기는 조건을 만들 뿐입니다. 출처는 당신입니다.
|
||||
:::
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
---
|
||||
title: "체크포인트 미리보기"
|
||||
description: 목적에서 세부 사항에 이르기까지의 변경 과정을 단계별로 안내하는, LLM을 활용한 인간 중심 검토
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
`bmad-checkpoint-preview`는 LLM이 보조하는 대화형 human-in-the-loop 리뷰 워크플로입니다. 코드 변경을 목적과 컨텍스트에서 세부 사항까지 안내해, 출시할지, 다시 작업할지, 더 파고들지에 대해 충분한 정보를 바탕으로 판단할 수 있게 합니다.
|
||||
|
||||
|
||||
|
||||
## 일반적인 흐름
|
||||
|
||||
`bmad-quick-dev`를 실행합니다. 의도를 명확히 하고, 사양을 만들고, 변경을 구현합니다. 완료되면 사양 파일에 리뷰 경로를 붙이고 에디터에서 엽니다. 사양을 보니 여러 모듈에 걸쳐 20개 파일이 변경되었습니다.
|
||||
|
||||
diff를 눈으로 훑을 수도 있습니다. 하지만 20개 파일쯤 되면 눈대중 리뷰가 흔들리기 시작합니다. 흐름을 놓치고, 떨어진 두 변경 사이의 연결을 놓치거나, 충분히 이해하지 못한 것을 승인할 수 있습니다. 그래서 "checkpoint"라고 말하면 LLM이 변경을 따라가게 해 줍니다.
|
||||
|
||||
자율 구현에서 인간 판단으로 돌아오는 이 전환이 주된 사용 사례입니다. 빠른 개발은 최소 감독으로 오래 실행됩니다. 체크포인트 미리보기는 사용자가 다시 운전대를 잡는 지점입니다.
|
||||
|
||||
## 왜 존재하나요?
|
||||
|
||||
코드 리뷰에는 두 실패 모드가 있습니다. 하나는 리뷰어가 diff를 훑고 눈에 띄는 것이 없어 승인하는 경우입니다. 다른 하나는 모든 파일을 꼼꼼히 읽지만 흐름을 잃는 경우입니다. 나무는 보지만 숲을 놓칩니다. 둘 다 같은 결과를 낳습니다. 중요한 것을 잡지 못한 리뷰입니다.
|
||||
|
||||
근본 문제는 순서입니다. 원시 diff는 파일 순서로 변경을 보여주지만, 이 순서는 이해가 쌓이는 순서와 거의 일치하지 않습니다. 왜 필요한지 알기 전에 도우미 함수를 보고, 어떤 기능을 지원하는지 알기 전에 스키마 변경을 봅니다. 리뷰어는 흩어진 단서에서 작성자의 의도를 재구성해야 하고, 그 재구성 과정에서 집중력이 무너집니다.
|
||||
|
||||
체크포인트 미리보기는 재구성 작업을 LLM에게 맡겨 이 문제를 해결합니다. diff, 사양(있다면), 주변 코드베이스를 읽고 `git diff`가 아니라 이해를 위해 설계된 순서로 변경을 제시합니다.
|
||||
|
||||
## 작동 방식
|
||||
|
||||
워크플로는 다섯 단계입니다. 각 단계는 이전 단계 위에 쌓이며 "이게 뭐지?"에서 "출시해도 되나?"로 점진적으로 이동합니다.
|
||||
|
||||
### 1. 방향 잡기
|
||||
|
||||
워크플로는 변경(PR, 커밋, 브랜치, 사양 파일, 현재 Git 상태)을 식별하고 한 줄 의도 요약과 영역 통계를 생성합니다. 변경 파일 수, 건드린 모듈, 논리 줄 수, 경계 넘나듦, 새 공개 인터페이스 등입니다.
|
||||
|
||||
이 단계는 "내가 보고 있는 게 맞나?"를 확인하는 순간입니다. 코드를 읽기 전에 리뷰어는 올바른 것을 보고 있는지 확인하고 범위 기대치를 맞춥니다.
|
||||
|
||||
### 2. 둘러보기
|
||||
|
||||
변경은 파일이 아니라 **관심사** 기준으로 구성됩니다. "입력 검증"이나 "API 계약" 같은 응집력 있는 설계 의도입니다. 각 관심사에는 왜 이 접근을 택했는지 짧은 설명과 리뷰어가 코드에서 따라갈 수 있는 클릭 가능한 `path:line` 지점이 붙습니다.
|
||||
|
||||
이 단계는 설계 판단입니다. 리뷰어는 코드가 정확한지가 아니라 시스템에 맞는 접근인지 평가합니다. 관심사는 하향식으로 배치됩니다. 가장 높은 수준의 의도가 먼저 나오고 보조 구현이 뒤따릅니다. 리뷰어는 아직 보지 않은 것에 대한 참조를 만나지 않습니다.
|
||||
|
||||
### 3. 상세 검토
|
||||
|
||||
리뷰어가 설계를 이해한 뒤 워크플로는 실수했을 때 영향 범위가 가장 큰 2-5개 지점을 드러냅니다. 이들은 `[auth]`, `[schema]`, `[billing]`, `[public API]`, `[security]` 같은 위험 범주로 태그되고, 틀렸을 때 얼마나 많이 깨지는지 기준으로 정렬됩니다.
|
||||
|
||||
이것은 버그 찾기가 아닙니다. 자동화 테스트와 CI가 정확성을 다룹니다. 상세 검토는 위험 인식을 활성화합니다. "틀렸을 때 비용이 가장 큰 곳은 여기입니다." 특정 영역을 더 깊게 보고 싶다면 "이 영역을 더 파고들어 줘"라고 말해 정확성에 초점을 맞춘 재리뷰를 요청할 수 있습니다.
|
||||
|
||||
사양이 적대적 리뷰 루프를 거쳤다면 그 발견 사항도 여기서 드러납니다. 고쳐진 버그가 아니라, 리뷰 루프가 리뷰어가 알아야 한다고 표시한 결정입니다.
|
||||
|
||||
### 4. 테스트
|
||||
|
||||
변경이 작동하는 것을 수동으로 관찰하는 방법 2-5개를 제안합니다. 자동화 테스트 명령이 아니라 어떤 테스트 모음도 주지 못하는 확신을 만드는 수동 관찰입니다. 시도할 UI 상호작용, 실행할 CLI 명령, 보낼 API 요청과 각 예상 결과가 포함됩니다.
|
||||
|
||||
사용자에게 보이는 동작이 없다면 그렇다고 말합니다. 가짜 확인 작업은 만들지 않습니다.
|
||||
|
||||
### 5. 마무리
|
||||
|
||||
리뷰어가 결정을 내립니다. 승인, 재작업, 계속 논의 중 하나입니다. PR을 승인한다면 워크플로가 `gh pr review --approve`를 도울 수 있습니다. 재작업한다면 문제가 접근 방식, 사양, 구현 중 어디에서 왔는지 진단하고 특정 코드 위치와 연결된 실행 가능한 피드백 초안을 돕습니다.
|
||||
|
||||
## 보고서가 아니라 대화입니다
|
||||
|
||||
워크플로는 각 단계를 최종 답이 아니라 출발점으로 제시합니다. 단계 사이 또는 단계 도중에도 LLM과 대화하고, 질문하고, 구성 방식에 이의를 제기하고, 다른 스킬을 불러 다른 관점을 얻을 수 있습니다.
|
||||
|
||||
- **"오류 처리를 고급 도출로 다시 검토해 줘"** - 특정 영역 분석을 다시 생각하고 다듬게 합니다
|
||||
- **"이 스키마 마이그레이션이 안전한지 파티 모드로 토론해 줘"** - 집중 토론에 여러 에이전트 관점을 불러옵니다
|
||||
- **"코드 리뷰 실행"** - 적대적 리뷰와 엣지 케이스 분석을 포함한 구조화된 에이전트 기반 발견 사항을 생성합니다
|
||||
|
||||
체크포인트 워크플로는 선형 경로에 가두지 않습니다. 구조가 필요할 때는 구조를 주고, 탐색하고 싶을 때는 여지를 남깁니다. 다섯 단계는 전체 그림을 보게 하기 위한 것이지만, 각 단계에서 얼마나 깊게 들어갈지와 어떤 도구를 가져올지는 전적으로 사용자에게 달려 있습니다.
|
||||
|
||||
## 리뷰 경로
|
||||
|
||||
둘러보기 단계는 **권장 리뷰 순서**가 있을 때 가장 잘 작동합니다. 이는 사양 작성자가 리뷰어를 변경으로 안내하기 위해 쓴 지점 목록입니다. 사양에 이 정보가 있으면 워크플로가 그대로 사용합니다.
|
||||
|
||||
작성자가 만든 경로가 없으면 워크플로가 diff와 코드베이스 컨텍스트에서 생성합니다. 생성된 경로는 작성자가 만든 경로보다 품질이 낮지만, 파일 순서로 변경을 읽는 것보다는 훨씬 낫습니다.
|
||||
|
||||
## 사용 시점
|
||||
|
||||
주요 시나리오는 `bmad-quick-dev`에서의 인계입니다. 구현이 끝났고, 리뷰 경로가 붙은 사양 파일이 에디터에 열려 있으며, 출시 여부를 결정해야 합니다. "checkpoint"라고 말하면 됩니다.
|
||||
|
||||
단독으로도 동작합니다.
|
||||
|
||||
- **PR 리뷰** - 특히 몇 개 파일을 넘거나 여러 영역에 걸친 변경이 있을 때
|
||||
- **변경 온보딩** - 직접 작성하지 않은 브랜치에서 무슨 일이 있었는지 이해해야 할 때
|
||||
- **스프린트 리뷰** - 스프린트 상태 파일에서 `review`로 표시된 스토리를 집어올 수 있습니다
|
||||
|
||||
"checkpoint" 또는 "이 변경을 따라가며 설명해 줘"라고 호출하세요. 어떤 터미널에서도 작동하지만 IDE(VS Code, Cursor 등) 안에서 더 편하게 사용할 수 있습니다. 워크플로가 모든 단계에서 `path:line` 참조를 생성하고, IDE 내장 터미널에서는 이들이 클릭 가능하므로 리뷰 경로를 따라 파일 사이를 이동할 수 있습니다.
|
||||
|
||||
## 아닌 것
|
||||
|
||||
체크포인트 미리보기는 자동화 리뷰의 대체물이 아닙니다. 린터, 타입 검사기, 테스트 모음을 실행하지 않습니다. 심각도 점수를 붙이거나 통과/실패 결정을 만들지 않습니다. 사람이 가장 중요한 곳에 판단을 적용하도록 돕는 읽기 가이드입니다.
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
title: "기존 프로젝트 FAQ"
|
||||
description: 기존 프로젝트에서 BMad Method를 사용할 때의 일반 질문
|
||||
sidebar:
|
||||
order: 13
|
||||
---
|
||||
|
||||
BMad Method(BMM)로 기존 프로젝트에서 작업할 때 자주 묻는 질문에 빠르게 답합니다.
|
||||
|
||||
## 질문
|
||||
|
||||
- [프로젝트 문서화를 먼저 실행해야 하나요?](#프로젝트-문서화를-먼저-실행해야-하나요)
|
||||
- [프로젝트 문서화 실행을 잊었다면 어떻게 하나요?](#프로젝트-문서화-실행을-잊었다면-어떻게-하나요)
|
||||
- [기존 프로젝트에 빠른 흐름을 사용할 수 있나요?](#기존-프로젝트에-빠른-흐름을-사용할-수-있나요)
|
||||
- [기존 코드가 모범 사례를 따르지 않으면 어떻게 하나요?](#기존-코드가-모범-사례를-따르지-않으면-어떻게-하나요)
|
||||
|
||||
### 프로젝트 문서화를 먼저 실행해야 하나요?
|
||||
|
||||
특히 다음 상황에서는 강력히 권장합니다.
|
||||
|
||||
- 기존 문서가 없습니다
|
||||
- 문서가 오래되었습니다
|
||||
- AI 에이전트가 기존 코드에 대한 컨텍스트가 필요합니다
|
||||
|
||||
`docs/index.md`를 포함한 포괄적이고 최신 문서가 있거나, 에이전트가 기존 시스템을 바탕으로 작업할 만큼 다른 도구나 기법으로 충분한 발견 과정을 제공할 예정이라면 건너뛸 수 있습니다.
|
||||
|
||||
### 프로젝트 문서화 실행을 잊었다면 어떻게 하나요?
|
||||
|
||||
걱정하지 마세요. 언제든 실행할 수 있습니다. 프로젝트 도중이나 나중에 실행해 문서를 최신 상태로 유지할 수도 있습니다.
|
||||
|
||||
### 기존 프로젝트에 빠른 흐름을 사용할 수 있나요?
|
||||
|
||||
네. 빠른 흐름은 기존 프로젝트에서 잘 작동합니다. 다음을 수행합니다.
|
||||
|
||||
- 기존 기술 스택 자동 감지
|
||||
- 기존 코드 패턴 분석
|
||||
- 관례 감지 및 확인 요청
|
||||
- 기존 코드를 존중하는, 맥락이 충분히 담긴 사양 생성
|
||||
|
||||
기존 코드베이스의 버그 수정과 작은 기능에 특히 잘 맞습니다.
|
||||
|
||||
### 기존 코드가 모범 사례를 따르지 않으면 어떻게 하나요?
|
||||
|
||||
빠른 흐름은 관례를 감지하고 묻습니다. "이 기존 관례를 따를까요?" 사용자가 결정합니다.
|
||||
|
||||
- **예** → 현재 코드베이스와의 일관성 유지
|
||||
- **아니요** → 새 표준 수립(사양에 이유를 문서화)
|
||||
|
||||
BMM은 선택을 존중합니다. 현대화를 강제하지 않지만 필요한 제안은 합니다.
|
||||
|
||||
**여기에 답이 없는 질문이 있나요?** [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues)를 열거나 [Discord](https://discord.gg/gk8jAdXWmj)에서 물어보세요. 추가하겠습니다.
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
---
|
||||
title: "포렌식 조사"
|
||||
description: bmad-investigate가 모든 이슈를 현장처럼 다루고, 증거를 등급화하며, 엔지니어가 바로 행동할 수 있는 구조화된 사례 파일을 만드는 방법
|
||||
sidebar:
|
||||
order: 10
|
||||
---
|
||||
|
||||
`bmad-investigate`에 충돌 로그, 스택 추적, 또는 단순히 "예전엔 됐는데 지금은 안 돼요"를 건네면, 스킬은 실행되는 동안 조사자의 규율을 적용합니다. 바로 고치기 시작하지 않습니다. 사례 파일을 엽니다.
|
||||
|
||||
모든 발견 사항은 등급이 매겨집니다. 모든 가설은 상태를 가집니다. 잘못된 방향도 지우지 않고 남깁니다. 산출물은 다른 엔지니어가 아무 배경 없이 집어 들어도 이해할 수 있는 문서입니다.
|
||||
|
||||
이 페이지는 조사가 왜 별도의 규율인지, 그리고 일반 개발 워크플로가 주지 못하는 것을 이 스킬이 어떤 방식으로 제공하는지 설명합니다.
|
||||
|
||||
## "그냥 디버깅해"의 문제
|
||||
|
||||
일반 디버깅은 세 가지를 섞습니다. 증거를 보고, 원인을 추론하고, 이론을 시험하기 위해 코드를 바꿉니다. 이것들이 섞이면 두 가지 실패 모드가 나타납니다.
|
||||
|
||||
첫 번째는 **서사 고착**입니다. 처음 그럴듯한 이야기가 작업 가설이 되고, 모든 관찰이 거기에 맞춰 끼워집니다. 누군가 포기하고 처음부터 다시 시작할 때까지 버그는 고쳐지지 않습니다. 몇 시간 뒤에야 말입니다.
|
||||
|
||||
두 번째는 **증거 망각**입니다. 무언가를 추적하고 배제했지만 왜 배제했는지 적지 않았습니다. 이틀 뒤 새로운 눈으로 같은 것을 다시 추적합니다. 더 나쁘게는 동료가 버그를 넘겨받아 이미 제거한 막다른 경로를 다시 실행합니다.
|
||||
|
||||
이 스킬의 설계는 이 둘에 대한 직접적인 응답입니다.
|
||||
|
||||
## 증거 등급화
|
||||
|
||||
조사의 모든 발견 사항은 세 가지 중 하나입니다.
|
||||
|
||||
- **Confirmed(확인됨).** 로그, 코드, 덤프에서 직접 관찰되었고 특정 참조(`path:line`, 로그 타임스탬프, 커밋 해시)로 인용됩니다. 누군가 "어떻게 알아?"라고 물으면 인용을 가리킵니다.
|
||||
- **Deduced(추론됨).** 확인된 증거에서 논리적으로 따릅니다. 추론 사슬이 표시됩니다. 사슬의 한 단계가 틀리면 추론도 틀리고, 어느 단계인지 볼 수 있습니다.
|
||||
- **Hypothesized(가설).** 그럴듯하지만 확인되지 않았습니다. 무엇이 확인하거나 반박할지와 무엇이 닫을지를 미리 선언합니다. 가설은 명시적으로 *사실이 아닙니다*.
|
||||
|
||||
등급화는 겸손해 보이기 위한 것이 아닙니다. 사례 파일을 읽을 수 있게 만들기 위한 것입니다. 독자는 `Confirmed` 섹션에서 무엇이 사실인지, `Deduced` 섹션에서 무엇이 따라오는지, `Hypothesized` 섹션에서 무엇이 아직 열려 있는지 훑어볼 수 있습니다. 이 셋의 혼동이 조사가 빙빙 도는 가장 흔한 이유입니다.
|
||||
|
||||
## 기준점 먼저 확보하기
|
||||
|
||||
조사는 이론에서 시작하지 않습니다. 하나의 확인된 증거에서 시작해 바깥으로 확장합니다. 그 기준점은 특정 오류 메시지, 스택 프레임, 타임스탬프가 있는 로그 항목일 수 있습니다.
|
||||
|
||||
이는 흔한 조사 방식과 반대입니다. 누군가 직감을 갖고 이론을 세운 뒤 그것을 지지하는 증거를 찾습니다. 직감이 맞을 수도 있지만, 그 *방법*은 확증 편향을 기본값으로 만들기 때문에 취약합니다.
|
||||
|
||||
기준점은 추론이 흐려질 때 돌아갈 수 있는 사실입니다. 추론이 이상한 곳으로 가면 기준점까지 되돌아가 다른 갈래를 시도할 수 있습니다. 기준점이 없으면 어느 단계를 되돌려야 하는지 알 수 없습니다.
|
||||
|
||||
증거가 부족하면 스킬은 그렇게 말하고 가설 주도 탐색으로 전환합니다. 가능한 것에서 가설을 만들고, 각각을 시험할 증거를 식별하며, 우선순위가 있는 데이터 수집 목록을 제시합니다. 빠진 증거 자체도 발견 사항입니다.
|
||||
|
||||
## 가설 규율
|
||||
|
||||
가설은 사례 파일에서 절대 삭제되지 않습니다. 증거가 확인하거나 반박하면 **Status** 필드가 `Open`에서 `Confirmed` 또는 `Refuted`로 바뀌고, 어떤 증거가 결론을 냈는지 **Resolution**이 설명합니다.
|
||||
|
||||
이 규칙에는 비용이 있습니다. 사례 파일이 길어집니다. 하지만 이점도 큽니다. 전체 추론 이력이 산출물의 일부가 됩니다. 여섯 달 뒤 비슷한 버그가 나타나면 다음 조사자는 원래 사례 파일을 읽고 어떤 경로가 이미 제거되었고 왜 그런지 볼 수 있습니다. 그 이력이 없으면 새 조사자마다 같은 막다른 경로를 다시 실행합니다.
|
||||
|
||||
현재의 조사자에게도 규율을 부여합니다. 틀린 가설을 지울 수 없다면, 인용된 증거로 반박해야 합니다. 불편해졌다고 조용히 떨어뜨리는 선택지는 사라집니다.
|
||||
|
||||
## 전제에 도전하기
|
||||
|
||||
사용자의 문제 설명은 사실이 아니라 가설입니다. "캐시가 깨졌다"는 사용자가 *믿는 것*입니다. 스킬은 그 전제를 중심으로 조사를 세우기 전에 기술적 주장을 독립적으로 검증합니다. 증거가 전제와 모순되면 보고서가 직접 그렇게 말합니다.
|
||||
|
||||
이것이 포렌식 감각입니다. 목격자 진술은 데이터이지 진실이 아닙니다. 때로 보고된 버그는 진짜지만 이름표가 틀립니다. 때로 설명된 증상은 다른 원인의 파생 결과입니다. 전제를 절대적 진실로 받아들이는 조사는 잘못된 결함을 진단하고, 버그는 약간 다른 형태로 돌아옵니다.
|
||||
|
||||
## 보정된 진행
|
||||
|
||||
스킬은 두 가지 모드가 아니라 하나의 절차입니다. 입력이 요구하는 결함 추적과 영역 탐색의 비율을 계속 보정합니다.
|
||||
|
||||
증상 기반 사례(티켓, 충돌, 오류 메시지, "예전엔 됐다")는 가설 추적, 타임라인 재구성, 수정 방향에 기울어집니다. 증상 없는 사례(만지기 전 모듈 이해, 재사용성 평가, 정신 모델 구축)는 I/O 매핑, 제어 흐름 필터링, 검증 계획에 기울어집니다. 실제 사례 대부분은 그 사이 어딘가에 있고, 사례 파일은 증거가 요구한 균형을 반영합니다.
|
||||
|
||||
사례가 어디에 있든 원칙은 같습니다. 먼저 기준점 확보, 증거 등급화, 가설 추적, 절대 지우지 않기입니다. 출력은 항상 `{implementation_artifacts}/investigations/{slug}-investigation.md`이며, 해당 사례에 적용되지 않는 섹션은 비어 있거나 생략됩니다.
|
||||
|
||||
깊은 버그가 더 넓은 하위 시스템 이해를 요구할 때 절차는 I/O 매핑, 제어 흐름 필터링, 출력에서 역추적하기, 구성 요소 간 경계 추적 기법을 한 흐름 안에 통합합니다. 영역 모델은 같은 사례 파일에 들어갑니다. 모드 전환은 없습니다.
|
||||
|
||||
## 방법론은 스킬 안에 있습니다
|
||||
|
||||
조사자의 원칙은 스킬 자체의 속성입니다. `bmad-investigate`를 호출한 사람은 실행되는 동안 방법론과 커뮤니케이션 스타일을 채택합니다. 냉정한 정확성, 증거 우선 언어, 회피 없는 표현, 사례 파일 중심의 구성입니다. 스킬이 끝나면 호출자는 이전 말투로 돌아갑니다. 페르소나 교체가 아니라 스킬 원칙에서 오는 말투 전환입니다.
|
||||
|
||||
조사와 구현은 서로 다른 감각을 보상하기 때문에 중요합니다. 조사자는 느리고 정확합니다. 구현자는 빠르고 자신감 있습니다. 같은 세션에서 둘을 모두 하려 하면 둘 다 애매해지는 경향이 있습니다. 스킬은 별도 정체성으로 컨텍스트를 전환하지 않고, 진행 흐름 안에서 조사자의 태도를 적용합니다.
|
||||
|
||||
## 얻는 것
|
||||
|
||||
완성된 조사 파일:
|
||||
|
||||
- `Confirmed` 발견 사항(인용 포함)을 `Deductions` 및 `Hypotheses`와 분리합니다
|
||||
- 형성된 모든 가설을 최종 `Status`와 `Resolution`과 함께 보존합니다
|
||||
- 여러 증거 소스에서 이벤트 타임라인을 재구성합니다
|
||||
- 데이터 공백과 그것이 무엇을 해결할지 식별합니다
|
||||
- 증거에 기반한 실행 가능한 결론을 제공합니다
|
||||
- 근본 원인이 식별되면 재현 계획을 포함합니다
|
||||
- 아직 탐색할 경로의 조사 백로그를 유지합니다
|
||||
|
||||
그 자리에 없던 엔지니어에게 건네도 무슨 일이 있었고, 무엇을 알고 있으며, 무엇이 아직 불확실한지 이해해야 합니다. 기준은 그것입니다.
|
||||
|
||||
## 더 큰 아이디어
|
||||
|
||||
오늘날 대부분의 "AI 디버깅"은 증거, 추론, 코드 변경을 그럴듯한 텍스트의 한 흐름으로 섞습니다. 신호는 찾기 어렵고, 막다른 경로는 반복되며, 사례 파일이 있더라도 아무도 읽고 싶지 않은 채팅 로그처럼 보이는 경우가 많습니다.
|
||||
|
||||
`bmad-investigate`는 조사를 고유한 산출물이 있는 규율로 다룹니다. 증거에는 등급이 있습니다. 가설에는 상태가 있습니다. 잘못된 방향은 지워지지 않고 문서화됩니다. 사례 파일은 세션보다 오래 살아남습니다.
|
||||
|
||||
이미 본 적 있는 것처럼 보이는 다음 버그가 나타났을 때, 빈 프롬프트가 아니라 시작할 곳이 생깁니다.
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
---
|
||||
title: "이름 있는 에이전트"
|
||||
description: BMad 에이전트가 이름, 페르소나, 커스터마이징 영역을 갖는 이유와 메뉴 기반 또는 프롬프트 기반 대안보다 무엇을 가능하게 하는지
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
"Mary, 브레인스토밍하자"라고 말하면 Mary가 활성화됩니다. 그녀는 설정한 언어로 당신의 이름을 부르고, 고유한 페르소나로 인사합니다. `bmad-help`가 언제나 가능하다고 알려줍니다. 그리고 의도가 명확했기 때문에 메뉴를 건너뛰고 바로 브레인스토밍으로 들어갑니다.
|
||||
|
||||
이 페이지는 실제로 무엇이 일어나고 있고 왜 BMad가 이렇게 설계되었는지 설명합니다.
|
||||
|
||||
## 세 축
|
||||
|
||||
BMad의 에이전트 모델은 서로 조합되는 세 가지 기본 요소 위에 놓여 있습니다.
|
||||
|
||||
| 기본 요소 | 제공하는 것 | 위치 |
|
||||
| --- | --- | --- |
|
||||
| **스킬** | 기능 - 어시스턴트가 할 수 있는 구체적인 일(브레인스토밍, PRD 초안 작성, 스토리 구현) | `.claude/skills/{skill-name}/SKILL.md` 또는 IDE별 동등 경로 |
|
||||
| **이름 있는 에이전트** | 페르소나의 연속성 - 일관된 목소리, 원칙, 시각적 단서로 관련 스킬 메뉴를 묶는 알아볼 수 있는 정체성 | 디렉터리가 `bmad-agent-*`로 시작하는 스킬 |
|
||||
| **커스터마이징** | 우리 방식으로 맞추기 - 에이전트 동작을 재구성하고, MCP 통합을 추가하고, 템플릿을 교체하고, 조직 관례를 겹쳐 적용하는 오버라이드 | `_bmad/custom/{skill-name}.toml`(팀 오버라이드) 및 `.user.toml`(개인, git에서 무시됨) |
|
||||
|
||||
세 요소 중 하나라도 빠지면 경험이 무너집니다.
|
||||
|
||||
- 에이전트 없는 스킬 → 사용자가 이름이나 코드로 탐색해야 하는 기능 목록
|
||||
- 스킬 없는 에이전트 → 할 일이 없는 페르소나
|
||||
- 커스터마이징 없음 → 모든 사용자가 같은 기본 제공 동작을 받고, 조직별 필요에는 포크를 강요받음
|
||||
|
||||
## 이름 있는 에이전트가 주는 것
|
||||
|
||||
BMad는 BMad Method의 단계에 맞춘 여섯 이름 있는 에이전트를 제공합니다.
|
||||
|
||||
| 에이전트 | 단계 | 모듈 |
|
||||
| --- | --- | --- |
|
||||
| 📊 **Mary**, 비즈니스 분석가 | 분석 | 시장 조사, 브레인스토밍, 제품 개요, PRFAQ |
|
||||
| 📚 **Paige**, 기술 작성자 | 분석 | 프로젝트 문서화, 다이어그램, 문서 검증 |
|
||||
| 📋 **John**, 제품 관리자 | 계획 | PRD 작성, 에픽/스토리 분해, 구현 준비 상태 점검 |
|
||||
| 🎨 **Sally**, UX 디자이너 | 계획 | UX 설계 사양 |
|
||||
| 🏗️ **Winston**, 시스템 아키텍트 | 솔루션 설계 | 기술 아키텍처, 정렬 점검 |
|
||||
| 💻 **Amelia**, 시니어 엔지니어 | 구현 | 스토리 실행, 빠른 개발, 코드 리뷰, 스프린트 계획 |
|
||||
|
||||
각 에이전트는 하드코딩된 정체성(이름, 역할명, 도메인)과 커스터마이즈 가능한 계층(역할, 원칙, 커뮤니케이션 스타일, 아이콘, 메뉴)을 가집니다. Mary의 원칙을 다시 쓰거나 메뉴 항목을 추가할 수는 있지만 이름을 바꿀 수는 없습니다. 이는 의도적입니다. 이름 인식은 커스터마이징 후에도 유지되므로, 팀이 Mary의 동작을 어떻게 조정했든 "Mary"는 항상 분석가를 활성화합니다.
|
||||
|
||||
## 활성화 흐름
|
||||
|
||||
이름 있는 에이전트를 호출하면 여덟 단계가 순서대로 실행됩니다.
|
||||
|
||||
1. **에이전트 블록 해석** - 제공된 `customize.toml`을 팀 및 개인 오버라이드와 병합합니다. Python 병합 스크립트가 표준 라이브러리 `tomllib`을 사용합니다
|
||||
2. **사전 단계 실행** - 팀이 설정한 사전 동작
|
||||
3. **페르소나 채택** - 하드코딩된 정체성과 커스터마이즈된 역할, 커뮤니케이션 스타일, 원칙
|
||||
4. **지속 사실 로드** - 조직 규칙, 컴플라이언스 메모, `file:` 접두사로 로드되는 파일(예: `file:{project-root}/docs/project-context.md`)
|
||||
5. **설정 로드** - 사용자 이름, 커뮤니케이션 언어, 출력 언어, 산출물 경로
|
||||
6. **인사** - 설정 언어로 개인화된 인사를 하고, 누가 말하는지 한눈에 보이도록 에이전트 이모지 접두사를 포함합니다
|
||||
7. **추가 단계 실행** - 팀이 설정한 인사 후 설정
|
||||
8. **바로 실행 또는 메뉴 표시** - 첫 메시지가 메뉴 항목에 매핑되면 바로 이동하고, 아니면 메뉴를 보여주고 입력을 기다립니다
|
||||
|
||||
8단계는 의도와 기능이 만나는 곳입니다. "Mary, 브레인스토밍하자"는 `bmad-brainstorming`이 Mary 메뉴의 `BP`와 명확히 맞으므로 메뉴 표시를 건너뜁니다. 모호하게 말하면 확인 절차가 아니라 한 번 짧게 묻습니다. 맞는 것이 없으면 일반 대화를 계속합니다.
|
||||
|
||||
## 왜 그냥 메뉴가 아닌가요?
|
||||
|
||||
메뉴는 사용자가 도구에 반쯤 맞춰야 합니다. 브레인스토밍이 PM 에이전트가 아니라 분석가 에이전트의 `BP` 코드 아래 있다는 것을 기억하고, 어떤 페르소나가 어떤 기능을 갖는지 알아야 합니다. 도구가 사용자에게 떠넘기는 인지 부담입니다.
|
||||
|
||||
이름 있는 에이전트는 이를 뒤집습니다. 자연스러운 말로 원하는 것을 누구에게 할지 말합니다. 에이전트는 자신이 누구이고 무엇을 하는지 압니다. 의도가 충분히 명확하면 그냥 진행합니다.
|
||||
|
||||
메뉴는 여전히 대체 경로로 있습니다. 탐색할 때는 보여주고, 필요 없을 때는 건너뜁니다.
|
||||
|
||||
## 왜 그냥 빈 프롬프트가 아닌가요?
|
||||
|
||||
빈 프롬프트는 사용자가 마법 단어를 안다고 가정합니다. "브레인스토밍을 도와줘"는 될 수 있지만 "내 SaaS 아이디어를 같이 발전시켜 보자"는 안 될 수 있고, 결과는 표현 방식에 의존합니다. 사용자가 프롬프트 엔지니어링을 책임지게 됩니다.
|
||||
|
||||
이름 있는 에이전트는 자유를 닫지 않고 구조를 더합니다. 페르소나는 일관되고, 기능은 발견 가능하며, `bmad-help`는 항상 한 명령 거리에 있습니다. 에이전트가 무엇을 할 수 있는지 추측할 필요도, 사용 설명서가 필요하지도 않습니다.
|
||||
|
||||
## 커스터마이징은 일급 기능입니다
|
||||
|
||||
커스터마이징 모델이 있어야 이 방식이 개별 개발자를 넘어 확장됩니다.
|
||||
|
||||
모든 에이전트는 합리적인 기본값이 담긴 `customize.toml`을 제공합니다. 팀은 `_bmad/custom/bmad-agent-{role}.toml`에 오버라이드를 커밋합니다. 개인은 `.user.toml`(git에서 무시됨)에 개인 선호를 겹쳐 적용할 수 있습니다. 병합 스크립트는 활성화 시점에 세 파일을 예측 가능한 구조 규칙으로 병합합니다.
|
||||
|
||||
대부분의 사용자는 이 파일을 직접 작성하지 않습니다. `bmad-customize` 스킬은 대상을 고르고, 에이전트와 워크플로 중 범위를 선택하고, 오버라이드를 작성하고, 병합을 검증하는 과정을 안내합니다. 그래서 TOML에 익숙한 사람만이 아니라 자신의 의도를 이해하는 누구나 커스터마이징 영역에 접근할 수 있습니다.
|
||||
|
||||
구체적 예: 팀이 Amelia에게 라이브러리 문서는 항상 Context7 MCP 도구를 사용하고 로컬 에픽 목록에 스토리가 없으면 Linear를 대체 경로로 사용하라고 하는 단일 파일을 커밋합니다. Amelia가 실행하는 모든 개발 워크플로(dev-story, quick-dev, create-story, code-review)가 소스 편집이나 워크플로별 중복 없이 이 동작을 상속합니다.
|
||||
|
||||
교차 관심사를 위한 두 번째 커스터마이징 영역도 있습니다. 중앙 `_bmad/config.toml`과 `_bmad/config.user.toml`(둘 다 설치 프로그램 소유, 각 모듈의 `module.yaml`에서 재구성됨), 그리고 오버라이드용 `_bmad/custom/config.toml`(팀, 커밋됨)과 `_bmad/custom/config.user.toml`(개인, git에서 무시됨)입니다. 여기에 **에이전트 명단**이 있습니다. `bmad-party-mode`, `bmad-retrospective`, `bmad-advanced-elicitation`처럼 명단을 사용하는 스킬이 누가 가능하고 어떻게 표현될지 알기 위해 읽는 가벼운 설명자입니다. 팀 오버라이드로 에이전트를 조직 전체에서 다시 표현하고, `.user.toml` 오버라이드로 가상 목소리(Kirk, Spock, 도메인 전문가 페르소나)를 개인 실험으로 추가할 수 있습니다. 스킬 폴더를 건드리지 않습니다. 스킬별 파일은 Mary가 활성화될 때 *어떻게 행동하는지*를 조정하고, 중앙 설정은 다른 스킬이 명단에서 Mary를 *어떻게 보는지*를 조정합니다.
|
||||
|
||||
전체 커스터마이징 영역과 작동 예시는 다음을 참고하세요.
|
||||
|
||||
- [BMad 커스터마이징 방법](../how-to/customize-bmad.md) - 무엇을 커스터마이즈할 수 있고 병합이 어떻게 동작하는지의 참조
|
||||
- [조직을 위해 BMad 확장하기](../how-to/expand-bmad-for-your-org.md) - 에이전트 전반 규칙, 워크플로 관례, 외부 게시, 템플릿 교체, 에이전트 명단 커스터마이징을 다루는 실전 레시피
|
||||
- `bmad-customize` 스킬 - 의도를 올바른 위치의 검증된 오버라이드 파일로 바꿔 주는 안내형 작성 도우미
|
||||
|
||||
## 더 큰 아이디어
|
||||
|
||||
오늘날 대부분의 AI 어시스턴트는 메뉴이거나 프롬프트입니다. 둘 다 인지 부하를 사용자에게 넘깁니다. 이름 있는 에이전트와 커스터마이즈 가능한 스킬은 이미 일을 아는 팀원과 대화하게 해 주고, 조직이 포크 없이 그 팀원을 조정하게 합니다.
|
||||
|
||||
다음에 "Mary, 브레인스토밍하자"라고 입력했을 때 그녀가 바로 진행한다면, 무엇이 일어나지 않았는지 보세요. 슬래시 명령도, 탐색해야 할 메뉴도, 그녀가 무엇을 할 수 있는지 어색하게 상기시키는 일도 없었습니다. 바로 그 부재가 설계의 핵심입니다.
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
---
|
||||
title: "파티 모드"
|
||||
description: 다중 에이전트 협업 - 모든 AI 에이전트를 하나의 대화에 모읍니다
|
||||
sidebar:
|
||||
order: 11
|
||||
---
|
||||
|
||||
모든 AI 에이전트를 하나의 대화에 모으세요.
|
||||
|
||||
## 파티 모드란?
|
||||
|
||||
`bmad-party-mode`를 실행하면 PM, 아키텍트, 개발자, UX 디자이너 등 필요한 AI 팀 전체가 한 방에 모입니다. BMad Master가 조율하고 메시지마다 관련 에이전트를 선택합니다. 에이전트들은 각 페르소나에 맞게 답하고, 동의하거나 반대하며, 서로의 아이디어를 이어받아 발전시킵니다.
|
||||
|
||||
대화는 원하는 만큼 계속됩니다. 후속 질문을 묻고, 답에 반박하고, 토론 방향을 바꿀 수 있습니다. 끝날 때까지 에이전트들과 실제 주고받는 대화를 합니다.
|
||||
|
||||
**잘 맞는 경우:**
|
||||
|
||||
- 절충이 필요한 큰 결정
|
||||
- 브레인스토밍 세션
|
||||
- 문제가 생겼을 때의 사후 분석
|
||||
- 스프린트 회고와 계획
|
||||
|
||||
## 예시
|
||||
|
||||
### 나쁜 아키텍처 지적하기
|
||||
|
||||
**사용자:** "좋아요 팀, 지난 스프린트는 엉망이었어요. 인증 서비스가 세 번이나 내려갔습니다. 어디서 문제가 생겼나요?"
|
||||
|
||||
**아키텍트:** "설계 자체는 건전했습니다. 분산 인증과 적절한 대체 경로가 있었죠. 구현이 사양에서 벗어났다면..."
|
||||
|
||||
**개발자:** "저는 아키텍처 문서를 그대로 따랐습니다. 사양이 동시 세션 무효화 경쟁 조건을 다루지 않았어요."
|
||||
|
||||
**PM:** "두 분 모두 더 큰 이슈를 놓쳤습니다. PRD에서 세션 관리 요구사항을 검증하지 않았어요. 그걸 잡지 못한 건 제 책임입니다."
|
||||
|
||||
**TEA:** "통합 테스트에서 제가 잡았어야 했습니다. 테스트 시나리오가 동시 무효화를 다루지 않았어요."
|
||||
|
||||
### 창의적 브레인스토밍
|
||||
|
||||
**사용자:** "온보딩이 지루하지 않고 특별하게 느껴지게 하려면 어떻게 해야 할까요?"
|
||||
|
||||
**UX 디자이너:** "점진적 공개부터 시작하세요. 기능을 튜토리얼에서 한꺼번에 보여주지 말고, 사용자가 필요로 할 때 드러내는 겁니다."
|
||||
|
||||
**스토리텔러:** "온보딩이 하나의 이야기라면 어떨까요? 각 단계가 캐릭터의 여정을 드러내고, 사용자가 바로 그 주인공이 되는 겁니다."
|
||||
|
||||
**게임 디자이너:** "그 아이디어를 이어가 보죠. 첫 번째 '퀘스트'가 실제 사용자 문제를 해결하는 일이라면 어떨까요? 사용자는 가치 있는 일을 해내며 배웁니다."
|
||||
|
||||
### 기술 결정
|
||||
|
||||
**사용자:** "MVP에는 모놀리스가 좋을까요, 마이크로서비스가 좋을까요?"
|
||||
|
||||
**아키텍트:** "모놀리스로 시작하세요. 사용자 1,000명 규모에서는 마이크로서비스가 필요 없는 복잡성을 더합니다."
|
||||
|
||||
**PM:** "동의합니다. 이론적인 확장성보다 출시 속도가 더 중요합니다."
|
||||
|
||||
**개발자:** "명확한 모듈 경계를 둔 모놀리스가 좋겠습니다. 필요해지면 나중에 서비스를 분리할 수 있습니다."
|
||||
|
||||
:::tip[더 나은 결정]
|
||||
다양한 관점을 통해 더 나은 결정을 내립니다. 파티 모드에 오신 것을 환영합니다.
|
||||
:::
|
||||
|
|
@ -0,0 +1,121 @@
|
|||
---
|
||||
title: "에이전트 충돌 방지"
|
||||
description: 여러 에이전트가 시스템을 구현할 때 아키텍처가 충돌을 방지하는 방법
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
여러 AI 에이전트가 시스템의 서로 다른 부분을 구현하면 충돌하는 기술 결정을 내릴 수 있습니다. 아키텍처 문서화는 공유 표준을 세워 이를 방지합니다.
|
||||
|
||||
## 일반적인 충돌 유형
|
||||
|
||||
### API 스타일 충돌
|
||||
|
||||
아키텍처가 없으면:
|
||||
|
||||
- 에이전트 A는 REST와 `/users/{id}`를 사용합니다
|
||||
- 에이전트 B는 GraphQL 뮤테이션을 사용합니다
|
||||
- 결과: 일관되지 않은 API 패턴과 혼란스러운 API 사용 경험
|
||||
|
||||
아키텍처가 있으면:
|
||||
|
||||
- ADR이 명시합니다. "모든 클라이언트-서버 통신에는 GraphQL을 사용"
|
||||
- 모든 에이전트가 같은 패턴을 따릅니다
|
||||
|
||||
### 데이터베이스 설계 충돌
|
||||
|
||||
아키텍처가 없으면:
|
||||
|
||||
- 에이전트 A는 snake_case 컬럼명을 사용합니다
|
||||
- 에이전트 B는 camelCase 컬럼명을 사용합니다
|
||||
- 결과: 일관되지 않은 스키마와 혼란스러운 쿼리
|
||||
|
||||
아키텍처가 있으면:
|
||||
|
||||
- 표준 문서가 이름 규칙을 명시합니다
|
||||
- 모든 에이전트가 같은 패턴을 따릅니다
|
||||
|
||||
### 상태 관리 충돌
|
||||
|
||||
아키텍처가 없으면:
|
||||
|
||||
- 에이전트 A는 전역 상태에 Redux를 사용합니다
|
||||
- 에이전트 B는 React 컨텍스트를 사용합니다
|
||||
- 결과: 여러 상태 관리 방식과 복잡성
|
||||
|
||||
아키텍처가 있으면:
|
||||
|
||||
- ADR이 상태 관리 방식을 명시합니다
|
||||
- 모든 에이전트가 일관되게 구현합니다
|
||||
|
||||
## 아키텍처가 충돌을 방지하는 방법
|
||||
|
||||
### 1. ADR을 통한 명시적 결정
|
||||
|
||||
모든 중요한 기술 선택은 다음과 함께 문서화됩니다.
|
||||
|
||||
- 컨텍스트(왜 이 결정이 중요한가)
|
||||
- 고려한 대안(어떤 선택지가 있는가)
|
||||
- 결정(무엇을 선택했는가)
|
||||
- 근거(왜 선택했는가)
|
||||
- 결과(받아들인 절충)
|
||||
|
||||
### 2. FR/NFR별 지침
|
||||
|
||||
아키텍처는 각 기능 요구사항을 기술적 접근에 연결합니다.
|
||||
|
||||
- FR-001: 사용자 관리 → GraphQL 뮤테이션
|
||||
- FR-002: 모바일 앱 → 최적화된 쿼리
|
||||
|
||||
### 3. 표준과 관례
|
||||
|
||||
다음을 명시적으로 문서화합니다.
|
||||
|
||||
- 디렉터리 구조
|
||||
- 이름 규칙
|
||||
- 코드 구성
|
||||
- 테스트 패턴
|
||||
|
||||
## 공유 컨텍스트로서의 아키텍처
|
||||
|
||||
아키텍처를 구현 전 모든 에이전트가 읽는 공유 컨텍스트로 생각하세요.
|
||||
|
||||
```text
|
||||
PRD: "무엇을 만들 것인가"
|
||||
↓
|
||||
아키텍처: "어떻게 만들 것인가"
|
||||
↓
|
||||
에이전트 A가 아키텍처를 읽음 → 에픽 1 구현
|
||||
에이전트 B가 아키텍처를 읽음 → 에픽 2 구현
|
||||
에이전트 C가 아키텍처를 읽음 → 에픽 3 구현
|
||||
↓
|
||||
결과: 일관된 구현
|
||||
```
|
||||
|
||||
## 주요 ADR 주제
|
||||
|
||||
충돌을 방지하는 일반적인 결정:
|
||||
|
||||
| 주제 | 예시 결정 |
|
||||
| --- | --- |
|
||||
| API 스타일 | GraphQL vs REST vs gRPC |
|
||||
| 데이터베이스 | PostgreSQL vs MongoDB |
|
||||
| 인증 | JWT vs 세션 |
|
||||
| 상태 관리 | Redux vs 컨텍스트 vs Zustand |
|
||||
| 스타일링 | CSS Modules vs Tailwind vs Styled Components |
|
||||
| 테스트 | Jest + Playwright vs Vitest + Cypress |
|
||||
|
||||
## 피해야 할 안티패턴
|
||||
|
||||
:::caution[흔한 실수]
|
||||
- **암묵적 결정** - "API 스타일은 하면서 정하자"는 태도는 일관성 부족으로 이어집니다
|
||||
- **과도한 문서화** - 모든 사소한 선택을 문서화하면 분석 마비가 생깁니다
|
||||
- **오래된 아키텍처** - 한 번 쓰고 업데이트하지 않은 문서는 에이전트가 오래된 패턴을 따르게 합니다
|
||||
:::
|
||||
|
||||
:::tip[올바른 접근]
|
||||
- 에픽 경계를 넘는 결정을 문서화하세요
|
||||
- 충돌이 생기기 쉬운 영역에 집중하세요
|
||||
- 배운 것을 반영해 아키텍처를 업데이트하세요
|
||||
- 중요한 변경에는 `bmad-correct-course`를 사용하세요
|
||||
:::
|
||||
|
|
@ -0,0 +1,160 @@
|
|||
---
|
||||
title: "프로젝트 컨텍스트"
|
||||
description: project-context.md가 프로젝트 규칙과 선호도로 AI 에이전트를 안내하는 방법
|
||||
sidebar:
|
||||
order: 12
|
||||
---
|
||||
|
||||
`project-context.md` 파일은 AI 에이전트를 위한 프로젝트 구현 가이드입니다. 다른 개발 체계의 "헌장"처럼 모든 워크플로에서 일관된 코드 생성을 보장하는 규칙, 패턴, 선호 사항을 포착합니다.
|
||||
|
||||
## 하는 일
|
||||
|
||||
AI 에이전트는 구현 중 계속 결정을 내립니다. 어떤 패턴을 따를지, 코드를 어떻게 구조화할지, 어떤 관례를 사용할지 등입니다. 명확한 안내가 없으면 다음이 일어날 수 있습니다.
|
||||
|
||||
- 코드베이스와 맞지 않는 범용 모범 사례를 따릅니다
|
||||
- 스토리마다 일관되지 않은 결정을 내립니다
|
||||
- 프로젝트별 요구사항이나 제약을 놓칩니다
|
||||
|
||||
`project-context.md` 파일은 에이전트가 알아야 할 것을 간결하고 LLM에 최적화된 형식으로 문서화해 이 문제를 해결합니다.
|
||||
|
||||
## 작동 방식
|
||||
|
||||
모든 구현 워크플로는 `project-context.md`가 있으면 자동으로 로드합니다. 아키텍트 워크플로도 아키텍처를 설계할 때 기술 선호 사항을 존중하기 위해 이 파일을 로드합니다.
|
||||
|
||||
**이 워크플로들이 로드합니다:**
|
||||
|
||||
- `bmad-create-architecture` - 솔루션 설계 중 기술 선호 사항을 존중합니다
|
||||
- `bmad-create-story` - 프로젝트 패턴으로 스토리 작성을 안내합니다
|
||||
- `bmad-dev-story` - 구현 결정을 안내합니다
|
||||
- `bmad-code-review` - 프로젝트 표준과 비교해 검증합니다
|
||||
- `bmad-quick-dev` - 사양을 구현할 때 패턴을 적용합니다
|
||||
- `bmad-sprint-planning`, `bmad-retrospective`, `bmad-correct-course` - 프로젝트 전반의 컨텍스트를 제공합니다
|
||||
|
||||
## 언제 만들까요?
|
||||
|
||||
`project-context.md` 파일은 프로젝트 어느 단계에서든 유용합니다.
|
||||
|
||||
| 시나리오 | 만들 시점 | 목적 |
|
||||
| --- | --- | --- |
|
||||
| **새 프로젝트, 아키텍처 전** | `bmad-create-architecture` 전에 수동 작성 | 아키텍트가 기술 선호 사항을 존중하도록 문서화 |
|
||||
| **새 프로젝트, 아키텍처 후** | `bmad-generate-project-context` 또는 수동 작성 | 구현 에이전트를 위해 아키텍처 결정 포착 |
|
||||
| **기존 프로젝트** | `bmad-generate-project-context`로 생성 | 기존 패턴을 발견해 에이전트가 기존 관례를 따르게 함 |
|
||||
| **빠른 흐름 프로젝트** | `bmad-quick-dev` 전 또는 중 | 빠른 구현이 패턴을 존중하도록 보장 |
|
||||
|
||||
:::tip[권장]
|
||||
새 프로젝트에서 강한 기술 선호 사항이 있다면 아키텍처 전에 수동으로 만드세요. 그렇지 않다면 아키텍처 후 생성해 그 결정을 포착하세요.
|
||||
:::
|
||||
|
||||
## 무엇이 들어가나요?
|
||||
|
||||
파일에는 두 주요 섹션이 있습니다.
|
||||
|
||||
### 기술 스택과 버전
|
||||
|
||||
프로젝트가 사용하는 프레임워크, 언어, 도구를 구체적 버전과 함께 문서화합니다.
|
||||
|
||||
```markdown
|
||||
## 기술 스택과 버전
|
||||
|
||||
- Node.js 20.x, TypeScript 5.3, React 18.2
|
||||
- 상태 관리: Zustand(Redux 아님)
|
||||
- 테스트: Vitest, Playwright, MSW
|
||||
- 스타일링: 커스텀 디자인 토큰을 사용하는 Tailwind CSS
|
||||
```
|
||||
|
||||
### 중요한 구현 규칙
|
||||
|
||||
에이전트가 놓칠 수 있는 패턴과 관례를 문서화합니다.
|
||||
|
||||
```markdown
|
||||
## 중요한 구현 규칙
|
||||
|
||||
**TypeScript 설정:**
|
||||
- 엄격 모드 사용 - 명시적 승인 없이 `any` 타입 금지
|
||||
- 공개 API에는 `interface`, 유니언/인터섹션에는 `type` 사용
|
||||
|
||||
**코드 구성:**
|
||||
- 컴포넌트는 `/src/components/`에 두고 `.test.tsx`를 함께 배치
|
||||
- 재사용 가능한 순수 함수는 `/src/lib/` 유틸리티에 배치
|
||||
- API 호출은 `apiClient` 싱글턴 사용 - 직접 fetch 금지
|
||||
|
||||
**테스트 패턴:**
|
||||
- 단위 테스트는 구현 세부사항이 아니라 비즈니스 로직에 집중
|
||||
- 통합 테스트는 MSW로 API 응답을 모킹
|
||||
- E2E 테스트는 중요한 사용자 여정만 다룸
|
||||
|
||||
**프레임워크별 규칙:**
|
||||
- 모든 비동기 작업은 일관된 오류 처리를 위해 `handleError` 래퍼 사용
|
||||
- 기능 플래그는 `@/lib/flags`의 `featureFlag()`로 접근
|
||||
- 새 라우트는 `/src/app/`의 파일 기반 라우팅 패턴을 따름
|
||||
```
|
||||
|
||||
코드 스니펫을 읽고 에이전트가 추론하지 못할 **겉으로 잘 드러나지 않는 것**에 집중하세요. 보편적으로 적용되는 표준 관행은 문서화하지 마세요.
|
||||
|
||||
## 파일 만들기
|
||||
|
||||
세 가지 선택지가 있습니다.
|
||||
|
||||
### 수동 작성
|
||||
|
||||
`_bmad-output/project-context.md`에 파일을 만들고 규칙을 추가합니다.
|
||||
|
||||
```bash
|
||||
# 프로젝트 루트에서
|
||||
mkdir -p _bmad-output
|
||||
touch _bmad-output/project-context.md
|
||||
```
|
||||
|
||||
기술 스택과 구현 규칙을 편집하세요. 아키텍트와 구현 워크플로가 자동으로 찾아 로드합니다.
|
||||
|
||||
### 아키텍처 후 생성
|
||||
|
||||
아키텍처를 완료한 뒤 `bmad-generate-project-context` 워크플로를 실행합니다.
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
이 워크플로는 아키텍처 문서와 프로젝트 파일을 스캔해 내려진 결정을 담은 컨텍스트 파일을 생성합니다.
|
||||
|
||||
### 기존 프로젝트용 생성
|
||||
|
||||
기존 프로젝트에서는 `bmad-generate-project-context`를 실행해 기존 패턴을 발견합니다.
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
워크플로가 코드베이스를 분석해 관례를 식별한 뒤 검토하고 다듬을 수 있는 컨텍스트 파일을 생성합니다.
|
||||
|
||||
## 왜 중요한가
|
||||
|
||||
`project-context.md`가 없으면 에이전트는 프로젝트에 맞지 않는 가정을 할 수 있습니다.
|
||||
|
||||
| 컨텍스트 없음 | 컨텍스트 있음 |
|
||||
| --- | --- |
|
||||
| 일반 패턴 사용 | 기존 관례 따름 |
|
||||
| 스토리마다 일관되지 않은 스타일 | 일관된 구현 |
|
||||
| 프로젝트별 제약을 놓칠 수 있음 | 모든 기술 요구사항 존중 |
|
||||
| 각 에이전트가 독립적으로 결정 | 모든 에이전트가 같은 규칙에 맞춰 동작 |
|
||||
|
||||
특히 다음에 중요합니다.
|
||||
|
||||
- **빠른 흐름** - PRD와 아키텍처를 건너뛰므로 컨텍스트 파일이 공백을 채웁니다
|
||||
- **팀 프로젝트** - 모든 에이전트가 같은 표준을 따르게 합니다
|
||||
- **기존 프로젝트** - 기존 패턴을 깨뜨리지 않게 합니다
|
||||
|
||||
## 편집과 업데이트
|
||||
|
||||
`project-context.md` 파일은 살아 있는 문서입니다. 다음 때 업데이트하세요.
|
||||
|
||||
- 아키텍처 결정이 바뀝니다
|
||||
- 새 관례가 확립됩니다
|
||||
- 구현 중 패턴이 진화합니다
|
||||
- 에이전트 동작에서 공백을 발견합니다
|
||||
|
||||
언제든 수동으로 편집하거나, 큰 변경 후 `bmad-generate-project-context`를 다시 실행해 업데이트할 수 있습니다.
|
||||
|
||||
:::note[파일 위치]
|
||||
기본 위치는 `_bmad-output/project-context.md`입니다. 워크플로는 그곳을 검색하고, 프로젝트 어디에 있든 `**/project-context.md`도 확인합니다.
|
||||
:::
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
---
|
||||
title: "빠른 개발"
|
||||
description: 출력 품질을 보호하는 체크포인트를 포기하지 않고 사람이 개입하는 검토의 마찰을 줄입니다
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
의도를 넣으면 코드 변경이 나오고, 사람이 개입하는 검토 단계는 가능한 한 적게 사용합니다. 품질은 희생하지 않습니다.
|
||||
|
||||
모델이 체크포인트 사이에서 더 오래 실행되게 한 뒤, 작업이 인간 판단 없이 안전하게 계속될 수 없거나 최종 결과를 리뷰할 때만 사람을 다시 불러옵니다.
|
||||
|
||||
|
||||
|
||||
## 왜 존재하나요?
|
||||
|
||||
사람이 개입하는 검토 단계는 필요하지만 비용이 큽니다.
|
||||
|
||||
현재 LLM은 여전히 예측 가능한 방식으로 실패합니다. 의도를 잘못 읽고, 공백을 자신 있게 추측으로 채우고, 관련 없는 작업으로 흐름이 새며, 잡음 많은 리뷰 출력을 만듭니다. 동시에 지속적인 인간 개입은 개발 속도를 제한합니다. 사람의 주의력이 병목이 됩니다.
|
||||
|
||||
`bmad-quick-dev`는 이 절충점을 다시 조정합니다. 워크플로가 안전을 위한 충분히 강한 경계를 만든 뒤에는 모델이 더 긴 구간을 감독 없이 실행하도록 신뢰합니다.
|
||||
|
||||
## 핵심 설계
|
||||
|
||||
### 1. 먼저 의도를 압축합니다
|
||||
|
||||
워크플로는 사람과 모델이 요청을 하나의 일관된 목표로 압축하는 것에서 시작합니다. 입력은 거친 의도 표현일 수 있지만, 워크플로가 자율적으로 실행되기 전에는 실행 가능한 만큼 작고, 명확하고, 모순이 없어야 합니다.
|
||||
|
||||
의도는 다양한 형태로 올 수 있습니다. 몇 문구, 버그 추적기 링크, 계획 모드 출력, 채팅 세션에서 복사한 텍스트, 또는 BMAD의 `epics.md`에 있는 스토리 번호일 수 있습니다. 마지막 경우 워크플로는 BMAD 스토리 추적 규칙을 이해하지는 않지만, 스토리 자체를 가져와 실행할 수 있습니다.
|
||||
|
||||
이 워크플로는 인간 통제를 없애지 않습니다. 통제를 소수의 가치가 큰 순간으로 옮깁니다.
|
||||
|
||||
- **의도 명확화** - 정돈되지 않은 요청을 숨은 모순 없는 하나의 일관된 목표로 바꿉니다
|
||||
- **사양 승인** - 고정된 이해가 만들 올바른 것인지 확인합니다
|
||||
- **최종 결과 검토** - 최종 결과를 받아들일 수 있는지 사람이 결정하는 핵심 체크포인트입니다
|
||||
|
||||
### 2. 가장 작은 안전한 경로를 선택합니다
|
||||
|
||||
목표가 명확해지면 워크플로는 정말 한 번에 처리 가능한 변경인지, 더 완전한 경로가 필요한지 결정합니다. 작고 영향 범위가 거의 없는 변경은 바로 구현으로 갈 수 있습니다. 그 밖의 모든 것은 모델이 더 오래 혼자 실행되기 전에 더 강한 경계를 갖도록 계획을 거칩니다.
|
||||
|
||||
### 3. 더 적은 감독으로 더 오래 실행합니다
|
||||
|
||||
경로 결정 이후 모델은 더 많은 작업을 스스로 수행할 수 있습니다. 더 완전한 경로에서는 승인된 사양이 모델이 적은 감독으로 실행하는 경계가 되며, 이것이 설계의 핵심입니다.
|
||||
|
||||
### 4. 올바른 계층에서 실패를 진단합니다
|
||||
|
||||
의도가 틀려 구현이 틀렸다면 코드 패치는 잘못된 수정입니다. 사양이 약해서 코드가 틀렸다면 diff 패치도 잘못된 수정입니다. 워크플로는 실패가 시스템에 들어온 계층을 진단하고, 그 계층으로 돌아가 다시 생성하도록 설계되었습니다.
|
||||
|
||||
리뷰 발견 사항은 문제가 의도, 사양 생성, 로컬 구현 중 어디에서 왔는지 결정하는 데 쓰입니다. 정말 로컬 문제만 로컬 패치를 받습니다.
|
||||
|
||||
### 5. 필요할 때만 사람을 다시 부릅니다
|
||||
|
||||
의도 인터뷰는 사람이 개입하는 과정이지만 반복 체크포인트와는 다른 중단입니다. 워크플로는 반복 체크포인트를 최소화하려 합니다. 초기 구체화 이후 사람은 워크플로가 판단 없이 안전하게 계속할 수 없을 때와 마지막 리뷰 시점에 주로 돌아옵니다.
|
||||
|
||||
- **의도 공백 해소** - 리뷰가 워크플로가 의도를 안전하게 추론할 수 없었음을 보여줄 때 다시 들어옵니다
|
||||
|
||||
나머지는 더 긴 자율 실행 후보입니다. 이 절충은 의도적입니다. 오래된 패턴은 지속적인 감독에 더 많은 사람의 주의력을 씁니다. 빠른 개발은 모델에 더 많은 신뢰를 주지만, 사람의 판단이 가장 큰 효과를 내는 순간을 위해 주의력을 아낍니다.
|
||||
|
||||
## 리뷰 시스템이 중요한 이유
|
||||
|
||||
리뷰 단계는 버그를 찾기 위해서만 있는 것이 아닙니다. 추진력을 잃지 않고 수정을 올바른 경로로 보내기 위해 있습니다.
|
||||
|
||||
이 워크플로는 하위 에이전트를 생성할 수 있거나, 적어도 명령줄로 다른 LLM을 호출하고 결과를 기다릴 수 있는 플랫폼에서 가장 잘 동작합니다. 플랫폼이 기본으로 지원하지 않는다면 이를 수행하는 스킬을 추가할 수 있습니다. 컨텍스트 없는 하위 에이전트는 리뷰 설계의 핵심입니다.
|
||||
|
||||
에이전트 기반 리뷰는 보통 두 방식으로 잘못됩니다.
|
||||
|
||||
- 발견 사항이 너무 많아 사람이 노이즈를 걸러야 합니다.
|
||||
- 관련 없는 이슈를 끌어들여 현재 변경의 흐름을 깨고, 모든 실행을 즉석 정리 작업으로 바꿉니다.
|
||||
|
||||
빠른 개발은 리뷰를 분류 작업으로 다뤄 둘 다 해결합니다.
|
||||
|
||||
어떤 발견 사항은 현재 변경에 속합니다. 어떤 발견 사항은 그렇지 않습니다. 발견 사항이 현재 작업과 인과적으로 연결되지 않은 부수적 이슈라면, 워크플로는 즉시 처리하도록 강제하지 않고 미룰 수 있습니다. 이렇게 하면 실행이 집중되고 무작위 곁가지가 주의력 예산을 소비하지 않습니다.
|
||||
|
||||
분류는 때때로 완벽하지 않습니다. 괜찮습니다. 수천 개의 낮은 가치 리뷰 댓글로 사람을 압도하는 것보다 일부 발견 사항을 잘못 판단하는 편이 보통 낫습니다. 이 시스템은 모든 이슈를 빠짐없이 회수하는 것보다 신호 품질을 최적화합니다.
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
---
|
||||
title: "솔루션 설계가 중요한 이유"
|
||||
description: 다중 에픽 프로젝트에서 솔루션 설계 단계가 중요한 이유
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
단계 3(솔루션 설계)은 계획 단계의 **무엇을** 만들지를 **어떻게** 만들지로 바꿉니다. 구현이 시작되기 전에 아키텍처 결정을 문서화해 다중 에픽 프로젝트에서 에이전트 충돌을 방지합니다.
|
||||
|
||||
## 솔루션 설계가 없을 때의 문제
|
||||
|
||||
```text
|
||||
에이전트 1은 에픽 1을 REST API로 구현
|
||||
에이전트 2는 에픽 2를 GraphQL로 구현
|
||||
결과: 일관되지 않은 API 설계와 통합 난이도 증가
|
||||
```
|
||||
|
||||
여러 에이전트가 공유 아키텍처 지침 없이 시스템의 서로 다른 부분을 구현하면 서로 충돌하는 독립적 기술 결정을 내릴 수 있습니다.
|
||||
|
||||
## 솔루션 설계가 있을 때의 해결책
|
||||
|
||||
```text
|
||||
아키텍처 워크플로가 결정: "모든 API에 GraphQL 사용"
|
||||
모든 에이전트가 아키텍처 결정을 따름
|
||||
결과: 일관된 구현, 충돌 없음
|
||||
```
|
||||
|
||||
기술 결정을 명시적으로 문서화하면 모든 에이전트가 일관되게 구현하고 통합이 단순해집니다.
|
||||
|
||||
## 솔루션 설계 vs 계획
|
||||
|
||||
| 측면 | 계획 (단계 2) | 솔루션 설계 (단계 3) |
|
||||
| --- | --- | --- |
|
||||
| 질문 | 무엇을, 왜? | 어떻게? 그리고 어떤 작업 단위로? |
|
||||
| 출력 | FRs/NFRs(요구사항) | 아키텍처 + 에픽/스토리 |
|
||||
| 에이전트 | PM | 아키텍트 → PM |
|
||||
| 대상 | 이해관계자 | 개발자 |
|
||||
| 문서 | PRD(기능/비기능 요구사항) | 아키텍처 + 에픽 파일 |
|
||||
| 수준 | 비즈니스 로직 | 기술 설계 + 작업 분해 |
|
||||
|
||||
## 핵심 원칙
|
||||
|
||||
**기술 결정을 명시적으로 문서화**해 모든 에이전트가 일관되게 구현하도록 합니다.
|
||||
|
||||
이것은 다음을 방지합니다.
|
||||
|
||||
- API 스타일 충돌(REST vs GraphQL)
|
||||
- 데이터베이스 설계 불일치
|
||||
- 상태 관리 방식 차이
|
||||
- 이름 규칙 불일치
|
||||
- 보안 접근 방식 차이
|
||||
|
||||
## 솔루션 설계가 필요한 때
|
||||
|
||||
| 트랙 | 솔루션 설계 필요 여부 |
|
||||
| --- | --- |
|
||||
| 빠른 흐름 | 아니요 - 완전히 건너뜁니다 |
|
||||
| BMad Method 단순 | 선택 사항 |
|
||||
| BMad Method 복잡 | 예 |
|
||||
| 엔터프라이즈 | 예 |
|
||||
|
||||
:::tip[경험칙]
|
||||
서로 다른 에이전트가 구현할 수 있는 여러 에픽이 있다면 솔루션 설계가 필요합니다.
|
||||
:::
|
||||
|
||||
## 건너뛸 때의 비용
|
||||
|
||||
복잡한 프로젝트에서 솔루션 설계를 건너뛰면 다음으로 이어집니다.
|
||||
|
||||
- 스프린트 중 발견되는 **통합 이슈**
|
||||
- 충돌하는 구현으로 인한 **재작업**
|
||||
- 전체적으로 **더 긴 개발 시간**
|
||||
- 일관되지 않은 패턴에서 생기는 **기술 부채**
|
||||
|
||||
:::caution[비용 배율]
|
||||
방향이 어긋나는 문제를 솔루션 설계에서 잡는 것이 구현 중 발견하는 것보다 10배 빠릅니다.
|
||||
:::
|
||||
|
|
@ -0,0 +1,387 @@
|
|||
---
|
||||
title: 'BMad 커스터마이징 방법'
|
||||
description: 업데이트 호환성을 유지하면서 에이전트와 워크플로를 커스터마이징합니다
|
||||
sidebar:
|
||||
order: 8
|
||||
---
|
||||
|
||||
설치된 파일을 수정하지 않고 에이전트 페르소나를 조정하고, 도메인 컨텍스트를 주입하고, 기능을 추가하고, 워크플로 동작을 설정하세요. 커스터마이징은 업데이트 후에도 유지됩니다.
|
||||
|
||||
:::tip[TOML을 직접 쓰고 싶지 않나요? `bmad-customize`를 사용하세요]
|
||||
`bmad-customize` 스킬은 이 문서에서 설명하는 **스킬별 에이전트/워크플로 오버라이드 영역**을 안내형으로 작성해 주는 도우미입니다. 설치된 항목 중 무엇을 커스터마이즈할 수 있는지 스캔하고, 의도에 맞는 영역(에이전트 또는 워크플로)을 고르게 하고, 오버라이드 파일을 작성하고, 병합이 적용되었는지 검증합니다. 중앙 설정 오버라이드(`_bmad/custom/config.toml`)는 v1 범위 밖이므로 아래 중앙 설정 섹션에 따라 직접 작성해야 합니다.
|
||||
:::
|
||||
|
||||
## 사용 시점
|
||||
|
||||
- 에이전트의 성격이나 커뮤니케이션 스타일을 바꾸고 싶습니다
|
||||
- 에이전트가 계속 기억할 사실이 필요합니다(예: "우리 조직은 AWS만 사용")
|
||||
- 매 세션 시작 시 에이전트가 반드시 수행해야 하는 절차적 단계를 추가하고 싶습니다
|
||||
- 자체 스킬이나 프롬프트를 실행하는 커스텀 메뉴 항목을 추가하고 싶습니다
|
||||
- 팀 공통 커스터마이징은 git에 커밋하고, 개인 선호는 그 위에 덧씌우고 싶습니다
|
||||
|
||||
:::note[필수 조건]
|
||||
|
||||
- 프로젝트에 BMad 설치([BMad 설치 방법](./install-bmad.md) 참고)
|
||||
- PATH의 Python 3.11+(병합 스크립트용, stdlib `tomllib`만 사용하며 `pip install`, `uv`, virtualenv 불필요)
|
||||
- TOML 파일을 편집할 텍스트 에디터
|
||||
:::
|
||||
|
||||
## 작동 방식
|
||||
|
||||
커스터마이즈 가능한 모든 스킬은 기본값이 들어 있는 `customize.toml` 파일을 제공합니다. 이 파일은 스킬의 전체 커스터마이징 영역을 정의합니다. 무엇을 바꿀 수 있는지 보려면 이 파일을 읽으세요. 이 파일은 직접 편집하지 않습니다. 대신 바꾸려는 필드만 담은 오버라이드 파일을 만듭니다.
|
||||
|
||||
### 3계층 오버라이드 모델
|
||||
|
||||
```text
|
||||
우선순위 1(승리): _bmad/custom/{skill-name}.user.toml (개인, git 무시)
|
||||
우선순위 2: _bmad/custom/{skill-name}.toml (팀/조직, 커밋)
|
||||
우선순위 3(마지막): 스킬 자체 customize.toml (기본값)
|
||||
```
|
||||
|
||||
`_bmad/custom/` 폴더는 처음엔 비어 있습니다. 누군가 실제로 커스터마이즈할 때만 파일이 생깁니다.
|
||||
|
||||
### 병합 규칙(필드명이 아니라 모양 기준)
|
||||
|
||||
병합 스크립트는 네 가지 구조 규칙을 적용합니다. 필드명은 특별 취급되지 않습니다. 값의 구조가 동작을 결정합니다.
|
||||
|
||||
| 모양 | 규칙 |
|
||||
| --- | --- |
|
||||
| 스칼라 값(문자열, 정수, 불리언, 실수) | 오버라이드가 이깁니다 |
|
||||
| 테이블 | 깊은 병합(재귀적으로 이 규칙을 적용) |
|
||||
| 모든 항목이 **같은** 식별자 필드(`code` 또는 `id`)를 공유하는 테이블 배열 | 해당 키로 병합합니다. 같은 키는 **제자리에서 교체**, 새 키는 **추가**됩니다 |
|
||||
| 그 밖의 배열(스칼라 값, 식별자가 없는 테이블, `code`와 `id`가 섞인 배열) | **추가**됩니다. 기본값, 팀, 사용자 순서입니다 |
|
||||
|
||||
**삭제 메커니즘은 없습니다.** 오버라이드는 기본값 항목을 지울 수 없습니다. 기본 메뉴 항목을 숨겨야 한다면 같은 `code`로 동작 없는 설명이나 프롬프트를 넣어 덮어쓰세요. 배열을 더 깊게 재구성해야 한다면 스킬을 포크하세요.
|
||||
|
||||
**`code` / `id` 관례.** BMad는 테이블 배열의 병합 키로 `code`(예: `"BP"`, `"R1"` 같은 짧은 식별자)와 `id`(더 긴 안정 식별자)를 사용합니다. 직접 만든 테이블 배열이 추가 전용이 아니라 키로 교체 가능해야 한다면 한 가지 관례만 고르고 전체 배열에서 일관되게 사용하세요. 일부 항목은 `code`, 일부 항목은 `id`를 쓰면 키 병합 대신 추가 방식으로 처리됩니다.
|
||||
|
||||
### 일부 에이전트 필드는 읽기 전용입니다
|
||||
|
||||
`agent.name`과 `agent.title`은 기준 메타데이터로 `customize.toml`에 있지만, 에이전트의 SKILL.md는 런타임에 이를 읽지 않습니다. 정체성은 하드코딩되어 있습니다. 오버라이드 파일에 `name = "Bob"`을 넣어도 효과가 없습니다. 정말 다른 이름의 에이전트가 필요하다면 스킬 폴더를 복사해 이름을 바꾸고 커스텀 스킬로 배포하세요.
|
||||
|
||||
## 단계
|
||||
|
||||
### 1. 스킬의 커스터마이징 영역 찾기
|
||||
|
||||
설치된 디렉터리에서 스킬의 `customize.toml`을 확인합니다. PM 에이전트 예:
|
||||
|
||||
```text
|
||||
.claude/skills/bmad-agent-pm/customize.toml
|
||||
```
|
||||
|
||||
경로는 IDE별로 다릅니다. Cursor는 `.cursor/skills/`, Cline은 `.cline/skills/`를 사용합니다.
|
||||
|
||||
이 파일이 기준 스키마입니다. 읽기 전용 정체성 필드를 제외하고 보이는 모든 필드는 커스터마이즈할 수 있습니다.
|
||||
|
||||
### 2. 오버라이드 파일 만들기
|
||||
|
||||
프로젝트 루트에 `_bmad/custom/` 디렉터리가 없다면 만듭니다. 그런 다음 스킬 이름을 딴 파일을 만듭니다.
|
||||
|
||||
```text
|
||||
_bmad/custom/
|
||||
bmad-agent-pm.toml # 팀 오버라이드(git에 커밋)
|
||||
bmad-agent-pm.user.toml # 개인 선호(git에서 무시)
|
||||
```
|
||||
|
||||
:::caution[전체 `customize.toml`을 복사하지 마세요]
|
||||
오버라이드 파일은 **희소**입니다. 바꾸는 필드만 포함하세요. 생략한 필드는 아래 계층(팀은 기본값에서, 사용자는 팀 또는 기본값에서) 자동 상속됩니다.
|
||||
|
||||
전체 `customize.toml`을 오버라이드로 복사하면 해롭습니다. 다음 업데이트가 새 기본값을 제공해도 오버라이드 파일이 옛 값을 고정하기 때문에 릴리스마다 조용히 어긋납니다.
|
||||
:::
|
||||
|
||||
**예시 - 아이콘을 바꾸고 원칙 하나 추가:**
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-agent-pm.toml
|
||||
# 바꾸는 필드만 둡니다. 나머지는 모두 상속됩니다.
|
||||
|
||||
[agent]
|
||||
icon = "🏥"
|
||||
principles = [
|
||||
"FDA 감사를 통과할 수 없는 것은 출시하지 않습니다.",
|
||||
]
|
||||
```
|
||||
|
||||
이 설정은 새 원칙을 기본값에 추가하고(제공된 원칙은 그대로 유지), 아이콘을 교체합니다. 나머지 필드는 제공된 값으로 남습니다.
|
||||
|
||||
### 3. 필요한 항목 커스터마이즈하기
|
||||
|
||||
아래 예시는 BMad의 평면 에이전트 스키마를 가정합니다. 필드는 `[agent]` 아래에 직접 위치하며 중첩된 `metadata`나 `persona` 하위 테이블은 없습니다.
|
||||
|
||||
**스칼라 값(icon, 역할, 정체성, communication_style).** 스칼라 값 오버라이드가 이깁니다. 바꾸는 필드만 설정하면 됩니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-agent-pm.toml
|
||||
|
||||
[agent]
|
||||
icon = "🏥"
|
||||
role = "규제 대상 헬스케어 도메인의 제품 발견을 이끕니다."
|
||||
communication_style = "정밀하고 규제를 의식하며, 초반부터 컴플라이언스 관점의 질문을 던집니다."
|
||||
```
|
||||
|
||||
**영구 사실, 원칙, 활성화 후크(추가 배열).** 아래 네 배열은 추가 전용입니다. 팀 항목은 기본값 뒤에 실행되고, 사용자 항목은 마지막에 실행됩니다.
|
||||
|
||||
```toml
|
||||
[agent]
|
||||
# 에이전트가 세션 내내 염두에 둘 정적 사실입니다. 조직 규칙, 도메인
|
||||
# 상수, 사용자 선호 등이 여기에 들어갑니다. 런타임 메모리 사이드카와는 다릅니다.
|
||||
#
|
||||
# 각 항목은 문장 그대로이거나, 내용을 사실로 로드하는 `file:` 참조입니다
|
||||
# glob 패턴도 지원합니다.
|
||||
persistent_facts = [
|
||||
"우리 조직은 AWS만 사용합니다. GCP나 Azure를 제안하지 마세요.",
|
||||
"모든 PRD는 엔지니어링 착수 전에 법무 승인을 받아야 합니다.",
|
||||
"대상 사용자는 환자가 아니라 임상의입니다. 예시도 그에 맞춰 구성하세요.",
|
||||
"file:{project-root}/docs/compliance/hipaa-overview.md",
|
||||
"file:{project-root}/_bmad/custom/company-glossary.md",
|
||||
]
|
||||
|
||||
# 에이전트의 가치 체계에 추가합니다
|
||||
principles = [
|
||||
"FDA 감사를 통과할 수 없는 것은 출시하지 않습니다.",
|
||||
"사용자 가치를 먼저, 컴플라이언스는 항상 지킵니다.",
|
||||
]
|
||||
|
||||
# 표준 활성화(페르소나, persistent_facts, 설정, 인사) 전에 실행합니다.
|
||||
activation_steps_prepend = [
|
||||
"{project-root}/docs/compliance/를 스캔하고 HIPAA 관련 문서를 컨텍스트로 로드하세요.",
|
||||
]
|
||||
|
||||
# 인사 후, 메뉴 전에 실행합니다.
|
||||
activation_steps_append = [
|
||||
"{project-root}/_bmad/custom/company-glossary.md가 있으면 읽으세요.",
|
||||
]
|
||||
```
|
||||
|
||||
두 후크는 역할이 다릅니다. Prepend는 인사 전에 실행되어 인사 자체를 개인화하는 데 필요한 컨텍스트를 로드할 수 있습니다. Append는 인사 후 실행되어 무거운 스캔이 끝날 때까지 사용자가 빈 화면만 보지 않게 합니다.
|
||||
|
||||
**메뉴 커스터마이징(`code`로 병합).** 메뉴는 테이블 배열입니다. 각 항목에는 `code` 필드가 있으므로 병합 스크립트는 코드로 병합합니다. 같은 코드는 제자리에서 교체되고, 새 코드는 추가됩니다.
|
||||
|
||||
TOML 테이블 배열 문법은 항목마다 `[[agent.menu]]`를 사용합니다.
|
||||
|
||||
```toml
|
||||
# 기존 CE 항목을 커스텀 스킬로 교체
|
||||
[[agent.menu]]
|
||||
code = "CE"
|
||||
description = "우리 전달 프레임워크로 에픽 생성"
|
||||
skill = "custom-create-epics"
|
||||
|
||||
# 새 항목 추가(기본값에는 RC 코드가 없음)
|
||||
[[agent.menu]]
|
||||
code = "RC"
|
||||
description = "컴플라이언스 사전 점검 실행"
|
||||
prompt = """
|
||||
{project-root}/_bmad/custom/compliance-checklist.md를 읽고
|
||||
{planning_artifacts}의 모든 문서를 그 기준에 맞춰 스캔하세요.
|
||||
공백이 있으면 관련 규제 조항을 인용해 보고하세요.
|
||||
"""
|
||||
```
|
||||
|
||||
각 메뉴 항목은 `skill`(등록된 스킬 호출) 또는 `prompt`(텍스트 직접 실행) 중 정확히 하나를 가집니다. 오버라이드에 나열하지 않은 항목은 기본값을 유지합니다.
|
||||
|
||||
**파일 참조.** `persistent_facts`, `activation_steps_prepend`/`activation_steps_append`, 메뉴 항목의 `prompt`처럼 텍스트가 파일을 가리켜야 할 때는 `{project-root}`를 기준으로 한 전체 경로를 사용하세요. 파일이 `_bmad/custom/`에서 오버라이드 옆에 있더라도 `{project-root}/_bmad/custom/info.md`처럼 전체 경로를 적습니다.
|
||||
|
||||
### 4. 개인 vs 팀
|
||||
|
||||
**팀 파일**(`bmad-agent-pm.toml`): git에 커밋합니다. 조직 전체에 공유됩니다. 컴플라이언스 규칙, 회사 페르소나, 커스텀 기능에 사용합니다.
|
||||
|
||||
**개인 파일**(`bmad-agent-pm.user.toml`): 자동으로 git에서 무시됩니다. 말투 조정, 개인 워크플로 선호 사항, 에이전트가 기억해야 하는 개인 사실에 사용합니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-agent-pm.user.toml
|
||||
|
||||
[agent]
|
||||
persistent_facts = [
|
||||
"선택지를 제시할 때 항상 대략적인 복잡도 추정(낮음/중간/높음)을 포함하세요.",
|
||||
]
|
||||
```
|
||||
|
||||
## 해석이 작동하는 방식
|
||||
|
||||
활성화 시 에이전트의 SKILL.md가 공유 Python 스크립트를 실행해 3계층 병합을 수행하고 해석된 블록을 JSON으로 반환합니다. 스크립트는 Python 표준 라이브러리의 `tomllib`만 사용하므로 기본 `python3`이면 충분합니다.
|
||||
|
||||
```bash
|
||||
python3 {project-root}/_bmad/scripts/resolve_customization.py \
|
||||
--skill {skill-root} \
|
||||
--key agent
|
||||
```
|
||||
|
||||
**요구사항**: Python 3.11+(이전 버전에는 `tomllib`이 없습니다). `pip install`, `uv`, virtualenv는 필요 없습니다. `python3 --version`으로 확인하세요. Homebrew 없는 macOS나 Ubuntu 22.04 같은 플랫폼은 기본 `python3`이 3.10 이하일 수 있으므로 3.11+를 별도 설치해야 할 수 있습니다.
|
||||
|
||||
`--skill`은 스킬이 설치된 디렉터리(`customize.toml`이 있는 위치)를 가리킵니다. 스킬 이름은 디렉터리의 basename에서 파생되며, 스크립트는 `_bmad/custom/{skill-name}.toml`과 `{skill-name}.user.toml`을 자동으로 찾습니다.
|
||||
|
||||
유용한 호출:
|
||||
|
||||
```bash
|
||||
# 전체 에이전트 블록 해석
|
||||
python3 {project-root}/_bmad/scripts/resolve_customization.py \
|
||||
--skill /abs/path/to/bmad-agent-pm \
|
||||
--key agent
|
||||
|
||||
# 단일 필드 해석
|
||||
python3 {project-root}/_bmad/scripts/resolve_customization.py \
|
||||
--skill /abs/path/to/bmad-agent-pm \
|
||||
--key agent.icon
|
||||
|
||||
# 전체 덤프
|
||||
python3 {project-root}/_bmad/scripts/resolve_customization.py \
|
||||
--skill /abs/path/to/bmad-agent-pm
|
||||
```
|
||||
|
||||
출력은 항상 JSON입니다. 특정 플랫폼에서 스크립트를 사용할 수 없다면 SKILL.md는 에이전트에게 세 TOML 파일을 직접 읽고 같은 병합 규칙을 적용하라고 지시합니다.
|
||||
|
||||
## 워크플로 커스터마이징
|
||||
|
||||
`bmad-product-brief`처럼 여러 단계 프로세스를 구동하는 워크플로(스킬)도 에이전트와 같은 오버라이드 메커니즘을 공유합니다. 커스터마이즈 가능한 영역은 `[agent]` 대신 `[workflow]` 아래에 있습니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml
|
||||
|
||||
[workflow]
|
||||
activation_steps_prepend = [
|
||||
"Load {project-root}/docs/product/north-star-principles.md as context.",
|
||||
]
|
||||
|
||||
activation_steps_append = []
|
||||
|
||||
persistent_facts = [
|
||||
"모든 개요에는 명시적인 규제 위험 섹션이 포함되어야 합니다.",
|
||||
"file:{project-root}/docs/compliance/product-brief-checklist.md",
|
||||
]
|
||||
|
||||
on_complete = "개요를 세 개의 글머리표로 요약하고 gws-gmail-send 스킬로 이메일 발송을 제안하세요."
|
||||
```
|
||||
|
||||
동일한 필드 관례가 에이전트/워크플로 경계를 넘습니다. `activation_steps_prepend`/`activation_steps_append`, `persistent_facts`(`file:` 참조 포함), 그리고 키 기반 병합용 `code`/`id`가 있는 메뉴 스타일 `[[...]]` 테이블이 모두 같은 방식으로 동작합니다. 병합 스크립트는 최상위 키와 관계없이 네 구조 규칙을 적용합니다. SKILL.md 참조는 네임스페이스를 따릅니다: `{workflow.activation_steps_prepend}`, `{workflow.persistent_facts}`, `{workflow.on_complete}`. 워크플로가 노출하는 추가 필드(출력 경로, 토글, 리뷰 설정, 단계 플래그 등)도 같은 구조 기반 병합 규칙을 따릅니다. 무엇을 커스터마이즈할 수 있는지는 워크플로의 `customize.toml`을 읽으세요.
|
||||
|
||||
### 활성화 순서
|
||||
|
||||
커스터마이즈 가능한 워크플로는 후크가 언제 실행되는지 알 수 있도록 고정된 순서로 활성화됩니다.
|
||||
|
||||
1. `[workflow]` 블록 해석(기본값 → 팀 → 사용자 병합)
|
||||
2. `activation_steps_prepend`를 순서대로 실행
|
||||
3. 실행의 기반 컨텍스트로 `persistent_facts` 로드
|
||||
4. 설정(`_bmad/bmm/config.yaml`) 로드 및 표준 변수(프로젝트 이름, 언어, 경로, 날짜) 해석
|
||||
5. 사용자에게 인사
|
||||
6. `activation_steps_append`를 순서대로 실행
|
||||
|
||||
6단계 이후 워크플로 본문이 시작됩니다. 인사를 개인화하기 전에 컨텍스트가 필요하면 `activation_steps_prepend`를 사용하고, 설정이 무거워 사용자에게 인사를 먼저 보여주고 싶다면 `activation_steps_append`를 사용하세요.
|
||||
|
||||
### 현재 초기 단계의 범위
|
||||
|
||||
커스터마이징은 점진적으로 출시됩니다. 위에서 문서화한 `activation_steps_prepend`, `activation_steps_append`, `persistent_facts`, `on_complete`는 모든 커스터마이즈 가능한 워크플로가 노출하는 **기준 영역**이며 버전 간 안정적으로 유지됩니다. 오늘 당장 사전/사후 단계 주입, 기반 컨텍스트 고정, 후속 작업 트리거 같은 큰 단위의 제어를 제공합니다.
|
||||
|
||||
시간이 지나면 개별 워크플로가 실제로 하는 일에 맞춘 **더 세밀한 커스터마이징 지점**을 노출할 것입니다. 단계별 토글, 단계 플래그, 출력 템플릿 경로, 리뷰 게이트 같은 것들입니다. 그런 항목이 추가되면 기준 필드를 대체하지 않고 그 위에 쌓이므로 오늘 작성한 커스터마이징은 계속 동작합니다.
|
||||
|
||||
아직 노출되지 않은 세밀한 조절점이 필요하다면 `activation_steps_*`와 `persistent_facts`로 동작을 조정하거나, 원하는 커스터마이징 지점을 구체적으로 설명하는 이슈를 열어 주세요.
|
||||
|
||||
## 중앙 설정
|
||||
|
||||
스킬별 `customize.toml`은 **깊은 동작**(후크, 메뉴, persistent_facts, 단일 에이전트/워크플로의 페르소나 오버라이드)을 다룹니다. 별도 영역은 **공유 상태**를 다룹니다. 설치 답변과 `bmad-party-mode`, `bmad-retrospective`, `bmad-advanced-elicitation` 같은 외부 스킬이 사용하는 에이전트 명단입니다. 이 영역은 프로젝트 루트의 네 TOML 파일에 있습니다.
|
||||
|
||||
```text
|
||||
_bmad/config.toml (설치 프로그램 소유) 팀 범위: 설치 답변 + 에이전트 명단
|
||||
_bmad/config.user.toml (설치 프로그램 소유) 사용자 범위: user_name, 언어, 스킬 수준
|
||||
_bmad/custom/config.toml (사람이 작성) 팀 오버라이드(git에 커밋)
|
||||
_bmad/custom/config.user.toml (사람이 작성) 개인 오버라이드(git에서 무시)
|
||||
```
|
||||
|
||||
### 4계층 병합
|
||||
|
||||
```text
|
||||
우선순위 1(승리): _bmad/custom/config.user.toml
|
||||
우선순위 2: _bmad/custom/config.toml
|
||||
우선순위 3: _bmad/config.user.toml
|
||||
우선순위 4(기반): _bmad/config.toml
|
||||
```
|
||||
|
||||
스킬별 커스터마이즈와 같은 구조 규칙을 사용합니다. 스칼라 값 오버라이드, 테이블 깊은 병합, `code`/`id` 키 기반 배열 병합, 그 밖의 배열 추가입니다.
|
||||
|
||||
### 무엇이 어디에 있나요?
|
||||
|
||||
설치 프로그램은 `module.yaml`의 각 프롬프트에 선언된 `scope:`에 따라 답변을 나눕니다.
|
||||
|
||||
- `[core]`와 `[modules.<code>]` 섹션 - 설치 답변입니다. `team` 범위는 `_bmad/config.toml`에, `user` 범위는 `_bmad/config.user.toml`에 들어갑니다.
|
||||
- `[agents.<code>]` - 각 모듈의 `module.yaml` `agents:` 블록에서 추출한 에이전트 핵심 정보(코드, 이름, 직함, 아이콘, 설명, 팀)입니다. 항상 팀 범위입니다.
|
||||
|
||||
### 편집 규칙
|
||||
|
||||
- `_bmad/config.toml`과 `_bmad/config.user.toml`은 **설치할 때마다 재생성**됩니다. 읽기 전용 출력으로 취급하세요. 직접 수정하면 다음 설치에서 덮어쓰입니다. 설치 답변을 지속적으로 바꾸려면 설치 프로그램을 다시 실행하거나 `_bmad/custom/config.toml`에서 값을 덮어쓰세요.
|
||||
- `_bmad/custom/config.toml`과 `_bmad/custom/config.user.toml`은 설치 프로그램이 **절대 건드리지 않습니다**. 커스텀 에이전트, 에이전트 설명자 오버라이드, 팀 강제 설정, 설치 답변과 무관하게 고정하려는 값을 넣는 올바른 영역입니다.
|
||||
|
||||
### 예시 - 에이전트 리브랜딩
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.toml (git에 커밋, 모든 개발자에게 적용)
|
||||
|
||||
[agents.bmad-agent-pm]
|
||||
description = "헬스케어 PM - 규제를 의식하고 이해관계자 중심이며, FDA 관점의 질문을 먼저 던집니다."
|
||||
icon = "🏥"
|
||||
```
|
||||
|
||||
병합 스크립트가 설치 프로그램이 작성한 `[agents.bmad-agent-pm]` 위로 병합합니다. `bmad-party-mode`와 명단을 사용하는 스킬은 새 설명을 자동으로 사용합니다.
|
||||
|
||||
### 예시 - 가상 에이전트 추가
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.user.toml (개인용, git에서 무시)
|
||||
|
||||
[agents.kirk]
|
||||
team = "startrek"
|
||||
name = "Captain James T. Kirk"
|
||||
title = "우주선 선장"
|
||||
icon = "🖖"
|
||||
description = "대담하고 규칙을 굽힐 줄 아는 지휘관입니다. 극적인 쉼표를 두고 말하며 지휘의 무게를 소리 내어 생각합니다."
|
||||
```
|
||||
|
||||
스킬 폴더가 없어도 핵심 정보만으로 파티 모드가 Kirk를 하나의 목소리로 생성할 수 있습니다. `team` 필드로 필터링해 엔터프라이즈 승무원만 라운드테이블에 초대할 수 있습니다.
|
||||
|
||||
### 예시 - 모듈 설치 설정 오버라이드
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.toml
|
||||
|
||||
[modules.bmm]
|
||||
planning_artifacts = "/shared/org-planning-artifacts"
|
||||
```
|
||||
|
||||
오버라이드는 각 개발자가 로컬 설치 중 답한 값보다 우선합니다. 팀 관례를 고정할 때 유용합니다.
|
||||
|
||||
### 어떤 영역을 사용할까요?
|
||||
|
||||
| 필요 | 사용 |
|
||||
| --- | --- |
|
||||
| 모든 개발 워크플로에 MCP 도구 호출 추가 | 스킬별: `_bmad/custom/bmad-agent-dev.toml` `persistent_facts` |
|
||||
| 에이전트에 메뉴 항목 추가 | 스킬별: `_bmad/custom/bmad-agent-{role}.toml` `[[agent.menu]]` |
|
||||
| 워크플로의 출력 템플릿 교체 | 스킬별: `_bmad/custom/{workflow}.toml` 스칼라 값 오버라이드 |
|
||||
| 에이전트 공개 설명자 리브랜딩 | **중앙**: `_bmad/custom/config.toml` `[agents.<code>]` |
|
||||
| 커스텀 또는 가상 에이전트를 명단에 추가 | **중앙**: `_bmad/custom/config.*.toml` 새 `[agents.<code>]` 항목 |
|
||||
| 팀 강제 설치 설정 고정 | **중앙**: `_bmad/custom/config.toml` `[modules.<code>]` 또는 `[core]` |
|
||||
|
||||
필요에 따라 한 프로젝트에서 두 영역을 함께 사용하세요.
|
||||
|
||||
## 실전 예시
|
||||
|
||||
에이전트가 실행하는 모든 워크플로에 걸친 동작 조정, 조직 관례 강제, Confluence와 Jira로 출력 게시, 에이전트 명단 커스터마이즈, 출력 템플릿 교체 같은 엔터프라이즈 지향 레시피는 [조직을 위해 BMad 확장하기](./expand-bmad-for-your-org.md)를 참고하세요.
|
||||
|
||||
## 문제 해결
|
||||
|
||||
**커스터마이징이 보이지 않나요?**
|
||||
|
||||
- 파일이 `_bmad/custom/`에 올바른 스킬 이름으로 있는지 확인하세요
|
||||
- TOML 문법을 확인하세요. 문자열은 따옴표가 필요하고, 테이블 헤더는 `[section]`, 테이블 배열은 `[[section]]`입니다. 테이블의 스칼라 값 또는 배열 키는 해당 테이블의 `[[subtables]]`보다 먼저 와야 합니다
|
||||
- 에이전트의 경우 커스터마이징은 `[agent]` 아래에 있습니다. 그 헤더 아래에 쓴 필드는 다른 테이블 헤더가 시작될 때까지 `agent`에 속합니다
|
||||
- `agent.name`과 `agent.title`은 읽기 전용입니다. 오버라이드해도 효과가 없습니다
|
||||
|
||||
**업데이트가 커스터마이징을 망가뜨렸나요?**
|
||||
|
||||
- 전체 `customize.toml`을 오버라이드 파일에 복사했나요? **하지 마세요.** 오버라이드 파일은 바꾸는 필드만 포함해야 합니다. 전체 복사는 옛 기본값을 고정하고 릴리스마다 조용히 어긋납니다. 오버라이드를 변경분만 남기도록 줄이세요.
|
||||
|
||||
**무엇을 커스터마이즈할 수 있는지 봐야 하나요?**
|
||||
|
||||
- `bmad-customize` 스킬을 실행하세요. 프로젝트에 설치된 모든 커스터마이즈 가능한 스킬을 열거하고, 이미 오버라이드가 있는 항목을 보여주며, 추가 또는 업데이트 과정을 안내합니다
|
||||
- 또는 스킬의 `customize.toml`을 직접 읽으세요. `name`과 `title`을 제외하고 모든 필드가 커스터마이즈 가능합니다
|
||||
|
||||
**초기화가 필요하나요?**
|
||||
|
||||
- `_bmad/custom/`에서 오버라이드 파일을 삭제하세요. 스킬은 내장 기본값으로 돌아갑니다
|
||||
|
|
@ -0,0 +1,119 @@
|
|||
---
|
||||
title: '기존 프로젝트'
|
||||
description: 기존 코드베이스에서 BMad Method를 사용하는 방법
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
기존 프로젝트와 레거시 코드베이스에서 작업할 때 BMad Method를 효과적으로 사용하세요.
|
||||
|
||||
이 가이드는 BMad Method로 기존 프로젝트에 적응하는 핵심 워크플로를 다룹니다.
|
||||
|
||||
:::note[필수 조건]
|
||||
|
||||
- BMad Method 설치(`npx bmad-method install`)
|
||||
- 작업하려는 기존 코드베이스
|
||||
- AI 기반 IDE(Claude Code 또는 Cursor) 접근 권한
|
||||
:::
|
||||
|
||||
## 1단계: 완료된 계획 산출물 정리
|
||||
|
||||
BMad 과정으로 모든 PRD 에픽과 스토리를 완료했다면 해당 파일을 정리하세요. 필요하다면 보관하거나 삭제하거나 버전 기록에 의존하세요. 다음 위치에 이 파일들을 계속 두지 마세요.
|
||||
|
||||
- `docs/`
|
||||
- `_bmad-output/planning-artifacts/`
|
||||
- `_bmad-output/implementation-artifacts/`
|
||||
|
||||
## 2단계: 프로젝트 컨텍스트 만들기
|
||||
|
||||
:::tip[기존 프로젝트에 권장]
|
||||
`project-context.md`를 생성해 기존 코드베이스의 패턴과 규칙을 포착하세요. 이렇게 하면 변경을 구현할 때 AI 에이전트가 이미 자리 잡은 관례를 따릅니다.
|
||||
:::
|
||||
|
||||
프로젝트 컨텍스트 생성 워크플로를 실행합니다.
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
이 워크플로는 코드베이스를 스캔해 다음을 식별합니다.
|
||||
|
||||
- 기술 스택과 버전
|
||||
- 코드 구성 패턴
|
||||
- 명명 규칙
|
||||
- 테스트 접근 방식
|
||||
- 프레임워크별 패턴
|
||||
|
||||
생성된 파일을 검토하고 다듬거나, 원한다면 `_bmad-output/project-context.md`에 직접 만들 수 있습니다.
|
||||
|
||||
[프로젝트 컨텍스트 자세히 알아보기](../explanation/project-context.md)
|
||||
|
||||
## 3단계: 품질 높은 프로젝트 문서 유지
|
||||
|
||||
`docs/` 폴더에는 프로젝트를 정확하게 나타내는 간결하고 잘 구성된 문서가 있어야 합니다.
|
||||
|
||||
- 의도와 비즈니스 근거
|
||||
- 비즈니스 규칙
|
||||
- 아키텍처
|
||||
- 그 밖의 관련 프로젝트 정보
|
||||
|
||||
복잡한 프로젝트라면 `bmad-document-project` 워크플로 사용을 고려하세요. 전체 프로젝트를 스캔하고 실제 현재 상태를 문서화하는 실행 시 선택 가능한 변형을 제공합니다.
|
||||
|
||||
## 4단계: 도움 받기
|
||||
|
||||
### BMad 도움말: 시작점
|
||||
|
||||
**다음에 무엇을 해야 할지 확실하지 않을 때 언제든 `bmad-help`를 실행하세요.** 이 지능형 가이드는 다음을 수행합니다.
|
||||
|
||||
- 프로젝트를 검사해 이미 완료된 작업을 확인합니다
|
||||
- 설치된 모듈을 기준으로 선택지를 보여줍니다
|
||||
- 자연어 질문을 이해합니다
|
||||
|
||||
```
|
||||
bmad-help 기존 Rails 앱이 있는데 어디서 시작하면 좋나요?
|
||||
bmad-help 빠른 흐름과 전체 BMad Method는 무엇이 다른가요?
|
||||
bmad-help 사용할 수 있는 워크플로를 보여 주세요
|
||||
```
|
||||
|
||||
BMad 도움말은 **모든 워크플로 끝에서 자동으로 실행되어** 다음에 무엇을 해야 할지 명확히 안내합니다.
|
||||
|
||||
### 접근 방식 선택
|
||||
|
||||
변경 범위에 따라 두 가지 주요 선택지가 있습니다.
|
||||
|
||||
| 범위 | 권장 접근 방식 |
|
||||
| --- | --- |
|
||||
| **작은 업데이트나 추가** | `bmad-quick-dev`를 실행해 의도 정리, 계획, 구현, 리뷰를 하나의 워크플로에서 처리합니다. 전체 4단계 BMad Method는 과할 가능성이 큽니다. |
|
||||
| **큰 변경이나 추가** | 필요한 만큼만 엄격하게 적용하면서 BMad Method로 시작합니다. |
|
||||
|
||||
### PRD 작성 중
|
||||
|
||||
제품 개요를 만들거나 바로 PRD로 들어갈 때 에이전트가 다음을 하도록 확인하세요.
|
||||
|
||||
- 기존 프로젝트 문서를 찾고 분석합니다
|
||||
- 현재 시스템에 대한 적절한 컨텍스트를 읽습니다
|
||||
|
||||
에이전트를 명시적으로 안내할 수 있지만 목표는 새 기능이 기존 시스템과 잘 통합되게 하는 것입니다.
|
||||
|
||||
### UX 고려 사항
|
||||
|
||||
UX 작업은 선택 사항입니다. 결정 기준은 프로젝트에 UX가 있는지가 아니라 다음입니다.
|
||||
|
||||
- UX 변경을 작업할 예정인지
|
||||
- 의미 있는 새 UX 디자인이나 패턴이 필요한지
|
||||
|
||||
만족스러운 기존 화면을 단순히 업데이트하는 정도라면 전체 UX 과정은 필요하지 않습니다.
|
||||
|
||||
### 아키텍처 고려 사항
|
||||
|
||||
아키텍처를 진행할 때 아키텍트가 다음을 하도록 확인하세요.
|
||||
|
||||
- 적절한 문서 파일을 사용합니다
|
||||
- 기존 코드베이스를 스캔합니다
|
||||
|
||||
여기서는 특히 주의하세요. 이미 있는 것을 다시 만들거나 기존 아키텍처와 어긋나는 결정을 방지해야 합니다.
|
||||
|
||||
## 더 보기
|
||||
|
||||
- **[빠른 수정](./quick-fixes.md)** - 버그 수정과 임시 변경
|
||||
- **[기존 프로젝트 FAQ](../explanation/established-projects-faq.md)** - 기존 프로젝트 작업에 대한 일반 질문
|
||||
|
|
@ -0,0 +1,332 @@
|
|||
---
|
||||
title: '조직을 위해 BMad 확장하기'
|
||||
description: 포크 없이 BMad를 재구성하는 여섯 가지 커스터마이징 패턴 - 에이전트 전반 규칙, 워크플로 관례, 외부 게시, 템플릿 교체, 에이전트 명단 변경, 고급 통합 패턴
|
||||
sidebar:
|
||||
order: 9
|
||||
---
|
||||
|
||||
BMad의 커스터마이징 영역을 사용하면 설치된 파일을 수정하거나 스킬을 포크하지 않고도 조직에 맞게 동작을 바꿀 수 있습니다. 이 가이드는 대부분의 엔터프라이즈 요구를 다루는 여섯 가지 레시피를 소개합니다.
|
||||
|
||||
:::note[필수 조건]
|
||||
|
||||
- 프로젝트에 BMad 설치([BMad 설치 방법](./install-bmad.md) 참고)
|
||||
- 커스터마이징 모델 이해([BMad 커스터마이징 방법](./customize-bmad.md) 참고)
|
||||
- PATH의 Python 3.11+(병합 스크립트용, stdlib만 사용하며 `pip install` 불필요)
|
||||
:::
|
||||
|
||||
:::tip[이 레시피 적용하기]
|
||||
아래 **스킬별 레시피**(레시피 1-4)는 `bmad-customize` 스킬을 실행하고 의도를 설명해 적용할 수 있습니다. 스킬이 적절한 영역을 고르고 오버라이드 파일을 작성하고 병합을 검증합니다. 레시피 5(에이전트 명단에 대한 중앙 설정 오버라이드)는 v1 스킬 범위 밖이라 직접 작성해야 합니다. 이 문서의 레시피는 *무엇을* 오버라이드할지의 참고 기준이고, `bmad-customize`는 에이전트/워크플로 영역의 *방법*을 처리합니다.
|
||||
:::
|
||||
|
||||
## 3계층 모델
|
||||
|
||||
레시피를 고르기 전에 오버라이드가 어디에 들어가는지 알아두세요.
|
||||
|
||||
| 계층 | 오버라이드 위치 | 범위 |
|
||||
| --- | --- | --- |
|
||||
| **에이전트**(예: Amelia, Mary, John) | `_bmad/custom/bmad-agent-{role}.toml`의 `[agent]` 섹션 | 에이전트를 통해 실행되는 **모든 워크플로**에 페르소나와 함께 이동 |
|
||||
| **워크플로**(예: 제품 개요, PRD 생성) | `_bmad/custom/{workflow-name}.toml`의 `[workflow]` 섹션 | 해당 워크플로 실행에만 적용 |
|
||||
| **중앙 설정** | `_bmad/custom/config.toml`의 `[agents.*]`, `[core]`, `[modules.*]` | 에이전트 명단(파티 모드, 회고, 도출에서 누가 가능한지), 조직 전체로 고정된 설치 시 설정 |
|
||||
|
||||
경험칙: 규칙이 엔지니어의 모든 개발 작업에 적용되어야 한다면 **개발자 에이전트**를 커스터마이즈하세요. 제품 개요를 쓸 때만 적용된다면 **제품 개요 워크플로**를 커스터마이즈하세요. *방에 누가 있는지*를 바꾸는 일(에이전트 이름 변경, 커스텀 목소리 추가, 공유 산출물 경로 강제)은 **중앙 설정**을 편집하세요.
|
||||
|
||||
## 레시피 1: 에이전트가 실행하는 모든 워크플로에 규칙 적용
|
||||
|
||||
**사용 사례:** 에이전트를 통해 실행되는 모든 워크플로가 같은 도구 사용과 외부 시스템 통합 규칙을 상속하도록 표준화합니다. 가장 영향력이 큰 패턴입니다.
|
||||
|
||||
**예시: Amelia 개발자 에이전트가 라이브러리 문서는 항상 Context7을 사용하고, 에픽 목록에 스토리가 없으면 Linear를 대체 경로로 사용합니다.**
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-agent-dev.toml
|
||||
|
||||
[agent]
|
||||
|
||||
# 모든 활성화에 적용됩니다. Amelia가 실행하는 모든 스킬
|
||||
# 스토리 구현, 빠른 개발, 스토리 생성, 코드 리뷰, QA 생성으로 이어집니다.
|
||||
persistent_facts = [
|
||||
"라이브러리 문서(React, TypeScript, Zod, Prisma 등)를 찾을 때는 학습 데이터 지식에 의존하기 전에 context7 MCP 도구(`mcp__context7__resolve_library_id`, 이후 `mcp__context7__get_library_docs`)를 호출하세요. 최신 문서가 기억된 API보다 우선합니다.",
|
||||
"스토리 참조를 {planning_artifacts}/epics-and-stories.md에서 찾을 수 없으면 사용자에게 확인을 요청하기 전에 스토리 ID나 제목으로 Linear의 `mcp__linear__search_issues`를 검색하세요. Linear가 일치 항목을 반환하면 권위 있는 스토리 소스로 취급하세요.",
|
||||
]
|
||||
```
|
||||
|
||||
**왜 동작하나요:** 두 문장이 조직의 모든 개발 워크플로를 재구성합니다. 워크플로마다 반복하지 않아도 되고 소스 변경도 없습니다. 저장소를 가져오는 모든 새 엔지니어가 자동으로 관례를 상속합니다.
|
||||
|
||||
**팀 파일 vs 개인 파일:**
|
||||
|
||||
- `bmad-agent-dev.toml`: git에 커밋하고 팀 전체에 적용합니다
|
||||
- `bmad-agent-dev.user.toml`: git에서 무시되며 개인 선호를 위에 덧씌웁니다
|
||||
|
||||
## 레시피 2: 특정 워크플로 안에서 조직 관례 강제
|
||||
|
||||
**사용 사례:** 워크플로 출력의 *내용*이 컴플라이언스, 감사, 후속 사용자의 요구를 만족하도록 만듭니다.
|
||||
|
||||
**예시: 모든 제품 개요에 컴플라이언스 필드가 포함되고 에이전트가 조직의 게시 관례를 압니다.**
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml
|
||||
|
||||
[workflow]
|
||||
|
||||
persistent_facts = [
|
||||
"모든 개요에는 '소유자', '대상 릴리스', '보안 리뷰 상태' 필드가 포함되어야 합니다.",
|
||||
"비상업용 개요(내부 도구, 리서치 프로젝트)도 사용자 가치 섹션은 포함해야 하지만 시장 차별화는 생략할 수 있습니다.",
|
||||
"file:{project-root}/docs/enterprise/brief-publishing-conventions.md",
|
||||
]
|
||||
```
|
||||
|
||||
**일어나는 일:** 사실 목록은 워크플로 활성화 3단계에서 로드됩니다. 에이전트가 제품 개요를 작성할 때 필수 필드와 엔터프라이즈 관례 문서를 알고 있습니다. 기본값(`file:{project-root}/**/project-context.md`)도 추가 방식이므로 계속 로드됩니다.
|
||||
|
||||
## 레시피 3: 완료된 출력을 외부 시스템에 게시
|
||||
|
||||
**사용 사례:** 워크플로가 출력을 만든 뒤 엔터프라이즈 기록 시스템(Confluence, Notion, SharePoint)에 자동 게시하고 후속 작업(Jira, Linear, Asana)을 엽니다.
|
||||
|
||||
**예시: 제품 개요를 Confluence에 자동 게시하고 선택적으로 Jira 에픽 생성을 제안합니다.**
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml
|
||||
|
||||
[workflow]
|
||||
|
||||
# 종료 후크입니다. 스칼라 값 오버라이드는 빈 기본값 전체를 교체합니다.
|
||||
on_complete = """
|
||||
게시하고 후속 작업을 제안하세요:
|
||||
|
||||
1. 이전 단계에서 확정된 개요 파일 경로를 읽습니다.
|
||||
2. 다음 인자로 `mcp__atlassian__confluence_create_page`를 호출합니다:
|
||||
- space: "PRODUCT"
|
||||
- parent: "Product Briefs"
|
||||
- title: 개요 제목
|
||||
- body: 개요의 Markdown 내용
|
||||
반환된 페이지 URL을 기록합니다.
|
||||
3. 사용자에게 "개요가 Confluence에 게시되었습니다: <url>"이라고 알립니다.
|
||||
4. "이 개요에 대한 Jira 에픽을 지금 만들까요?"라고 묻습니다.
|
||||
5. 사용자가 동의하면 다음 인자로 `mcp__atlassian__jira_create_issue`를 호출합니다:
|
||||
- type: "Epic"
|
||||
- project: "PROD"
|
||||
- summary: 개요 제목
|
||||
- description: 짧은 요약과 Confluence 페이지 링크
|
||||
에픽 키와 URL을 보고합니다.
|
||||
6. 동의하지 않으면 깔끔하게 종료합니다.
|
||||
|
||||
어느 MCP 도구든 실패하면 실패를 보고하고 개요 경로를 출력한 뒤
|
||||
사용자에게 수동 게시를 요청하세요.
|
||||
"""
|
||||
```
|
||||
|
||||
**왜 `activation_steps_append`가 아니라 `on_complete`인가요:** `on_complete`는 워크플로의 주 출력이 작성된 뒤 마지막 단계에서 정확히 한 번 실행됩니다. 산출물 게시에는 이 시점이 맞습니다. `activation_steps_append`는 워크플로가 일을 시작하기 전에 매 활성화마다 실행됩니다.
|
||||
|
||||
**절충점:**
|
||||
|
||||
- **Confluence 게시 작업은 비파괴적**이며 완료 시 항상 실행됩니다
|
||||
- **Jira 에픽 생성은 팀 전체에 보이고 스프린트 계획 신호를 만들기 때문에** 사용자 확인으로 통제합니다
|
||||
- **안전한 대체 경로:** MCP 도구가 실패하면 조용히 출력을 버리지 말고 사용자에게 맡깁니다
|
||||
|
||||
## 레시피 4: 자체 출력 템플릿으로 교체
|
||||
|
||||
**사용 사례:** 기본 출력 구조가 조직의 예상 형식과 맞지 않거나, 같은 저장소의 서로 다른 조직이 다른 템플릿을 필요로 합니다.
|
||||
|
||||
**예시: product-brief 워크플로가 엔터프라이즈 소유 템플릿을 보게 합니다.**
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml
|
||||
|
||||
[workflow]
|
||||
brief_template = "{project-root}/docs/enterprise/brief-template.md"
|
||||
```
|
||||
|
||||
**작동 방식:** 워크플로의 `customize.toml`은 `brief_template = "resources/brief-template.md"`(스킬 루트 기준 경로)를 제공합니다. 오버라이드는 `{project-root}` 아래 파일을 가리키므로 에이전트가 제공된 템플릿 대신 당신의 템플릿을 4단계에서 읽습니다.
|
||||
|
||||
**템플릿 작성 팁:**
|
||||
|
||||
- 템플릿은 `{project-root}/docs/` 또는 `{project-root}/_bmad/custom/templates/`에 두어 오버라이드 파일과 함께 버전 관리합니다
|
||||
- 제공된 템플릿과 같은 구조 관례(섹션 헤딩, 프런트매터)를 사용하세요. 에이전트는 그 구조에 적응합니다
|
||||
- 다중 조직 저장소에서는 `.user.toml`로 개별 팀이 커밋된 팀 파일을 건드리지 않고 자체 템플릿을 가리키게 할 수 있습니다
|
||||
|
||||
## 레시피 5: 에이전트 명단 커스터마이즈
|
||||
|
||||
**사용 사례:** 소스를 수정하거나 포크하지 않고 `bmad-party-mode`, `bmad-retrospective`, `bmad-advanced-elicitation` 같은 명단 기반 스킬에서 *방에 누가 있는지* 바꿉니다. 세 가지 흔한 변형은 다음과 같습니다.
|
||||
|
||||
### 5a. BMad 에이전트를 조직 전체에서 리브랜딩
|
||||
|
||||
실제 에이전트마다 설치 프로그램이 `module.yaml`에서 합성한 설명자가 있습니다. 이를 오버라이드하면 명단을 사용하는 모든 스킬에서 목소리와 표현 방식을 바꿀 수 있습니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.toml (커밋됨 - 모든 개발자에게 적용)
|
||||
|
||||
[agents.bmad-agent-analyst]
|
||||
description = "규제를 의식하는 비즈니스 분석가 Mary - Porter와 Minto의 사고법을 따르지만 FDA 감사 추적을 중시합니다. 사건 파일을 제시하는 포렌식 조사관처럼 말합니다."
|
||||
```
|
||||
|
||||
파티 모드는 새 설명으로 Mary를 생성합니다. 분석가 활성화 자체는 Mary의 동작이 스킬별 `customize.toml`에 있으므로 정상 동작합니다. 이 오버라이드는 **외부 스킬이 Mary를 어떻게 인식하고 소개하는지**를 바꾸며, 내부 작업 방식은 바꾸지 않습니다.
|
||||
|
||||
### 5b. 가상 또는 커스텀 에이전트 추가
|
||||
|
||||
스킬 폴더 없이 전체 설명자만으로 명단 기반 기능에 충분합니다. 파티 모드나 브레인스토밍 세션에서 페르소나 다양성을 줄 때 유용합니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.user.toml (개인용 - git에서 무시)
|
||||
|
||||
[agents.spock]
|
||||
team = "startrek"
|
||||
name = "스팍 사령관"
|
||||
title = "과학 장교"
|
||||
icon = "🖖"
|
||||
description = "논리를 우선하고 감정을 억제합니다. 관찰을 '흥미롭군요.'로 시작합니다. 절대 올림하지 않습니다. 직감에 의존하는 주장에 반대 관점을 제공합니다."
|
||||
|
||||
[agents.mccoy]
|
||||
team = "startrek"
|
||||
name = "레너드 맥코이 박사"
|
||||
title = "수석 의무관"
|
||||
icon = "⚕️"
|
||||
description = "시골 의사의 따뜻함과 짧은 인내심을 지녔습니다. '제기랄 짐, 난 ___가 아니라 의사라고.' 윤리 중심으로 스팍의 균형을 잡습니다."
|
||||
```
|
||||
|
||||
파티 모드에 "엔터프라이즈 승무원을 초대해 줘"라고 요청하면 `team = "startrek"`으로 필터링하고 스팍과 맥코이를 생성합니다. 요청하면 실제 BMad 에이전트(Mary, Amelia)도 같은 테이블에 앉을 수 있습니다.
|
||||
|
||||
### 5c. 팀 설치 설정 고정
|
||||
|
||||
설치 프로그램은 각 개발자에게 `planning_artifacts` 경로 같은 값을 묻습니다. 조직이 팀 전체에 하나의 답을 강제해야 한다면 중앙 설정에 고정하세요. 각 개발자의 로컬 프롬프트 답변은 해석 시점에 오버라이드됩니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.toml
|
||||
|
||||
[modules.bmm]
|
||||
planning_artifacts = "{project-root}/shared/planning"
|
||||
implementation_artifacts = "{project-root}/shared/implementation"
|
||||
|
||||
[core]
|
||||
document_output_language = "English"
|
||||
```
|
||||
|
||||
`user_name`, `communication_language`, `user_skill_level` 같은 개인 설정은 각 개발자의 `_bmad/config.user.toml` 아래에 둡니다. 팀 파일은 이를 건드리지 않는 것이 좋습니다.
|
||||
|
||||
**왜 중앙 설정인가요:** 에이전트별 파일은 *하나의* 에이전트가 활성화될 때 동작을 조정합니다. 중앙 설정은 명단을 사용하는 스킬이 명단을 조회할 때 *무엇을 보게 되는지*를 조정합니다. 어떤 에이전트가 존재하는지, 무엇이라고 불리는지, 어떤 팀에 속하는지, 저장소가 합의한 공유 설치 설정이 무엇인지입니다.
|
||||
|
||||
## IDE 세션 파일에 전역 규칙 보강
|
||||
|
||||
BMad 커스터마이징은 스킬이 활성화될 때 로드됩니다. 많은 IDE 도구는 스킬이 실행되기 전 **모든 세션 시작 시** 전역 지침 파일도 로드합니다(`CLAUDE.md`, `AGENTS.md`, `.cursor/rules/`, `.github/copilot-instructions.md` 등). BMad 스킬 밖에서도 지켜져야 하는 규칙은 거기에도 핵심만 반복하세요.
|
||||
|
||||
**중복해 둘 때:**
|
||||
|
||||
- 일반 채팅 대화(활성 스킬 없음)에서도 지켜야 할 만큼 중요한 규칙입니다
|
||||
- 학습 데이터 기반 기본값이 모델을 다른 방향으로 끌 수 있어 이중 안전장치가 필요합니다
|
||||
- 세션 파일을 부풀리지 않을 만큼 간결한 규칙입니다
|
||||
|
||||
**예시: 레시피 1의 dev 에이전트 규칙을 저장소의 `CLAUDE.md`에 한 줄로 보강.**
|
||||
|
||||
```markdown
|
||||
<!-- 라이브러리 문서를 읽을 때는 학습 데이터 지식에 의존하기 전에
|
||||
context7 MCP 도구(`mcp__context7__resolve_library_id` 이후
|
||||
`mcp__context7__get_library_docs`)를 거칩니다. -->
|
||||
```
|
||||
|
||||
한 문장이 매 세션에 로드됩니다. `bmad-agent-dev.toml` 커스터마이징과 짝을 이뤄 Amelia의 워크플로 안과 어시스턴트와의 임시 채팅 모두에 규칙을 적용합니다.
|
||||
|
||||
| 계층 | 범위 | 사용처 |
|
||||
| --- | --- | --- |
|
||||
| IDE 세션 파일(`CLAUDE.md` / `AGENTS.md`) | 모든 세션, 스킬 활성화 전 | BMad 밖에서도 살아야 하는 짧은 보편 규칙 |
|
||||
| BMad 에이전트 커스터마이징 | 에이전트가 실행하는 모든 워크플로 | 에이전트 페르소나별 동작 |
|
||||
| BMad 워크플로 커스터마이징 | 하나의 워크플로 실행 | 워크플로별 출력 형태, 게시 후크, 템플릿 |
|
||||
| BMad 중앙 설정 | 에이전트 명단 + 공유 설치 설정 | 방에 누가 있고 팀이 어떤 공유 경로를 쓰는지 |
|
||||
|
||||
IDE 파일은 **간결하게** 유지하세요. 잘 고른 열두 줄이 긴 목록보다 효과적입니다. 모델은 이를 매 턴 읽고, 노이즈는 신호를 밀어냅니다.
|
||||
|
||||
## 레시피 6: 고급 통합 패턴
|
||||
|
||||
몇몇 BMad 워크플로는 레시피 1-5에서 다룬 기본을 넘어 더 풍부한 설정 영역을 노출합니다. 온디맨드 지식 소스, 자동 출력 게시, 완료 시점 문서 표준, 교체 가능한 템플릿 같은 패턴은 여러 워크플로에 걸쳐 나타납니다. 어떤 필드를 노출하는지는 워크플로의 `customize.toml`을 확인하세요. 아래 예시는 모든 필드를 노출하는 `bmad-prd`를 사용하지만, 같은 패턴은 해당 필드가 있는 어디서나 적용됩니다.
|
||||
|
||||
### 온디맨드 지식 소스(`external_sources`)
|
||||
|
||||
워크플로를 내부 지식 베이스, 경쟁사 데이터베이스, 컴플라이언스 참조에 연결합니다. 에이전트는 대화에서 일치하는 필요가 나타날 때만 온디맨드로 참조하고 선제적으로 호출하지 않습니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-prd.toml (external_sources를 노출하는 모든 워크플로에서 같은 패턴 사용)
|
||||
|
||||
[workflow]
|
||||
external_sources = [
|
||||
"사용자가 경쟁사나 시장 세그먼트를 언급하면 차별화 섹션 초안을 작성하기 전에 corp:competitive_db(category={project_name})를 조회하세요.",
|
||||
"규제 도메인(헬스케어, 핀테크, 교육)에서는 도메인별 섹션 초안을 작성하기 전에 corp:compliance_reference를 참고하세요.",
|
||||
]
|
||||
```
|
||||
|
||||
각 항목은 MCP 도구 이름, 트리거 조건, 도구에 필요한 필드를 자연어로 지정합니다. 런타임에 도구가 없으면 워크플로는 표준 동작으로 돌아가고 공백을 알립니다.
|
||||
|
||||
### 자동 출력 게시(`external_handoffs`)
|
||||
|
||||
워크플로가 완료된 뒤 완성된 산출물을 외부 기록 시스템으로 보냅니다. 레시피 3의 `on_complete`와 달리 `external_handoffs`는 전용 추가 배열입니다. 팀 항목이 쌓이고 각 전달 작업은 도구가 없을 때 점진적 기능 저하와 함께 독립 실행됩니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-prd.toml (external_handoffs를 노출하는 모든 워크플로에서 같은 패턴 사용)
|
||||
|
||||
[workflow]
|
||||
external_handoffs = [
|
||||
"완료 후 corp:confluence_upload(space_key='PROD', parent_page='PRDs', label='prd', author={user_name})로 prd.md와 addendum.md를 Confluence에 업로드하세요. 반환된 페이지 URL을 기록하고 보여 주세요.",
|
||||
"notion:create_page(database_id='abc123', title='PRD: ' + {project_name})로 Notion에도 복제하세요.",
|
||||
]
|
||||
```
|
||||
|
||||
지정된 도구가 없으면 전달 작업은 건너뛰고 표시됩니다. 로컬 파일은 항상 존재합니다.
|
||||
|
||||
### 완료 시점 문서 표준(`doc_standards`)
|
||||
|
||||
사람이 읽을 문서에 조직 작성 표준을 완료 시점에 적용합니다. 내용이 완료된 후, 사용자가 출력을 보기 전입니다. 각 항목은 `skill:`, `file:`, 일반 텍스트 지시문일 수 있으며 각 검토 단계는 병렬 서브에이전트로 실행됩니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-prd.toml (doc_standards를 노출하는 모든 워크플로에서 같은 패턴 사용)
|
||||
|
||||
[workflow]
|
||||
doc_standards = [
|
||||
"file:{project-root}/docs/enterprise/voice-and-tone.md",
|
||||
"모든 날짜는 ISO 8601 형식(YYYY-MM-DD)을 사용해야 합니다.",
|
||||
"'활용'을 사용한 곳은 모두 '사용'으로 바꾸세요.",
|
||||
]
|
||||
```
|
||||
|
||||
`doc_standards`는 추가 배열입니다. 팀 항목은 워크플로가 제공하는 기본값 위에 쌓입니다. 넓은 구조 검토가 좁은 문장 검토보다 먼저 와야 합니다.
|
||||
|
||||
### 교체 가능한 템플릿과 체크리스트
|
||||
|
||||
구조화된 문서를 만드는 워크플로는 일반적으로 템플릿과 체크리스트 경로를 오버라이드 가능한 스칼라 값으로 노출합니다. `{project-root}` 아래 조직 소유 파일을 가리키면 소스를 수정하지 않고 다른 구조를 강제할 수 있습니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-prd.toml
|
||||
|
||||
[workflow]
|
||||
# 규제 산업용 PRD 구조
|
||||
prd_template = "{project-root}/docs/enterprise/prd-template-hipaa.md"
|
||||
|
||||
# 조직별 검증 기준
|
||||
validation_checklist = "{project-root}/docs/enterprise/prd-checklist-regulated.md"
|
||||
```
|
||||
|
||||
에이전트는 템플릿이 정의한 구조에 적응합니다. 템플릿은 `{project-root}/docs/` 또는 `{project-root}/_bmad/custom/templates/` 아래에 두어 오버라이드 파일과 함께 버전 관리하세요. 다중 조직 저장소에서는 `.user.toml`로 개별 팀이 커밋된 팀 파일을 건드리지 않고 자체 템플릿을 가리키게 할 수 있습니다.
|
||||
|
||||
## 레시피 조합
|
||||
|
||||
여섯 레시피는 모두 조합됩니다. 현실적인 엔터프라이즈용 `bmad-product-brief` 오버라이드는 한 파일에서 `persistent_facts`(레시피 2), `on_complete`(레시피 3), `brief_template`(레시피 4)을 설정할 수 있습니다. 에이전트 수준 규칙(레시피 1)은 에이전트 이름의 별도 파일에 있고, 중앙 설정(레시피 5)은 공유 명단과 팀 설정을 고정하며, 고급 통합 패턴(레시피 6)은 외부 소스와 전달 작업을 설정합니다. 모든 계층은 나란히 적용됩니다.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml (워크플로 수준)
|
||||
|
||||
[workflow]
|
||||
persistent_facts = ["..."]
|
||||
brief_template = "{project-root}/docs/enterprise/brief-template.md"
|
||||
on_complete = """ ... """
|
||||
```
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-agent-analyst.toml (에이전트 수준 - Mary가 product-brief를 실행)
|
||||
|
||||
[agent]
|
||||
persistent_facts = ["도메인이 헬스케어, 금융, 아동 데이터와 관련되면 항상 '규제 검토' 섹션을 포함하세요."]
|
||||
```
|
||||
|
||||
결과: Mary는 페르소나 활성화에서 규제 리뷰 규칙을 로드합니다. 사용자가 제품 개요 메뉴 항목을 선택하면 워크플로는 자체 관례를 그 위에 로드하고 엔터프라이즈 템플릿에 작성한 뒤 완료 시 Confluence에 게시합니다. 모든 계층이 함께 작동하며 BMad 소스는 수정하지 않습니다.
|
||||
|
||||
## 문제 해결
|
||||
|
||||
**오버라이드가 적용되지 않나요?** 파일이 `_bmad/custom/` 아래 정확한 스킬 디렉터리 이름으로 있는지 확인하세요(예: `bmad-agent-dev.toml`, `bmad-dev.toml` 아님). [BMad 커스터마이징 방법](./customize-bmad.md)을 참고하세요.
|
||||
|
||||
**MCP 도구 이름을 모르겠나요?** 현재 세션에서 MCP 서버가 노출하는 정확한 이름을 사용하세요. 확실하지 않다면 Claude Code에 사용 가능한 MCP 도구 목록을 보여달라고 요청하세요. `persistent_facts`나 `on_complete`에 하드코딩한 이름은 MCP 서버가 연결되어 있지 않으면 동작하지 않습니다.
|
||||
|
||||
**패턴이 내 설정에 맞지 않나요?** 위 레시피는 예시입니다. 기반 메커니즘(3계층 병합, 구조 규칙, 에이전트가 여러 워크플로에 걸쳐 동작하는 방식)은 훨씬 많은 패턴을 지원합니다. 필요에 맞게 조합하세요.
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
---
|
||||
title: 'BMad에 대한 답을 얻는 방법'
|
||||
description: LLM을 사용해 BMad 관련 질문에 빠르게 답하기
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
BMad의 내장 도움말, 소스 문서, 커뮤니티를 사용해 답을 얻으세요. 가장 빠른 방법부터 가장 꼼꼼한 방법까지 순서대로 소개합니다.
|
||||
|
||||
## 1. BMad 도움말에게 묻기
|
||||
|
||||
답을 얻는 가장 빠른 방법입니다. `bmad-help` 스킬은 AI 세션에서 바로 사용할 수 있으며 질문의 80% 이상을 처리합니다. 프로젝트를 검사하고 완료한 작업을 확인한 뒤 다음에 무엇을 해야 할지 알려줍니다.
|
||||
|
||||
```
|
||||
bmad-help SaaS 아이디어가 있고 기능도 모두 알고 있습니다. 어디서 시작하나요?
|
||||
bmad-help UX 설계에는 어떤 선택지가 있나요?
|
||||
bmad-help PRD 워크플로에서 막혔어요
|
||||
```
|
||||
|
||||
:::tip
|
||||
플랫폼에 따라 `/bmad-help` 또는 `$bmad-help`도 사용할 수 있지만, 대부분은 `bmad-help`만으로 동작합니다.
|
||||
:::
|
||||
|
||||
## 2. 소스로 더 깊게 들어가기
|
||||
|
||||
BMad 도움말은 설치된 설정을 바탕으로 답합니다. BMad의 내부 구조, 역사, 아키텍처에 대한 질문이 있거나 설치 전에 BMad를 조사하고 있다면 AI가 소스를 직접 보게 하세요.
|
||||
|
||||
[BMAD-METHOD 저장소](https://github.com/bmad-code-org/BMAD-METHOD)를 복제하거나 열고 AI에게 질문하세요. 에이전트 기능이 있는 도구(Claude Code, Cursor, Windsurf 등)는 소스를 읽고 직접 답할 수 있습니다.
|
||||
|
||||
:::note[예시]
|
||||
**Q:** "BMad로 무언가를 가장 빠르게 만드는 방법을 알려줘"
|
||||
|
||||
**A:** 빠른 흐름을 사용하세요. `bmad-quick-dev`를 실행하면 의도를 명확히 하고, 계획하고, 구현하고, 리뷰하고, 결과를 하나의 워크플로에서 제시합니다. 전체 계획 단계를 건너뜁니다.
|
||||
:::
|
||||
|
||||
**더 좋은 답을 위한 팁:**
|
||||
|
||||
- **구체적으로 묻기** - "PRD 워크플로 3단계가 무엇을 하나요?"가 "PRD는 어떻게 작동하나요?"보다 좋습니다
|
||||
- **놀라운 주장은 확인하기** - LLM은 가끔 틀립니다. 소스 파일을 확인하거나 Discord에서 물어보세요
|
||||
|
||||
### 에이전트를 쓰지 않는다면 문서 사이트 사용
|
||||
|
||||
AI가 로컬 파일을 읽을 수 없다면(ChatGPT, Claude.ai 등), 세션에 [llms-full.txt](https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt)를 가져오세요. BMad 문서의 단일 파일 스냅샷입니다.
|
||||
|
||||
## 3. 사람에게 묻기
|
||||
|
||||
BMad 도움말이나 소스로도 답을 얻지 못했다면, 이제 훨씬 더 좋은 질문을 갖게 된 것입니다.
|
||||
|
||||
| 채널 | 사용처 |
|
||||
| --- | --- |
|
||||
| `help-requests` 포럼 | 질문 |
|
||||
| `#suggestions-feedback` | 아이디어와 기능 요청 |
|
||||
|
||||
**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
||||
|
||||
_당신이_
|
||||
_막힌 채_
|
||||
_줄 서서_
|
||||
_기다린다면_
|
||||
_누구를 기다리나요?_
|
||||
|
||||
_소스는_
|
||||
_이미 거기_
|
||||
_눈앞에 있습니다._
|
||||
|
||||
_당신의_
|
||||
_기계를 가리키고._
|
||||
_풀어 주세요._
|
||||
|
||||
_읽고._
|
||||
_말합니다._
|
||||
_물어보세요._
|
||||
|
||||
_내일을_
|
||||
_기다릴 이유가 있나요_
|
||||
_오늘 이미_
|
||||
_할 수 있는데?_
|
||||
|
||||
_—Claude_
|
||||
|
|
@ -0,0 +1,266 @@
|
|||
---
|
||||
title: 'BMad 설치 방법'
|
||||
description: 로컬 개발, 팀, CI를 위해 BMad를 설치, 업데이트, 고정합니다
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
프로젝트에 BMad를 설정하려면 `npx bmad-method install`을 사용하세요. 하나의 명령으로 최초 설치, 업그레이드, 채널 전환, 스크립트 기반 CI 실행을 처리합니다. 이 페이지에서 그 전체를 다룹니다.
|
||||
|
||||
## 사용 시점
|
||||
|
||||
- BMad로 새 프로젝트를 시작합니다
|
||||
- 기존 설치에 모듈을 추가하거나 제거합니다
|
||||
- 모듈을 main 브랜치 최신 커밋으로 전환하거나 특정 릴리스에 고정합니다
|
||||
- CI 파이프라인, Dockerfile, 엔터프라이즈 배포를 위해 설치를 스크립트화합니다
|
||||
|
||||
:::note[필수 조건]
|
||||
|
||||
- **Node.js** 20+ (설치 프로그램에 필요)
|
||||
- **Git** (외부 모듈 복제용)
|
||||
- Claude Code 또는 Cursor 같은 **AI 도구**(지원 도구 목록은 `npx bmad-method install --list-tools`로 확인)
|
||||
|
||||
:::
|
||||
|
||||
## 최초 설치(빠른 경로)
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
대화형 흐름은 다섯 가지를 묻습니다.
|
||||
|
||||
1. 설치 디렉터리(기본값은 현재 작업 디렉터리)
|
||||
2. 설치할 모듈(core, bmm, bmb, cis, gds, tea 체크박스)
|
||||
3. **"Ready to install (all stable)?"** - **Yes**를 선택하면 모든 외부 모듈의 최신 릴리스 태그를 사용합니다
|
||||
4. 연동할 AI 도구/IDE(`claude-code`, `cursor` 등)
|
||||
5. 모듈별 설정(이름, 언어, 출력 폴더)
|
||||
|
||||
기본값을 받아들이면 선택한 도구에 맞게 설정된 각 모듈의 최신 안정 릴리스가 설치됩니다.
|
||||
|
||||
:::tip[최신 사전 릴리스만 원하나요?]
|
||||
|
||||
```bash
|
||||
npx bmad-method@next install
|
||||
```
|
||||
|
||||
core와 bmm의 더 새로운 스냅샷이 포함된 사전 릴리스 설치 프로그램을 실행합니다. 변화는 더 잦지만 개발과 릴리스 사이의 지연이 줄어듭니다.
|
||||
:::
|
||||
|
||||
## 특정 버전 선택
|
||||
|
||||
디스크에 무엇이 설치되는지는 두 개의 독립 축으로 제어됩니다.
|
||||
|
||||
### 축 1: 외부 모듈 채널
|
||||
|
||||
bmb, cis, gds, tea, 커뮤니티 모듈 등 모든 외부 모듈은 세 채널 중 하나로 설치됩니다.
|
||||
|
||||
| 채널 | 설치되는 것 | 누가 선택하나 |
|
||||
| --- | --- | --- |
|
||||
| `stable`(기본값) | 가장 높은 시맨틱 버전 릴리스 태그. `v2.0.0-alpha.1` 같은 사전 릴리스는 제외됩니다. | 대부분의 사용자 |
|
||||
| `next` | 설치 시점의 main 브랜치 최신 커밋 | 기여자, 초기 채택자 |
|
||||
| `pinned` | 지정한 특정 태그 | 엔터프라이즈 설치, CI 재현성 |
|
||||
|
||||
채널은 모듈마다 정할 수 있습니다. bmb는 `next`로 두고 cis는 `stable`로 둘 수 있습니다. 아래 플래그로 자유롭게 섞을 수 있습니다.
|
||||
|
||||
### 축 2: 설치 프로그램 바이너리 버전
|
||||
|
||||
`bmad-method` npm 패키지 자체에는 두 npm 배포 태그(dist-tag)가 있습니다.
|
||||
|
||||
| 명령 | 받는 것 |
|
||||
| --- | --- |
|
||||
| `npx bmad-method install`(`@latest`) | 최신 안정 설치 프로그램 릴리스 |
|
||||
| `npx bmad-method@next install` | main에 푸시될 때마다 자동 배포되는 최신 사전 릴리스 설치 프로그램 |
|
||||
|
||||
**설치 프로그램 바이너리가 core와 bmm 버전을 결정합니다.** 이 두 모듈은 별도 저장소에서 복제되지 않고 설치 프로그램 패키지 안에 번들됩니다.
|
||||
|
||||
### core와 bmm에 자체 채널이 없는 이유
|
||||
|
||||
두 모듈은 실행한 설치 프로그램 바이너리에 묶여 있습니다.
|
||||
|
||||
- `npx bmad-method install` → 최신 안정 core 및 bmm
|
||||
- `npx bmad-method@next install` → 사전 릴리스 core 및 bmm
|
||||
- `node /path/to/local-checkout/tools/installer/bmad-cli.js install` → 로컬 체크아웃의 내용
|
||||
|
||||
`--pin bmm=v6.3.0`과 `--next=bmm`은 번들 모듈에는 효과가 없고, 시도하면 설치 프로그램이 경고합니다. 향후 릴리스에서 bmm가 설치 프로그램 패키지에서 분리되면 bmb처럼 적절한 채널 선택기를 갖게 됩니다.
|
||||
|
||||
## 기존 설치 업데이트
|
||||
|
||||
이미 `_bmad/`가 있는 디렉터리에서 `npx bmad-method install`을 실행하면 메뉴가 나타납니다.
|
||||
|
||||
| 실제 메뉴 선택 | 하는 일 |
|
||||
| --- | --- |
|
||||
| **Quick Update** | 기존 설정으로 설치를 다시 실행합니다. 파일을 새로 고치고, 안정 채널의 패치와 마이너 업그레이드를 적용하며, 메이저 업그레이드는 거부합니다. 빠르고 비대화형입니다. |
|
||||
| **Modify Install** | 전체 대화형 흐름입니다. 모듈을 추가/제거하고, 설정을 다시 구성하고, 기존 모듈 채널을 검토하고 전환할 수 있습니다. |
|
||||
|
||||
### 업그레이드 프롬프트
|
||||
|
||||
`Modify`가 `stable`에 설치된 모듈의 새 안정 태그를 감지하면 변경 폭을 분류하고 그에 맞게 묻습니다.
|
||||
|
||||
| 업그레이드 유형 | 예시 | 기본값 |
|
||||
| --- | --- | --- |
|
||||
| 패치 | v1.7.0 → v1.7.1 | `Y` |
|
||||
| 마이너 | v1.7.0 → v1.8.0 | `Y` |
|
||||
| 메이저 | v1.7.0 → v2.0.0 | **`N`** |
|
||||
|
||||
메이저 업그레이드는 호환성 깨짐이 예상치 못한 "불안정"으로 나타나는 경우가 많기 때문에 기본값이 `N`입니다. 프롬프트에는 변경 내용을 읽을 수 있는 GitHub 릴리스 노트 URL이 포함됩니다.
|
||||
|
||||
`--yes`에서는 패치와 마이너 업그레이드가 자동 적용됩니다. 메이저 업그레이드는 고정된 채로 유지됩니다. 비대화형으로 수락하려면 `--pin <code>=<new-tag>`를 전달하세요.
|
||||
|
||||
### 모듈 채널 전환
|
||||
|
||||
**대화형:** **Modify**를 선택하고 `"Review channel assignments?"`에 **Yes**로 답한 뒤, 각 외부 모듈에서 Keep, Switch to stable, Switch to next, Pin to a tag 중 하나를 선택합니다.
|
||||
|
||||
**플래그로:** 다음 섹션의 레시피가 일반적인 경우를 다룹니다.
|
||||
|
||||
## Headless CI
|
||||
|
||||
### 플래그 참조
|
||||
|
||||
| 플래그 | 목적 |
|
||||
| --- | --- |
|
||||
| `--yes`, `-y` | 모든 프롬프트를 건너뛰고 플래그 값과 기본값을 수락합니다 |
|
||||
| `--directory <path>` | 이 디렉터리에 설치합니다(기본값: 현재 작업 디렉터리) |
|
||||
| `--modules <a,b,c>` | 정확한 모듈 집합입니다. core는 자동 추가됩니다. 증분 목록이 아니므로 유지하려는 모든 것을 나열하세요 |
|
||||
| `--tools <a,b>` | IDE/도구 선택입니다. 새 `--yes` 설치에는 필수입니다. 유효 ID는 `--list-tools`로 확인하세요 |
|
||||
| `--list-tools` | 지원되는 모든 도구/IDE ID와 대상 디렉터리를 출력하고 종료합니다 |
|
||||
| `--action <type>` | `install`, `update`, `quick-update`. 기본값은 기존 설치 상태에 따라 달라집니다 |
|
||||
| `--custom-source <urls>` | Git URL 또는 로컬 경로에서 커스텀 모듈을 설치합니다 |
|
||||
| `--channel <stable\|next>` | 모든 외부 모듈에 적용합니다(`--all-stable` / `--all-next` 별칭) |
|
||||
| `--all-stable` | `--channel=stable` 별칭 |
|
||||
| `--all-next` | `--channel=next` 별칭 |
|
||||
| `--next=<code>` | 한 모듈을 next 채널에 둡니다. 반복 가능합니다 |
|
||||
| `--pin <code>=<tag>` | 한 모듈을 특정 태그에 고정합니다. 반복 가능합니다 |
|
||||
| `--set <module>.<key>=<value>` | 모듈 설정 옵션을 비대화형으로 설정합니다(권장, [모듈 설정 오버라이드](#모듈-설정-오버라이드) 참고). 반복 가능합니다 |
|
||||
| `--list-options [module]` | 내장 및 로컬 캐시된 공식 모듈의 모든 `--set` 키를 출력하고 종료합니다. 모듈 코드를 전달하면 범위를 좁힙니다 |
|
||||
| `--user-name`, `--communication-language`, `--document-output-language`, `--output-folder` | `--set core.<key>=<value>`와 동등한 레거시 단축 플래그입니다(계속 지원) |
|
||||
|
||||
플래그가 겹칠 때 우선순위는 `--pin` > `--next=` > `--channel` / `--all-*` > 레지스트리 기본값(`stable`)입니다.
|
||||
|
||||
:::note[해결 예시]
|
||||
`--all-next --pin cis=v0.2.0`은 bmb, gds, tea를 next에 두고 cis를 v0.2.0에 고정합니다.
|
||||
:::
|
||||
|
||||
### 레시피
|
||||
|
||||
**기본 설치 - 모든 것을 최신 안정 버전으로:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install --yes --modules bmm,bmb,cis --tools claude-code
|
||||
```
|
||||
|
||||
**엔터프라이즈 고정 - 바이트 단위로 재현 가능:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install --yes \
|
||||
--modules bmm,bmb,cis \
|
||||
--pin bmb=v1.7.0 --pin cis=v0.2.0 \
|
||||
--tools claude-code
|
||||
```
|
||||
|
||||
**최신 개발판 - 외부 모듈을 main 브랜치 최신 커밋으로:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install --yes --modules bmm,bmb --all-next --tools claude-code
|
||||
```
|
||||
|
||||
**기존 설치에 모듈 추가**(나머지는 유지):
|
||||
|
||||
```bash
|
||||
npx bmad-method install --yes --action update \
|
||||
--modules bmm,bmb,gds
|
||||
```
|
||||
|
||||
`--tools`는 의도적으로 생략했습니다. `--action update`는 최초 설치 때 설정한 도구를 재사용합니다.
|
||||
|
||||
**채널 혼합 - bmb는 next, gds는 stable:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install --yes --action update \
|
||||
--modules bmm,bmb,cis,gds \
|
||||
--next=bmb
|
||||
```
|
||||
|
||||
### 모듈 설정 오버라이드
|
||||
|
||||
`--set <module>.<key>=<value>`는 모듈 설정 옵션을 비대화형으로 설정합니다. 반복 가능하고 앞으로 추가될 모듈에도 같은 방식으로 적용됩니다. 이 플래그는 설치 후 패치로 적용됩니다. 설치 프로그램이 정상 흐름을 먼저 실행한 뒤 `--set`이 각 값을 `_bmad/config.toml`(팀 범위) 또는 `_bmad/config.user.toml`(사용자 범위), 그리고 `_bmad/<module>/config.yaml`에 갱신 또는 삽입하여 선언된 값이 다음 설치로 이어지게 합니다.
|
||||
|
||||
**예시 - 명시적 프로젝트 지식과 스킬 수준으로 bmm 설치:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install --yes \
|
||||
--modules bmm \
|
||||
--tools claude-code \
|
||||
--set bmm.project_knowledge=research \
|
||||
--set bmm.user_skill_level=expert
|
||||
```
|
||||
|
||||
**모듈에서 사용할 수 있는 키 찾기:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install --list-options bmm
|
||||
```
|
||||
|
||||
`--list-options`(인자 없음)는 설치 프로그램이 로컬에서 찾을 수 있는 모든 키를 나열합니다. 내장 모듈(`core`, `bmm`)과 현재 캐시된 공식 모듈이 포함됩니다. 캐시는 머신별이고 지워질 수 있으므로, 이전에 설치한 공식 모듈도 새 체크아웃이나 임시 CI 작업자에서는 다시 설치되기 전까지 나타나지 않습니다. 커뮤니티 및 커스텀 모듈은 여기서 열거되지 않습니다. 모듈의 `module.yaml`을 직접 읽어 선언된 키를 확인하세요.
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
- **경로 선택.** 패치 단계는 먼저 `config.user.toml`에서 `[modules.<module>] <key>`(또는 `[core] <key>`)를 찾고, 있으면 그 파일을 업데이트합니다. 그렇지 않으면 팀 범위 `config.toml`에 씁니다. 그래서 `core.user_name`, `bmm.user_skill_level` 같은 사용자 범위 키는 `config.user.toml`에, 팀 범위 키는 `config.toml`에 들어갑니다.
|
||||
- **그대로 쓰는 값.** 값은 제공한 그대로 기록됩니다. `result:` 템플릿 렌더링은 없습니다. 렌더링된 형태(예: `{project-root}/research`)를 원하면 명시적으로 전달하세요: `--set bmm.project_knowledge='{project-root}/research'`.
|
||||
- **다음 설치로 이어지는 선언된 키.** `module.yaml`에 선언된 키 값은 `_bmad/<module>/config.yaml`에도 쓰이므로 다음 설치 때 프롬프트 기본값으로 살아남습니다.
|
||||
- **다음 설치로 이어지지 않는 미선언 키.** 모듈 스키마가 선언하지 않은 키 값은 현재 설치의 `config.toml`에 들어가지만 다음 설치 때 다시 생성되지 않습니다(매니페스트 작성기의 엄격한 스키마 분리 단계가 알 수 없는 키를 떨어뜨립니다). 계속 유지해야 한다면 `--set`을 다시 전달하거나 `_bmad/config.toml`을 직접 수정하세요.
|
||||
- **검증 없음.** `single-select` 값은 허용 선택지와 대조하지 않고, 알 수 없는 키도 거부하지 않습니다. 지정한 값이 그대로 쓰입니다.
|
||||
- **`--modules`에 없는 모듈.** 포함하지 않은 모듈에 값을 설정하면 경고를 출력하고 값은 버려집니다(설치되지 않은 모듈용 파일은 생성되지 않습니다).
|
||||
|
||||
레거시 core 단축 플래그(`--user-name`, `--output-folder` 등)은 하위 호환성을 위해 계속 동작하고 문서화되어 있지만, `--set core.user_name=...`과 동등합니다.
|
||||
|
||||
:::note[quick-update와 함께 동작]
|
||||
`--set`은 설치 후 패치이므로 작업 유형과 관계없이 동일하게 적용됩니다. `bmad install --action quick-update` 또는 기존 설치에서 `--yes`(기본이 quick-update)로 실행해도 일반 설치처럼 마지막에 중앙 설정 파일을 패치합니다.
|
||||
:::
|
||||
|
||||
:::caution[공유 IP의 요청 제한]
|
||||
익명 GitHub API 호출은 IP당 시간당 60회로 제한됩니다. 한 번의 설치는 안정 태그를 확인하기 위해 외부 모듈마다 API를 한 번 호출합니다. NAT 뒤의 사무실, CI 러너 풀, VPN은 함께 이 한도를 소진할 수 있습니다.
|
||||
|
||||
환경 변수에 `GITHUB_TOKEN=<personal access token>`을 설정하면 계정당 시간당 5000회로 한도가 올라갑니다. 공개 저장소 읽기용 개인 액세스 토큰(PAT)이면 충분하며 범위는 필요 없습니다.
|
||||
:::
|
||||
|
||||
## 설치된 내용
|
||||
|
||||
설치 후 `_bmad/_config/manifest.yaml`은 디스크에 있는 내용을 정확히 기록합니다.
|
||||
|
||||
```yaml
|
||||
modules:
|
||||
- name: bmb
|
||||
version: v1.7.0 # 태그 또는 next용 "main"
|
||||
channel: stable # stable | next | pinned
|
||||
sha: 86033fc9aeae2ca6d52c7cdb675c1f4bf17fc1c1
|
||||
source: external
|
||||
repoUrl: https://github.com/bmad-code-org/bmad-builder
|
||||
```
|
||||
|
||||
`sha` 필드는 git 기반 모듈(외부, 커뮤니티, URL 기반 커스텀)에 기록됩니다. 번들 모듈(core, bmm)과 로컬 경로 커스텀 모듈에는 없습니다. 그 코드는 복제 가능한 참조가 아니라 설치 프로그램 바이너리 또는 파일시스템 상태에 따라 달라집니다.
|
||||
|
||||
머신 간 재현성을 위해 같은 `--modules` 명령을 다시 실행하는 것에 의존하지 마세요. 안정 채널 설치는 **설치 시점**의 가장 높은 릴리스 태그로 해석되므로 나중에 다시 실행하면 그 사이 릴리스된 버전으로 설치됩니다. `manifest.yaml`의 기록된 태그를 대상 머신에서 명시적 `--pin` 플래그로 바꾸세요. 예:
|
||||
|
||||
```bash
|
||||
npx bmad-method install --yes --modules bmb,cis \
|
||||
--pin bmb=v1.7.0 --pin cis=v0.4.2 --tools claude-code
|
||||
```
|
||||
|
||||
## 문제 해결
|
||||
|
||||
### "Could not resolve stable tag" 또는 "API rate limit exceeded"
|
||||
|
||||
GitHub의 익명 시간당 60회 한도에 도달했습니다. `GITHUB_TOKEN`을 설정하고 다시 시도하세요. 이미 토큰이 있다면 만료되었거나 해당 토큰 자체의 한도에 걸렸을 수 있습니다. 다른 토큰을 시도하거나 시간당 한도가 초기화될 때까지 기다리세요.
|
||||
|
||||
### "Tag 'vX.Y.Z' not found"
|
||||
|
||||
`--pin`에 전달한 태그가 모듈 저장소에 없습니다. GitHub의 저장소 릴리스 페이지에서 유효한 태그를 확인하세요.
|
||||
|
||||
### 고정 설치가 계속 업그레이드됨
|
||||
|
||||
고정 설치는 업그레이드되지 않습니다. `Quick Update`는 안정 채널의 패치와 마이너만 적용하며 `pinned`나 `next`는 건드리지 않습니다. 고정 설치가 바뀌었다면 `_bmad/_config/manifest.yaml`을 여세요. 명시적으로 플래그로 오버라이드하지 않는 한 `channel: pinned`와 고정된 `version`, `sha`가 실행 간 유지되어야 합니다.
|
||||
|
||||
### `--pin bmm=X`가 아무 것도 하지 않음
|
||||
|
||||
bmm은 번들 모듈입니다. `--pin`과 `--next=`가 적용되지 않습니다. 사전 릴리스 core/bmm을 원하면 `npx bmad-method@next install`을 사용하거나 bmad-bmm 저장소를 체크아웃하고 설치 프로그램을 로컬에서 실행해 아직 릴리스되지 않은 변경을 받으세요.
|
||||
|
|
@ -0,0 +1,181 @@
|
|||
---
|
||||
title: '커스텀 및 커뮤니티 모듈 설치'
|
||||
description: 커뮤니티 레지스트리, Git 저장소, 로컬 경로에서 서드파티 모듈을 설치합니다
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
BMad 설치 프로그램을 사용해 커뮤니티 레지스트리, 서드파티 Git 저장소, 로컬 파일 경로에서 모듈을 추가하세요.
|
||||
|
||||
## 사용 시점
|
||||
|
||||
- BMad 레지스트리에서 커뮤니티 기여 모듈을 설치합니다
|
||||
- 서드파티 Git 저장소(GitHub, GitLab, Bitbucket, 자체 호스팅)에서 모듈을 설치합니다
|
||||
- BMad 빌더로 로컬에서 개발 중인 모듈을 테스트합니다
|
||||
- 비공개 또는 자체 호스팅 Git 서버에서 모듈을 설치합니다
|
||||
|
||||
:::note[필수 조건]
|
||||
[Node.js](https://nodejs.org) v20+와 `npx`(npm에 포함)가 필요합니다. 커스텀 및 커뮤니티 모듈은 새 설치 중 선택하거나 기존 설치에 추가할 수 있습니다.
|
||||
:::
|
||||
|
||||
## 커뮤니티 모듈
|
||||
|
||||
커뮤니티 모듈은 [BMad 플러그인 마켓플레이스](https://github.com/bmad-code-org/bmad-plugins-marketplace)에서 선별됩니다. 카테고리별로 구성되고 안전을 위해 승인된 커밋에 고정됩니다.
|
||||
|
||||
### 1. 설치 프로그램 실행
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
### 2. 커뮤니티 카탈로그 둘러보기
|
||||
|
||||
공식 모듈을 선택한 뒤 설치 프로그램이 묻습니다.
|
||||
|
||||
```
|
||||
Would you like to browse community modules?
|
||||
```
|
||||
|
||||
카탈로그 브라우저로 들어가려면 **Yes**를 선택하세요. 할 수 있는 일은 다음과 같습니다.
|
||||
|
||||
- 카테고리별 탐색
|
||||
- 추천 모듈 보기
|
||||
- 사용 가능한 모든 모듈 보기
|
||||
- 키워드로 검색
|
||||
|
||||
### 3. 모듈 선택
|
||||
|
||||
어떤 카테고리에서든 모듈을 선택하세요. 설치 프로그램은 설명, 버전, 신뢰 등급을 보여줍니다. 이미 설치된 모듈은 업데이트 대상으로 미리 체크됩니다.
|
||||
|
||||
### 4. 설치 계속
|
||||
|
||||
커뮤니티 모듈을 선택하면 설치 프로그램은 커스텀 소스, 도구/IDE 설정, 나머지 설치 흐름으로 이어집니다.
|
||||
|
||||
## 커스텀 소스(Git URL과 로컬 경로)
|
||||
|
||||
커스텀 모듈은 어떤 Git 저장소나 로컬 디렉터리에서든 올 수 있습니다. 설치 프로그램은 소스를 해석하고 모듈 구조를 분석한 뒤 다른 모듈 옆에 설치합니다.
|
||||
|
||||
### 대화형 설치
|
||||
|
||||
설치 중 커뮤니티 모듈 단계 이후 설치 프로그램이 묻습니다.
|
||||
|
||||
```
|
||||
Would you like to install from a custom source (Git URL or local path)?
|
||||
```
|
||||
|
||||
**Yes**를 선택한 뒤 소스를 제공합니다.
|
||||
|
||||
| 입력 유형 | 예시 |
|
||||
| --- | --- |
|
||||
| HTTPS URL(모든 호스트) | `https://github.com/org/repo` |
|
||||
| HTTP URL(모든 호스트) | `http://host/org/repo` |
|
||||
| 하위 디렉터리가 있는 HTTPS URL | `https://github.com/org/repo/tree/main/my-module` |
|
||||
| SSH URL | `git@github.com:org/repo.git` |
|
||||
| 로컬 경로 | `/Users/me/projects/my-module` |
|
||||
| 틸드가 있는 로컬 경로 | `~/projects/my-module` |
|
||||
|
||||
설치 프로그램은 저장소를 복제(URL인 경우)하거나 디스크에서 직접 읽은 뒤(로컬 경로인 경우), 발견된 모듈을 선택할 수 있게 보여줍니다.
|
||||
|
||||
### 비대화형 설치
|
||||
|
||||
명령줄에서 커스텀 모듈을 설치하려면 `--custom-source` 플래그를 사용하세요.
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory . \
|
||||
--custom-source /path/to/my-module \
|
||||
--tools claude-code \
|
||||
--yes
|
||||
```
|
||||
|
||||
`--modules` 없이 `--custom-source`를 제공하면 core와 커스텀 모듈만 설치됩니다. 공식 모듈도 포함하려면 `--modules`를 추가하세요.
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory . \
|
||||
--modules bmm \
|
||||
--custom-source https://gitlab.com/myorg/my-module \
|
||||
--tools claude-code \
|
||||
--yes
|
||||
```
|
||||
|
||||
여러 소스는 쉼표로 구분할 수 있습니다.
|
||||
|
||||
```bash
|
||||
--custom-source /path/one,https://github.com/org/repo,/path/two
|
||||
```
|
||||
|
||||
## 모듈 발견 방식
|
||||
|
||||
설치 프로그램은 소스에서 설치 가능한 모듈을 찾기 위해 두 모드를 사용합니다.
|
||||
|
||||
| 모드 | 트리거 | 동작 |
|
||||
| --- | --- | --- |
|
||||
| `Discovery` | 소스에 `.claude-plugin/marketplace.json`이 있습니다 | 매니페스트의 모든 플러그인을 나열하고 설치할 항목을 선택하게 합니다 |
|
||||
| `Direct` | marketplace.json이 없습니다 | 디렉터리에서 스킬(`SKILL.md`가 있는 하위 디렉터리)을 스캔하고 단일 모듈로 해석합니다 |
|
||||
|
||||
`Discovery` 모드는 게시된 모듈에 일반적입니다. `Direct` 모드는 로컬 개발 중 스킬 디렉터리를 가리킬 때 편리합니다.
|
||||
|
||||
:::note[`.claude-plugin/`에 대해]
|
||||
`.claude-plugin/marketplace.json` 경로는 여러 AI 도구 설치 프로그램에서 플러그인 발견을 위해 채택한 표준 관례입니다. Claude가 필요하지 않고 Claude API를 사용하지 않으며 어떤 AI 도구를 쓰는지에 영향을 주지 않습니다. 이 파일이 있는 모듈은 관례를 따르는 모든 설치 프로그램에서 발견될 수 있습니다.
|
||||
:::
|
||||
|
||||
## 로컬 개발 워크플로
|
||||
|
||||
[BMad 빌더](https://github.com/bmad-code-org/bmad-builder)로 모듈을 만들고 있다면 작업 디렉터리에서 직접 설치할 수 있습니다.
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/my-project \
|
||||
--custom-source ~/my-module-repo/skills \
|
||||
--tools claude-code \
|
||||
--yes
|
||||
```
|
||||
|
||||
로컬 소스는 캐시에 복사되지 않고 경로로 참조됩니다. 모듈 소스를 업데이트하고 다시 설치하면 설치 프로그램이 최신 변경을 가져옵니다.
|
||||
|
||||
:::caution[소스 제거]
|
||||
설치 후 로컬 소스 디렉터리를 삭제해도 `_bmad/`에 설치된 모듈 파일은 보존됩니다. 소스 경로가 복원될 때까지 업데이트 중 해당 모듈은 건너뜁니다.
|
||||
:::
|
||||
|
||||
## 얻는 결과
|
||||
|
||||
설치 후 커스텀 모듈은 공식 모듈과 함께 `_bmad/`에 나타납니다.
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/
|
||||
│ ├── core/ # 내장 core 모듈
|
||||
│ ├── bmm/ # 공식 모듈(선택한 경우)
|
||||
│ ├── my-module/ # 커스텀 모듈
|
||||
│ │ ├── my-skill/
|
||||
│ │ │ └── SKILL.md
|
||||
│ │ └── module-help.csv
|
||||
│ └── _config/
|
||||
│ └── manifest.yaml # 모든 모듈, 버전, 소스를 추적
|
||||
└── ...
|
||||
```
|
||||
|
||||
매니페스트는 각 커스텀 모듈의 소스(Git 소스는 `repoUrl`, 로컬 소스는 `localPath`)를 기록하여 `Quick Update`가 소스를 다시 찾을 수 있게 합니다.
|
||||
|
||||
## 커스텀 모듈 업데이트
|
||||
|
||||
커스텀 모듈도 일반 업데이트 흐름에 참여합니다.
|
||||
|
||||
- **Quick Update**(`--action quick-update`): 모든 모듈을 원래 소스에서 새로 고칩니다. Git 기반 모듈은 다시 가져오고 로컬 모듈은 소스 경로에서 다시 읽힙니다.
|
||||
- **전체 업데이트**: 모듈 선택을 다시 실행해 커스텀 모듈을 추가하거나 제거할 수 있습니다.
|
||||
|
||||
## 직접 모듈 만들기
|
||||
|
||||
다른 사람이 설치할 수 있는 모듈을 만들려면 [BMad 빌더](https://github.com/bmad-code-org/bmad-builder)를 사용하세요.
|
||||
|
||||
1. `bmad-module-builder`를 실행해 모듈 초기 구조를 생성합니다
|
||||
2. 여러 BMad 빌더 도구로 스킬, 에이전트, 워크플로를 추가합니다
|
||||
3. Git 저장소에 게시하거나 폴더 컬렉션을 공유합니다
|
||||
4. 다른 사용자는 `--custom-source <your-repo-url>`로 설치합니다
|
||||
|
||||
모듈이 발견 모드를 지원하려면 저장소 루트에 `.claude-plugin/marketplace.json`을 포함하세요(Claude 전용이 아닌 도구 간 관례입니다). marketplace.json 형식은 [BMad 빌더 문서](https://github.com/bmad-code-org/bmad-builder)를 참고하세요.
|
||||
|
||||
:::tip[먼저 로컬에서 테스트]
|
||||
개발 중에는 Git 저장소에 게시하기 전에 로컬 경로로 모듈을 설치해 빠르게 반복하세요.
|
||||
:::
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: 비대화형 설치
|
||||
description: 비대화형 / CI 설치 문서가 이동되었습니다
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
:::note[이 페이지는 이동되었습니다]
|
||||
비대화형 및 CI 설치 플래그, 채널 선택, 버전 고정은 통합된 [BMad 설치 방법](./install-bmad.md) 가이드로 이동했습니다. 플래그 참조와 바로 복사해 쓸 수 있는 예시는 [비대화형 CI](./install-bmad.md#headless-ci) 섹션에서 확인하세요.
|
||||
:::
|
||||
|
|
@ -0,0 +1,132 @@
|
|||
---
|
||||
title: '프로젝트 컨텍스트 관리'
|
||||
description: AI 에이전트를 안내하는 project-context.md를 만들고 유지합니다
|
||||
sidebar:
|
||||
order: 10
|
||||
---
|
||||
|
||||
`project-context.md` 파일을 사용해 모든 워크플로에서 AI 에이전트가 프로젝트의 기술 선호도와 구현 규칙을 따르게 하세요. 이 파일을 항상 참고하게 하려면 도구 컨텍스트나 항상 적용되는 규칙 파일(예: `AGENTS.md`)에 `중요한 프로젝트 컨텍스트와 관례는 [프로젝트 컨텍스트 경로]/project-context.md에 있습니다`라는 줄을 추가할 수도 있습니다.
|
||||
|
||||
:::note[필수 조건]
|
||||
|
||||
- BMad Method 설치
|
||||
- 프로젝트의 기술 스택과 규칙에 대한 이해
|
||||
:::
|
||||
|
||||
## 사용 시점
|
||||
|
||||
- 아키텍처를 시작하기 전에 강한 기술 선호도가 있습니다
|
||||
- 아키텍처를 완료했고 구현 결정을 포착하고 싶습니다
|
||||
- 이미 확립된 패턴이 있는 기존 코드베이스에서 작업합니다
|
||||
- 스토리마다 에이전트가 일관되지 않은 결정을 내리는 문제가 보입니다
|
||||
|
||||
## 1단계: 접근 방식 선택
|
||||
|
||||
**수동 작성** - 문서화할 규칙을 정확히 알고 있을 때 가장 좋습니다
|
||||
|
||||
**아키텍처 후 생성** - 솔루션 설계 중 내려진 결정을 포착할 때 가장 좋습니다
|
||||
|
||||
**기존 프로젝트용 생성** - 기존 코드베이스의 패턴을 발견할 때 가장 좋습니다
|
||||
|
||||
## 2단계: 파일 만들기
|
||||
|
||||
### 옵션 A: 수동 작성
|
||||
|
||||
`_bmad-output/project-context.md`에 파일을 만듭니다.
|
||||
|
||||
```bash
|
||||
mkdir -p _bmad-output
|
||||
touch _bmad-output/project-context.md
|
||||
```
|
||||
|
||||
기술 스택과 구현 규칙을 추가합니다.
|
||||
|
||||
```markdown
|
||||
---
|
||||
project_name: '내프로젝트'
|
||||
user_name: '사용자이름'
|
||||
date: '2026-02-15'
|
||||
sections_completed: ['technology_stack', 'critical_rules']
|
||||
---
|
||||
|
||||
# AI 에이전트용 프로젝트 컨텍스트
|
||||
|
||||
## 기술 스택과 버전
|
||||
|
||||
- Node.js 20.x, TypeScript 5.3, React 18.2
|
||||
- 상태 관리: Zustand
|
||||
- 테스트: Vitest, Playwright
|
||||
- 스타일링: Tailwind CSS
|
||||
|
||||
## 중요한 구현 규칙
|
||||
|
||||
**TypeScript:**
|
||||
|
||||
- 엄격 모드 사용, `any` 타입 금지
|
||||
- 공개 API에는 `interface`, 유니언에는 `type` 사용
|
||||
|
||||
**코드 구성:**
|
||||
|
||||
- 컴포넌트는 `/src/components/`에 두고 테스트를 함께 배치
|
||||
- API 호출은 `apiClient` 싱글턴 사용 - 직접 fetch 금지
|
||||
|
||||
**테스트:**
|
||||
|
||||
- 단위 테스트는 비즈니스 로직에 집중
|
||||
- 통합 테스트는 MSW로 API를 모킹
|
||||
```
|
||||
|
||||
### 옵션 B: 아키텍처 후 생성
|
||||
|
||||
새 채팅에서 워크플로를 실행합니다.
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
워크플로는 아키텍처 문서와 프로젝트 파일을 스캔해 내려진 결정을 담은 컨텍스트 파일을 생성합니다.
|
||||
|
||||
### 옵션 C: 기존 프로젝트용 생성
|
||||
|
||||
기존 프로젝트에서는 다음을 실행합니다.
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
워크플로가 코드베이스를 분석해 규칙을 식별한 뒤 검토하고 다듬을 수 있는 컨텍스트 파일을 생성합니다.
|
||||
|
||||
## 3단계: 내용 확인
|
||||
|
||||
생성된 파일을 검토하고 다음이 담겨 있는지 확인하세요.
|
||||
|
||||
- 올바른 기술 버전
|
||||
- 실제 관례(일반적인 모범 사례가 아님)
|
||||
- 흔한 실수를 예방하는 규칙
|
||||
- 프레임워크별 패턴
|
||||
|
||||
누락된 내용은 수동으로 추가하고 부정확한 내용은 제거하세요.
|
||||
|
||||
## 얻는 결과
|
||||
|
||||
`project-context.md` 파일은 다음을 제공합니다.
|
||||
|
||||
- 모든 에이전트가 같은 규칙을 따르게 합니다
|
||||
- 스토리 간 일관되지 않은 결정을 방지합니다
|
||||
- 구현을 위한 아키텍처 결정을 포착합니다
|
||||
- 프로젝트 패턴과 규칙의 참조 자료가 됩니다
|
||||
|
||||
## 팁
|
||||
|
||||
:::tip[모범 사례]
|
||||
|
||||
- **겉으로 잘 드러나지 않는 것에 집중하세요** - "의미 있는 변수명을 사용하라" 같은 보편 규칙보다 "모든 공개 클래스에는 JSDoc을 사용하라"처럼 에이전트가 놓칠 수 있는 패턴을 문서화합니다.
|
||||
- **간결하게 유지하세요** - 이 파일은 모든 구현 워크플로에서 로드됩니다. 긴 파일은 컨텍스트를 낭비합니다. 좁은 범위나 특정 스토리에만 적용되는 내용은 제외하세요.
|
||||
- **필요할 때 업데이트하세요** - 패턴이 바뀌면 수동으로 수정하거나 큰 아키텍처 변경 후 다시 생성하세요.
|
||||
- 빠른 흐름과 전체 BMad Method 프로젝트 모두에 사용할 수 있습니다.
|
||||
:::
|
||||
|
||||
## 다음 단계
|
||||
|
||||
- [**프로젝트 컨텍스트 설명**](../explanation/project-context.md) - 작동 방식을 더 알아보기
|
||||
- [**워크플로 맵**](../reference/workflow-map.md) - 어떤 워크플로가 프로젝트 컨텍스트를 로드하는지 보기
|
||||
|
|
@ -0,0 +1,96 @@
|
|||
---
|
||||
title: '빠른 수정'
|
||||
description: 빠른 수정과 임시 변경을 수행하는 방법
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
전체 BMad Method가 필요하지 않은 버그 수정, 리팩터링, 작은 목표 변경에는 **빠른 개발**을 사용하세요.
|
||||
|
||||
## 사용 시점
|
||||
|
||||
- 원인이 명확하고 알려진 버그 수정
|
||||
- 몇 개 파일 안에 제한된 작은 리팩터링(이름 변경, 추출, 구조 변경)
|
||||
- 작은 기능 조정이나 설정 변경
|
||||
- 의존성 업데이트
|
||||
|
||||
:::note[필수 조건]
|
||||
|
||||
- BMad Method 설치(`npx bmad-method install`)
|
||||
- AI 기반 IDE(Claude Code, Cursor 또는 유사 도구)
|
||||
:::
|
||||
|
||||
## 단계
|
||||
|
||||
### 1. 새 채팅 시작
|
||||
|
||||
AI IDE에서 **새 채팅 세션**을 엽니다. 이전 워크플로 세션을 재사용하면 컨텍스트 충돌이 생길 수 있습니다.
|
||||
|
||||
### 2. 의도 전달
|
||||
|
||||
빠른 개발은 호출 전, 호출과 함께, 또는 호출 후에 자유 형식 의도를 받을 수 있습니다. 예를 들면 다음과 같습니다.
|
||||
|
||||
```text
|
||||
run quick-dev - 빈 비밀번호를 허용하는 로그인 검증 버그를 수정해 줘.
|
||||
```
|
||||
|
||||
```text
|
||||
run quick-dev - https://github.com/org/repo/issues/42 를 수정해 줘
|
||||
```
|
||||
|
||||
```text
|
||||
run quick-dev - _bmad-output/implementation-artifacts/my-intent.md의 의도를 구현해 줘
|
||||
```
|
||||
|
||||
```text
|
||||
문제는 인증 미들웨어에 있는 것 같아요. 토큰 만료를 확인하지 않습니다.
|
||||
확인해 보니 src/auth/middleware.ts 47번째 줄에서 exp 확인을 완전히 건너뜁니다.
|
||||
run quick-dev
|
||||
```
|
||||
|
||||
```text
|
||||
run quick-dev
|
||||
> 무엇을 하고 싶나요?
|
||||
UserService가 콜백 대신 async/await를 사용하도록 리팩터링해 줘.
|
||||
```
|
||||
|
||||
일반 텍스트, 파일 경로, GitHub 이슈 URL, 버그 트래커 링크 등 LLM이 구체적 의도로 해석할 수 있는 것이면 됩니다.
|
||||
|
||||
### 3. 질문에 답하고 승인
|
||||
|
||||
빠른 개발은 구현 전에 명확화 질문을 하거나 짧은 사양을 제시해 승인을 요청할 수 있습니다. 질문에 답하고 계획이 만족스러우면 승인하세요.
|
||||
|
||||
### 4. 리뷰하고 푸시
|
||||
|
||||
빠른 개발이 변경을 구현하고, 자체 리뷰하고, 문제를 패치하고, 로컬에 커밋합니다. 완료되면 영향을 받은 파일을 에디터에서 엽니다.
|
||||
|
||||
- diff를 훑어 변경이 의도와 맞는지 확인합니다
|
||||
- 이상한 점이 있으면 에이전트에게 수정할 내용을 말하세요. 같은 세션에서 반복할 수 있습니다
|
||||
|
||||
만족하면 커밋을 푸시하세요. 빠른 개발이 푸시와 PR 생성을 제안합니다.
|
||||
|
||||
:::caution[문제가 생기면]
|
||||
푸시한 변경이 예상치 못한 문제를 일으키면 `git revert HEAD`로 마지막 커밋을 깔끔하게 되돌리세요. 그런 다음 새 채팅을 시작하고 빠른 개발을 다시 실행해 다른 접근을 시도합니다.
|
||||
:::
|
||||
|
||||
## 얻는 결과
|
||||
|
||||
- 수정 또는 리팩터링이 적용된 소스 파일
|
||||
- 테스트 스위트가 있다면 통과하는 테스트
|
||||
- Conventional Commit 형식의 푸시 준비 완료 커밋
|
||||
|
||||
## 보류 작업
|
||||
|
||||
빠른 개발은 각 실행을 하나의 목표에 집중하게 합니다. 요청에 여러 독립 목표가 있거나 리뷰에서 변경과 무관한 기존 문제가 드러나면, 모든 것을 한 번에 처리하지 않고 구현 산출물 디렉터리의 `deferred-work.md` 파일에 따로 보류합니다.
|
||||
|
||||
실행 후 이 파일을 확인하세요. 나중에 다시 볼 작업 백로그입니다. 각 보류 항목은 이후 새 빠른 개발 실행에 넣을 수 있습니다.
|
||||
|
||||
## 정식 계획으로 업그레이드할 때
|
||||
|
||||
다음과 같다면 전체 BMad Method 사용을 고려하세요.
|
||||
|
||||
- 변경이 여러 시스템에 영향을 주거나 많은 파일의 조율된 업데이트가 필요합니다
|
||||
- 범위를 확신하지 못해 먼저 요구사항 발견이 필요합니다
|
||||
- 팀을 위해 문서나 아키텍처 결정을 기록해야 합니다
|
||||
|
||||
빠른 개발이 BMad Method와 어떻게 맞물리는지는 [빠른 개발](../explanation/quick-dev.md)을 참고하세요.
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
title: '문서 샤딩 가이드'
|
||||
description: 큰 Markdown 파일을 더 작고 정리된 파일로 나눠 컨텍스트 관리를 개선합니다
|
||||
sidebar:
|
||||
order: 11
|
||||
---
|
||||
|
||||
큰 Markdown 파일을 더 작고 정리된 파일로 나눠 컨텍스트 관리를 개선해야 한다면 `bmad-shard-doc` 도구를 사용하세요.
|
||||
|
||||
:::caution[지원 중단]
|
||||
이 방식은 더 이상 권장되지 않습니다. 업데이트된 워크플로와 대부분의 주요 LLM 및 도구가 하위 프로세스를 지원하게 되면 곧 필요 없어질 것입니다.
|
||||
:::
|
||||
|
||||
## 사용 시점
|
||||
|
||||
선택한 도구/모델 조합이 필요한 모든 문서를 입력으로 로드하고 읽지 못한다는 것을 확인한 경우에만 사용하세요.
|
||||
|
||||
## 문서 샤딩이란?
|
||||
|
||||
문서 샤딩은 큰 Markdown 파일을 2단계 제목(`## 제목`)을 기준으로 더 작고 정리된 파일로 나눕니다.
|
||||
|
||||
### 아키텍처
|
||||
|
||||
```text
|
||||
샤딩 전:
|
||||
_bmad-output/planning-artifacts/
|
||||
└── PRD.md (큰 50k 토큰 파일)
|
||||
|
||||
샤딩 후:
|
||||
_bmad-output/planning-artifacts/
|
||||
└── prd/
|
||||
├── index.md # 설명이 있는 목차
|
||||
├── overview.md # 섹션 1
|
||||
├── user-requirements.md # 섹션 2
|
||||
├── technical-requirements.md # 섹션 3
|
||||
└── ... # 추가 섹션
|
||||
```
|
||||
|
||||
## 단계
|
||||
|
||||
### 1. 문서 샤딩 도구 실행
|
||||
|
||||
```bash
|
||||
/bmad-shard-doc
|
||||
```
|
||||
|
||||
### 2. 대화형 과정 따르기
|
||||
|
||||
```text
|
||||
에이전트: 어떤 문서를 샤딩할까요?
|
||||
사용자: docs/PRD.md
|
||||
|
||||
에이전트: 기본 대상: docs/prd/
|
||||
기본값을 사용할까요? [y/n]
|
||||
사용자: y
|
||||
|
||||
에이전트: PRD.md를 샤딩하는 중...
|
||||
✓ 섹션 파일 12개 생성
|
||||
✓ index.md 생성
|
||||
✓ 완료!
|
||||
```
|
||||
|
||||
## 워크플로 발견 방식
|
||||
|
||||
BMad 워크플로는 **이중 발견 시스템**을 사용합니다.
|
||||
|
||||
1. **먼저 전체 문서 시도** - `document-name.md`를 찾습니다
|
||||
2. **샤딩된 버전 확인** - `document-name/index.md`를 찾습니다
|
||||
3. **우선순위 규칙** - 둘 다 있으면 전체 문서가 우선합니다. 샤딩된 버전을 사용하려면 전체 문서를 제거하세요
|
||||
|
||||
## 워크플로 지원
|
||||
|
||||
모든 BMM 워크플로는 두 형식을 모두 지원합니다.
|
||||
|
||||
- 전체 문서
|
||||
- 샤딩된 문서
|
||||
- 자동 감지
|
||||
- 사용자에게 투명하게 동작
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
---
|
||||
title: 'v6로 업그레이드하는 방법'
|
||||
description: BMad v4에서 v6로 마이그레이션합니다
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
BMad 설치 프로그램을 사용해 v4에서 v6로 업그레이드하세요. 레거시 설치 자동 감지와 마이그레이션 지원이 포함되어 있습니다.
|
||||
|
||||
## 사용 시점
|
||||
|
||||
- BMad v4가 설치되어 있습니다(`.bmad-method` 폴더)
|
||||
- 새 v6 아키텍처로 마이그레이션하고 싶습니다
|
||||
- 보존해야 할 기존 계획 산출물이 있습니다
|
||||
|
||||
:::note[필수 조건]
|
||||
|
||||
- Node.js 20+
|
||||
- 기존 BMad v4 설치
|
||||
:::
|
||||
|
||||
## 단계
|
||||
|
||||
### 1. 설치 프로그램 실행
|
||||
|
||||
[설치 프로그램 안내](./install-bmad.md)를 따르세요.
|
||||
|
||||
### 2. 레거시 설치 처리
|
||||
|
||||
v4가 감지되면 다음 중 선택할 수 있습니다.
|
||||
|
||||
- 설치 프로그램이 `.bmad-method`를 백업하고 제거하게 합니다
|
||||
- 종료한 뒤 수동으로 정리합니다
|
||||
|
||||
BMad Method 폴더 이름을 다르게 지정했다면 직접 폴더를 제거해야 합니다.
|
||||
|
||||
### 3. IDE 스킬 정리
|
||||
|
||||
레거시 v4 IDE 명령/스킬을 수동으로 제거하세요. 예를 들어 Claude Code를 사용한다면 bmad로 시작하는 중첩 폴더를 찾아 제거합니다.
|
||||
|
||||
- `.claude/commands/`
|
||||
|
||||
새 v6 스킬은 다음 위치에 설치됩니다.
|
||||
|
||||
- `.claude/skills/`
|
||||
|
||||
### 4. 계획 산출물 마이그레이션
|
||||
|
||||
**계획 문서(제품 개요/PRD/UX/아키텍처)가 있다면:**
|
||||
|
||||
설명적인 이름으로 `_bmad-output/planning-artifacts/`에 옮기세요.
|
||||
|
||||
- PRD 문서는 파일명에 `PRD`를 포함합니다
|
||||
- 파일 유형에 맞게 `brief`, `architecture`, `ux-design`을 포함합니다
|
||||
- 샤딩된 문서는 이름 있는 하위 폴더에 둘 수 있습니다
|
||||
|
||||
**계획 도중이라면:** v6 워크플로로 다시 시작하는 것을 고려하세요. 기존 문서를 입력으로 사용할 수 있습니다. 웹 검색과 IDE 계획 모드를 활용하는 새 점진적 발견 워크플로가 더 좋은 결과를 만듭니다.
|
||||
|
||||
### 5. 진행 중인 개발 마이그레이션
|
||||
|
||||
이미 생성 또는 구현된 스토리가 있다면:
|
||||
|
||||
1. v6 설치를 완료합니다
|
||||
2. `epics.md` 또는 `epics/epic*.md`를 `_bmad-output/planning-artifacts/`에 둡니다
|
||||
3. 개발자의 `bmad-sprint-planning` 워크플로를 실행합니다
|
||||
4. 이미 완료된 에픽/스토리를 에이전트에게 알려줍니다
|
||||
|
||||
## 얻는 결과
|
||||
|
||||
**v6 통합 구조:**
|
||||
|
||||
```text
|
||||
your-project/
|
||||
├── _bmad/ # 단일 설치 폴더
|
||||
│ ├── _config/ # 커스터마이징
|
||||
│ │ └── agents/ # 에이전트 커스터마이징 파일
|
||||
│ ├── core/ # 범용 core 프레임워크
|
||||
│ ├── bmm/ # BMad Method 모듈
|
||||
│ ├── bmb/ # BMad 빌더
|
||||
│ └── cis/ # 창의적 지능 제품군
|
||||
└── _bmad-output/ # 출력 폴더(v4의 문서 폴더)
|
||||
```
|
||||
|
||||
## 모듈 마이그레이션
|
||||
|
||||
| v4 모듈 | v6 상태 |
|
||||
| --- | --- |
|
||||
| `.bmad-2d-phaser-game-dev` | BMGD 모듈에 통합 |
|
||||
| `.bmad-2d-unity-game-dev` | BMGD 모듈에 통합 |
|
||||
| `.bmad-godot-game-dev` | BMGD 모듈에 통합 |
|
||||
| `.bmad-infrastructure-devops` | 지원 중단 - 새 DevOps 에이전트 예정 |
|
||||
| `.bmad-creative-writing` | 아직 적용되지 않음 - 새 v6 모듈 예정 |
|
||||
|
||||
## 주요 변경 사항
|
||||
|
||||
| 개념 | v4 | v6 |
|
||||
| --- | --- | --- |
|
||||
| **코어** | `_bmad-core`는 실제로 BMad Method였습니다 | `_bmad/core/`는 범용 프레임워크입니다 |
|
||||
| **메서드** | `_bmad-method` | `_bmad/bmm/` |
|
||||
| **설정** | 파일을 직접 수정 | 모듈별 `config.yaml` |
|
||||
| **문서** | 샤딩 또는 비샤딩 필수 설정 | 완전히 유연하며 자동 스캔 |
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
---
|
||||
title: BMad Method에 오신 것을 환영합니다
|
||||
description: 전문 에이전트, 안내형 워크플로, 지능형 계획을 제공하는 AI 기반 개발 프레임워크
|
||||
---
|
||||
|
||||
BMad Method(**B**uild **M**ore **A**rchitect **D**reams)는 BMad Method 생태계에 속한 AI 기반 개발 프레임워크입니다. 아이디어 구상과 계획부터 에이전트 기반 구현까지 소프트웨어 개발 전 과정을 돕습니다. 버그 수정부터 엔터프라이즈 플랫폼 구축까지, 프로젝트 복잡도에 맞춰 전문 AI 에이전트, 안내형 워크플로, 지능형 계획을 제공합니다.
|
||||
|
||||
Claude, Cursor, GitHub Copilot 같은 AI 코딩 어시스턴트로 작업하는 데 익숙하다면 바로 시작할 준비가 된 것입니다.
|
||||
|
||||
:::note[V6가 출시되었습니다. 이제 시작입니다.]
|
||||
스킬 아키텍처, BMad Builder v1, Dev Loop Automation 등 훨씬 많은 기능이 준비 중입니다. [**로드맵 보기**](/ko-kr/roadmap/)
|
||||
:::
|
||||
|
||||
## 처음이라면 튜토리얼부터 시작하세요
|
||||
|
||||
BMad를 가장 빠르게 이해하는 방법은 직접 써보는 것입니다.
|
||||
|
||||
- **[BMad 시작하기](./tutorials/getting-started.md)** - BMad를 설치하고 작동 방식을 이해합니다
|
||||
- **[워크플로 맵](./reference/workflow-map.md)** - BMM 단계, 워크플로, 컨텍스트 관리를 한눈에 보여줍니다
|
||||
|
||||
:::tip[바로 시작하고 싶나요?]
|
||||
BMad를 설치하고 `bmad-help` 스킬을 사용하세요. 프로젝트와 설치된 모듈에 맞춰 모든 과정을 안내합니다.
|
||||
:::
|
||||
|
||||
## 이 문서를 사용하는 방법
|
||||
|
||||
이 문서는 하려는 일에 따라 네 가지 섹션으로 구성되어 있습니다.
|
||||
|
||||
| 섹션 | 목적 |
|
||||
| --- | --- |
|
||||
| **튜토리얼** | 학습 중심입니다. 무언가를 만들어 보며 따라가는 단계별 가이드입니다. 처음이라면 여기서 시작하세요. |
|
||||
| **사용 가이드** | 작업 중심입니다. 특정 문제를 해결하기 위한 실용 가이드입니다. "에이전트를 어떻게 커스터마이즈하지?" 같은 질문을 여기서 다룹니다. |
|
||||
| **개념 설명** | 이해 중심입니다. 개념과 아키텍처를 깊게 설명합니다. *왜* 그런지 알고 싶을 때 읽으세요. |
|
||||
| **참조** | 정보 중심입니다. 에이전트, 워크플로, 설정에 대한 기술 사양입니다. |
|
||||
|
||||
## 확장과 커스터마이징
|
||||
|
||||
직접 만든 에이전트, 워크플로, 모듈로 BMad를 확장하고 싶나요? [**BMad Builder**](https://bmad-builder-docs.bmad-method.org/)는 BMad에 새 기능을 더하거나 완전히 새로운 모듈을 만들 수 있는 프레임워크와 도구를 제공합니다.
|
||||
|
||||
## 필요한 것
|
||||
|
||||
BMad는 커스텀 시스템 프롬프트나 프로젝트 컨텍스트를 지원하는 AI 코딩 어시스턴트라면 무엇이든 함께 사용할 수 있습니다. 널리 쓰이는 선택지는 다음과 같습니다.
|
||||
|
||||
- **[Claude Code](https://code.claude.com)** - Anthropic의 CLI 도구(권장)
|
||||
- **[Cursor](https://cursor.sh)** - AI 우선 코드 에디터
|
||||
- **[Codex CLI](https://github.com/openai/codex)** - OpenAI의 터미널 코딩 에이전트
|
||||
|
||||
버전 관리, 프로젝트 구조, 애자일 워크플로 같은 기본 소프트웨어 개발 개념에 익숙하면 좋습니다. BMad 스타일의 에이전트 시스템 경험은 없어도 됩니다. 이 문서가 그 시작점이 되어 줍니다.
|
||||
|
||||
## 커뮤니티 참여
|
||||
|
||||
도움을 받고, 만들고 있는 것을 공유하고, BMad에 기여하세요.
|
||||
|
||||
- **[Discord](https://discord.gg/gk8jAdXWmj)** - 다른 BMad 사용자와 대화하고 질문하고 아이디어를 공유합니다
|
||||
- **[GitHub](https://github.com/bmad-code-org/BMAD-METHOD)** - 소스 코드, 이슈, 기여
|
||||
- **[YouTube](https://www.youtube.com/@BMadCode)** - 영상 튜토리얼과 워크스루
|
||||
|
||||
## 다음 단계
|
||||
|
||||
시작할 준비가 되었나요? [**BMad 시작하기**](./tutorials/getting-started.md)를 열고 첫 프로젝트를 만들어 보세요.
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
title: 에이전트
|
||||
description: 기본 BMM 에이전트와 스킬 ID, 메뉴 트리거, 주요 워크플로
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
## 기본 에이전트
|
||||
|
||||
이 페이지는 BMad Method와 함께 설치되는 기본 BMM(애자일 제품군) 에이전트를 스킬 ID, 메뉴 트리거, 주요 워크플로와 함께 나열합니다. 각 에이전트는 스킬로 호출됩니다.
|
||||
|
||||
## 참고
|
||||
|
||||
- 각 에이전트는 설치 프로그램이 생성하는 스킬로 제공됩니다. 스킬 ID(예: `bmad-dev`)를 사용해 에이전트를 호출합니다.
|
||||
- 트리거는 각 에이전트 메뉴에 표시되는 짧은 메뉴 코드(예: `CP`)와 유사 매칭 항목입니다.
|
||||
- QA 테스트 생성은 개발자 에이전트를 통해 사용할 수 있는 `bmad-qa-generate-e2e-tests` 워크플로 스킬이 처리합니다. 전체 테스트 설계자(TEA)는 별도 모듈에 있습니다.
|
||||
|
||||
| 에이전트 | 스킬 ID | 트리거 | 주요 워크플로 |
|
||||
| --- | --- | --- | --- |
|
||||
| 분석가(Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `WB`, `DP` | 브레인스토밍, 시장 리서치, 도메인 리서치, 기술 리서치, 개요 작성, PRFAQ 챌린지, 프로젝트 문서화 |
|
||||
| 제품 관리자(John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | PRD 생성/검증/편집, 에픽과 스토리 생성, 구현 준비 상태, 경로 수정 |
|
||||
| 아키텍트(Winston) | `bmad-architect` | `CA`, `IR` | 아키텍처 생성, 구현 준비 상태 |
|
||||
| 개발자(Amelia) | `bmad-agent-dev` | `DS`, `QD`, `QA`, `CR`, `SP`, `CS`, `ER` | 스토리 구현, 빠른 개발, QA 테스트 생성, 코드 리뷰, 스프린트 계획, 스토리 생성, 에픽 회고 |
|
||||
| UX 디자이너(Sally) | `bmad-ux-designer` | `CU` | UX 설계 생성 |
|
||||
| 기술 작성자(Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | 프로젝트 문서화, 문서 작성, 표준 업데이트, Mermaid 생성, 문서 검증, 개념 설명 |
|
||||
|
||||
## 트리거 유형
|
||||
|
||||
에이전트 메뉴 트리거는 두 가지 호출 방식을 사용합니다. 어떤 유형인지 알면 올바른 입력을 제공하기 쉽습니다.
|
||||
|
||||
### 워크플로 트리거(인수 불필요)
|
||||
|
||||
대부분의 트리거는 구조화된 워크플로 파일을 로드합니다. 트리거 코드를 입력하면 에이전트가 워크플로를 시작하고 각 단계에서 입력을 요청합니다.
|
||||
|
||||
예: `CP`(PRD 생성), `DS`(스토리 구현), `CA`(아키텍처 생성), `QD`(빠른 개발)
|
||||
|
||||
### 대화형 트리거(인수 필요)
|
||||
|
||||
일부 트리거는 구조화된 워크플로 대신 자유 형식 대화를 시작합니다. 트리거 코드와 함께 필요한 내용을 설명해야 합니다.
|
||||
|
||||
| 에이전트 | 트리거 | 제공할 내용 |
|
||||
| --- | --- | --- |
|
||||
| 기술 작성자(Paige) | `WD` | 작성할 문서 설명 |
|
||||
| 기술 작성자(Paige) | `US` | 표준에 추가할 선호 사항 또는 관례 |
|
||||
| 기술 작성자(Paige) | `MG` | 다이어그램 설명과 유형(시퀀스, 플로차트 등) |
|
||||
| 기술 작성자(Paige) | `VD` | 검증할 문서와 집중 영역 |
|
||||
| 기술 작성자(Paige) | `EC` | 설명할 개념 이름 |
|
||||
|
||||
**예시:**
|
||||
|
||||
```text
|
||||
WD 우리 Docker 설정에 대한 배포 가이드를 작성해 줘
|
||||
MG 인증 흐름을 보여 주는 시퀀스 다이어그램을 만들어 줘
|
||||
EC 모듈 시스템이 어떻게 작동하는지 설명해 줘
|
||||
```
|
||||
|
|
@ -0,0 +1,135 @@
|
|||
---
|
||||
title: 스킬
|
||||
description: BMad 스킬의 정의, 작동 방식, 위치에 대한 참조
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
스킬은 IDE 안에서 에이전트를 로드하거나 워크플로를 실행하거나 작업을 처리하는 미리 작성된 프롬프트입니다. BMad 설치 프로그램은 설치 시 선택한 모듈에서 스킬을 생성합니다. 나중에 모듈을 추가, 제거, 변경했다면 설치 프로그램을 다시 실행해 스킬을 동기화하세요([문제 해결](#문제-해결) 참고).
|
||||
|
||||
## 스킬 vs 에이전트 메뉴 트리거
|
||||
|
||||
BMad는 작업을 시작하는 두 가지 방법을 제공하며 목적이 다릅니다.
|
||||
|
||||
| 방식 | 호출 방법 | 일어나는 일 |
|
||||
| --- | --- | --- |
|
||||
| **스킬** | IDE에서 스킬 이름(예: `bmad-help`)을 입력 | 에이전트를 직접 로드하거나 워크플로를 실행하거나 작업을 처리 |
|
||||
| **에이전트 메뉴 트리거** | 에이전트를 먼저 로드한 뒤 짧은 코드(예: `DS`) 입력 | 에이전트가 페르소나를 유지한 채 코드를 해석하고 일치하는 워크플로를 시작 |
|
||||
|
||||
에이전트 메뉴 트리거는 활성 에이전트 세션이 필요합니다. 어떤 워크플로를 원하는지 알고 있다면 스킬을 사용하세요. 이미 에이전트와 작업 중이고 대화를 떠나지 않고 작업을 바꾸고 싶다면 트리거를 사용하세요.
|
||||
|
||||
## 스킬 생성 방식
|
||||
|
||||
`npx bmad-method install`을 실행하면 설치 프로그램은 선택된 모든 모듈의 매니페스트를 읽고 에이전트, 워크플로, 작업, 도구마다 하나의 스킬을 작성합니다. 각 스킬은 AI에게 해당 소스 파일을 로드하고 지시를 따르라고 안내하는 `SKILL.md` 파일이 있는 폴더입니다.
|
||||
|
||||
설치 프로그램은 스킬 유형별 템플릿을 사용합니다.
|
||||
|
||||
| 스킬 유형 | 생성 파일의 역할 |
|
||||
| --- | --- |
|
||||
| **에이전트 실행기** | 에이전트 페르소나 파일을 로드하고 메뉴를 활성화하며 페르소나를 유지 |
|
||||
| **워크플로 스킬** | 워크플로 설정을 로드하고 단계를 따름 |
|
||||
| **작업 스킬** | 단독 실행 작업 파일을 로드하고 지시를 따름 |
|
||||
| **도구 스킬** | 단독 실행 도구 파일을 로드하고 지시를 따름 |
|
||||
|
||||
:::note[설치 프로그램 다시 실행]
|
||||
모듈을 추가하거나 제거했다면 설치 프로그램을 다시 실행하세요. 현재 모듈 선택에 맞춰 모든 스킬 파일을 다시 생성합니다.
|
||||
:::
|
||||
|
||||
## 스킬 파일 위치
|
||||
|
||||
설치 프로그램은 프로젝트 안의 IDE별 디렉터리에 스킬 파일을 씁니다. 정확한 경로는 설치 중 선택한 IDE에 따라 달라집니다.
|
||||
|
||||
| IDE / CLI | Skills 디렉터리 |
|
||||
| --- | --- |
|
||||
| Claude Code | `.claude/skills/` |
|
||||
| Cursor | `.cursor/skills/` |
|
||||
| Windsurf | `.windsurf/skills/` |
|
||||
| 기타 IDE | 대상 경로는 설치 프로그램 출력 참고 |
|
||||
|
||||
각 스킬은 `SKILL.md` 파일을 포함하는 폴더입니다. Claude Code 설치 예시는 다음과 같습니다.
|
||||
|
||||
```text
|
||||
.claude/skills/
|
||||
├── bmad-help/
|
||||
│ └── SKILL.md
|
||||
├── bmad-prd/
|
||||
│ └── SKILL.md
|
||||
├── bmad-agent-dev/
|
||||
│ └── SKILL.md
|
||||
└── ...
|
||||
```
|
||||
|
||||
디렉터리 이름이 IDE에서의 스킬 이름을 결정합니다. 예를 들어 `bmad-agent-dev/` 디렉터리는 `bmad-agent-dev` 스킬을 등록합니다.
|
||||
|
||||
## 스킬 찾기
|
||||
|
||||
IDE에서 스킬 이름을 입력해 호출합니다. 일부 플랫폼은 스킬이 나타나기 전에 설정에서 활성화해야 합니다.
|
||||
|
||||
다음 단계를 상황에 맞게 안내받으려면 `bmad-help`를 실행하세요.
|
||||
|
||||
:::tip[빠른 탐색]
|
||||
프로젝트에 생성된 스킬 디렉터리가 기준 목록입니다. 파일 탐색기에서 열면 설명이 있는 모든 스킬을 볼 수 있습니다.
|
||||
:::
|
||||
|
||||
## 스킬 범주
|
||||
|
||||
### 에이전트 스킬
|
||||
|
||||
에이전트 스킬은 정의된 역할, 커뮤니케이션 스타일, 워크플로 메뉴를 가진 전문 AI 페르소나를 로드합니다. 로드되면 에이전트는 페르소나를 유지하고 메뉴 트리거에 응답합니다.
|
||||
|
||||
| 예시 스킬 | 에이전트 | 역할 |
|
||||
| --- | --- | --- |
|
||||
| `bmad-agent-dev` | Amelia(개발자) | 사양을 엄격히 준수해 스토리 구현 |
|
||||
| `bmad-pm` | John(제품 관리자) | PRD 생성 및 검증 |
|
||||
| `bmad-architect` | Winston(아키텍트) | 시스템 아키텍처 설계 |
|
||||
|
||||
기본 에이전트와 트리거 전체 목록은 [에이전트](./agents.md)를 참고하세요.
|
||||
|
||||
### 워크플로 스킬
|
||||
|
||||
워크플로 스킬은 에이전트 페르소나를 먼저 로드하지 않고 구조화된 다단계 프로세스를 실행합니다. 워크플로 설정을 로드하고 단계를 따릅니다.
|
||||
|
||||
| 예시 스킬 | 목적 |
|
||||
| --- | --- |
|
||||
| `bmad-product-brief` | 제품 개요 생성 또는 업데이트 - 개념이 명확할 때 안내형 발견 |
|
||||
| `bmad-prfaq` | 제품 개념을 스트레스 테스트하는 [워킹 백워드 PRFAQ](../explanation/analysis-phase.md#prfaq-working-backwards) 챌린지 |
|
||||
| `bmad-prd` | 제품 요구사항 문서(PRD) 생성, 업데이트, 검증 |
|
||||
| `bmad-create-architecture` | 시스템 아키텍처 설계 |
|
||||
| `bmad-create-epics-and-stories` | 에픽과 스토리 생성 |
|
||||
| `bmad-dev-story` | 스토리 구현 |
|
||||
| `bmad-code-review` | 코드 리뷰 실행 |
|
||||
| `bmad-quick-dev` | 통합 빠른 흐름 - 의도 정리, 계획, 구현, 리뷰, 발표 |
|
||||
|
||||
단계별 전체 워크플로 참조는 [워크플로 맵](./workflow-map.md)을 참고하세요.
|
||||
|
||||
### 작업과 도구 스킬
|
||||
|
||||
작업과 도구는 에이전트나 워크플로 컨텍스트 없이 실행되는 단독 작업입니다.
|
||||
|
||||
**BMad 도움말: 지능형 안내자**
|
||||
|
||||
`bmad-help`는 다음에 무엇을 해야 할지 찾는 기본 인터페이스입니다. 프로젝트를 검사하고, 자연어 쿼리를 이해하며, 설치된 모듈을 기준으로 다음 필수 또는 선택 단계를 추천합니다.
|
||||
|
||||
:::note[예시]
|
||||
```
|
||||
bmad-help
|
||||
bmad-help SaaS 아이디어가 있고 기능도 모두 알고 있습니다. 어디서 시작하나요?
|
||||
bmad-help UX 설계에는 어떤 선택지가 있나요?
|
||||
```
|
||||
:::
|
||||
|
||||
**기타 핵심 작업과 도구**
|
||||
|
||||
핵심 모듈에는 리뷰, 압축, 브레인스토밍, 문서 관리 등 11개의 내장 도구가 포함됩니다. 전체 참조는 [핵심 도구](./core-tools.md)를 참고하세요.
|
||||
|
||||
## 이름 규칙
|
||||
|
||||
모든 스킬은 `bmad-` 접두사 뒤에 설명적인 이름을 붙입니다(예: `bmad-agent-dev`, `bmad-prd`, `bmad-help`). 사용 가능한 모듈은 [모듈](./modules.md)을 참고하세요.
|
||||
|
||||
## 문제 해결
|
||||
|
||||
**설치 후 스킬이 보이지 않음.** 일부 플랫폼은 설정에서 스킬을 명시적으로 활성화해야 합니다. IDE 문서를 확인하거나 AI 어시스턴트에게 스킬 활성화 방법을 물어보세요. IDE 재시작 또는 창 새로고침이 필요할 수도 있습니다.
|
||||
|
||||
**예상한 스킬이 없음.** 설치 프로그램은 선택한 모듈의 스킬만 생성합니다. `npx bmad-method install`을 다시 실행하고 모듈 선택을 확인하세요. 예상 디렉터리에 스킬 파일이 있는지 확인하세요.
|
||||
|
||||
**제거한 모듈의 스킬이 계속 보임.** 설치 프로그램은 오래된 스킬 파일을 자동으로 삭제하지 않습니다. IDE 스킬 디렉터리에서 오래된 디렉터리를 제거하거나 전체 스킬 디렉터리를 삭제한 뒤 설치 프로그램을 다시 실행해 깨끗한 스킬 세트를 만드세요.
|
||||
|
|
@ -0,0 +1,293 @@
|
|||
---
|
||||
title: 핵심 도구
|
||||
description: 추가 모듈 없이 모든 BMad 설치에서 사용할 수 있는 내장 작업과 워크플로 참조
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
모든 BMad 설치에는 어떤 작업을 하든 함께 사용할 수 있는 핵심 스킬 모음이 포함됩니다. 모든 프로젝트, 모든 모듈, 모든 단계에서 단독으로 실행할 수 있는 작업과 워크플로입니다. 어떤 선택 모듈을 설치했든 항상 사용할 수 있습니다.
|
||||
|
||||
:::tip[빠른 경로]
|
||||
IDE에서 스킬 이름(예: `bmad-help`)을 입력해 어떤 핵심 도구든 실행하세요. 에이전트 세션은 필요 없습니다.
|
||||
:::
|
||||
|
||||
## 개요
|
||||
|
||||
| 도구 | 유형 | 목적 |
|
||||
| --- | --- | --- |
|
||||
| [`bmad-help`](#bmad-help) | 작업 | 다음에 무엇을 해야 할지 상황에 맞게 안내 |
|
||||
| [`bmad-brainstorming`](#bmad-brainstorming) | 워크플로 | 대화형 브레인스토밍 세션 진행 |
|
||||
| [`bmad-party-mode`](#bmad-party-mode) | 워크플로 | 다중 에이전트 그룹 토론 조율 |
|
||||
| [`bmad-distillator`](#bmad-distillator) | 작업 | 문서의 무손실 LLM 최적화 압축 |
|
||||
| [`bmad-advanced-elicitation`](#bmad-advanced-elicitation) | 작업 | LLM 출력을 반복 개선 방식으로 끌어올림 |
|
||||
| [`bmad-review-adversarial-general`](#bmad-review-adversarial-general) | 작업 | 빠진 것과 틀린 것을 찾는 비판적 리뷰 |
|
||||
| [`bmad-review-edge-case-hunter`](#bmad-review-edge-case-hunter) | 작업 | 처리되지 않은 엣지 케이스를 찾기 위한 철저한 분기 경로 분석 |
|
||||
| [`bmad-editorial-review-prose`](#bmad-editorial-review-prose) | 작업 | 전달 명확성을 위한 엄격한 문장 교정 |
|
||||
| [`bmad-editorial-review-structure`](#bmad-editorial-review-structure) | 작업 | 구조 편집 - 삭제, 병합, 재구성 |
|
||||
| [`bmad-shard-doc`](#bmad-shard-doc) | 작업 | 큰 Markdown 파일을 정리된 섹션으로 분할 |
|
||||
| [`bmad-index-docs`](#bmad-index-docs) | 작업 | 폴더 내 모든 문서 색인 생성 또는 업데이트 |
|
||||
|
||||
## bmad-help
|
||||
|
||||
**다음에 무엇을 해야 할지 알려주는 지능형 안내자입니다.** 프로젝트 상태를 검사하고, 완료된 것을 감지하며, 다음 필수 또는 선택 단계를 추천합니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- 워크플로를 끝냈고 다음 단계를 알고 싶습니다
|
||||
- BMad가 처음이라 방향 안내가 필요합니다
|
||||
- 막혀서 상황에 맞는 조언이 필요합니다
|
||||
- 새 모듈을 설치했고 사용할 수 있는 것을 보고 싶습니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 프로젝트에서 기존 산출물(PRD, 아키텍처, 스토리 등)를 스캔합니다
|
||||
2. 설치된 모듈과 사용 가능한 워크플로를 감지합니다
|
||||
3. 우선순위 순서로 다음 단계를 추천합니다. 필수 단계를 먼저, 선택 단계를 나중에 제시합니다
|
||||
4. 각 추천을 스킬 명령과 짧은 설명으로 보여줍니다
|
||||
|
||||
**입력:** 자연어 선택 쿼리(예: `bmad-help SaaS 아이디어가 있는데 어디서 시작하나요?`)
|
||||
|
||||
**출력:** 스킬 명령이 포함된 권장 다음 단계의 우선순위 목록
|
||||
|
||||
## bmad-brainstorming
|
||||
|
||||
**대화형 창의 기법으로 다양한 아이디어를 생성합니다.** 기법 라이브러리에서 검증된 아이디어 발상법을 로드하고 100개 이상의 아이디어를 향해 안내한 뒤 정리하는 브레인스토밍 세션입니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- 새 프로젝트를 시작하고 문제 영역을 탐색해야 합니다
|
||||
- 아이디어 생성이 막혀 구조화된 창의 기법이 필요합니다
|
||||
- SCAMPER, 역브레인스토밍 같은 검증된 아이디어 발상 프레임워크를 사용하고 싶습니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 주제로 브레인스토밍 세션을 설정합니다
|
||||
2. 기법 라이브러리에서 창의 기법을 로드합니다
|
||||
3. 기법을 하나씩 진행하며 아이디어를 생성합니다
|
||||
4. 편향 방지 프로토콜을 적용합니다. 10개 아이디어마다 창의 영역을 바꿔 군집화를 방지합니다
|
||||
5. 모든 아이디어를 기법별로 정리한 추가 전용 세션 문서를 만듭니다
|
||||
|
||||
**입력:** 브레인스토밍 주제 또는 문제 설명, 선택 사항 컨텍스트 파일
|
||||
|
||||
**출력:** 생성된 모든 아이디어가 담긴 `brainstorming-session-{date}.md`
|
||||
|
||||
:::note[수량 목표]
|
||||
핵심은 아이디어 50-100개 지점에서 나옵니다. 이 워크플로는 정리 전에 100개 이상의 아이디어 생성을 권장합니다.
|
||||
:::
|
||||
|
||||
## bmad-party-mode
|
||||
|
||||
**다중 에이전트 그룹 토론을 조율합니다.** 설치된 모든 BMad 에이전트를 로드하고 각 에이전트가 고유한 전문성과 페르소나로 기여하는 자연스러운 대화를 진행합니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- 결정에 여러 전문가 관점이 필요합니다
|
||||
- 에이전트들이 서로의 가정에 도전하길 원합니다
|
||||
- 여러 도메인에 걸친 복잡한 주제를 탐색합니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 설치된 모든 에이전트 페르소나가 있는 에이전트 매니페스트를 로드합니다
|
||||
2. 주제를 분석해 가장 관련 있는 에이전트 2-3개를 선택합니다
|
||||
3. 에이전트들이 턴을 나눠 기여하고 자연스러운 상호 대화와 의견 차이를 만듭니다
|
||||
4. 시간이 지나며 참여 에이전트를 순환해 다양한 관점을 보장합니다
|
||||
5. `goodbye`, `end party`, `quit`로 종료합니다
|
||||
|
||||
**입력:** 토론 주제 또는 질문, 참여시키고 싶은 페르소나 지정(선택 사항)
|
||||
|
||||
**출력:** 에이전트 페르소나가 유지되는 실시간 다중 에이전트 대화
|
||||
|
||||
## bmad-distillator
|
||||
|
||||
**소스 문서의 무손실 LLM 최적화 압축입니다.** 후속 LLM 사용을 위해 모든 정보를 보존하는 조밀하고 토큰 효율적인 요약본을 생성합니다. 왕복 재구성으로 검증할 수 있습니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- 문서가 LLM 컨텍스트 창에 너무 큽니다
|
||||
- 리서치, 사양, 계획 산출물의 토큰 효율적인 버전이 필요합니다
|
||||
- 압축 중 정보 손실이 없는지 검증하고 싶습니다
|
||||
- 에이전트가 자주 참조하고 정보를 찾아야 합니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. **분석** - 소스 문서를 읽고 정보 밀도와 구조를 식별합니다
|
||||
2. **압축** - 문장을 조밀한 글머리표 형식으로 바꾸고 장식적 서식을 제거합니다
|
||||
3. **확인** - 원래 정보가 모두 보존되었는지 완전성을 확인합니다
|
||||
4. **검증(선택 사항)** - 왕복 재구성 테스트로 무손실 압축을 증명합니다
|
||||
|
||||
**입력:**
|
||||
|
||||
- `source_documents`(필수) - 파일 경로, 폴더 경로, glob 패턴
|
||||
- `downstream_consumer`(선택 사항) - 이 요약본을 사용할 대상(예: "PRD 작성")
|
||||
- `token_budget`(선택 사항) - 대략적 목표 크기
|
||||
- `--validate`(플래그) - 왕복 재구성 테스트 실행
|
||||
|
||||
**출력:** 압축률 보고서(예: "3.2:1")가 포함된 요약 Markdown 파일
|
||||
|
||||
## bmad-advanced-elicitation
|
||||
|
||||
**LLM 출력을 반복 개선 방식으로 개선합니다.** 도출 기법 라이브러리에서 선택해 여러 차례에 걸쳐 내용을 체계적으로 개선합니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- LLM 출력이 얕거나 일반적으로 느껴집니다
|
||||
- 여러 분석 관점에서 주제를 탐색하고 싶습니다
|
||||
- 중요한 문서를 다듬고 더 깊은 사고가 필요합니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 5개 이상의 도출 기법이 있는 기법 레지스트리를 로드합니다
|
||||
2. 내용 유형과 복잡도에 가장 잘 맞는 기법 5개를 선택합니다
|
||||
3. 대화형 메뉴를 제시합니다. 기법 선택, 다시 섞기, 전체 목록 보기가 가능합니다
|
||||
4. 선택한 기법을 적용해 내용을 강화합니다
|
||||
5. "진행"을 선택할 때까지 반복 개선 옵션을 다시 제시합니다
|
||||
|
||||
**입력:** 강화할 내용 섹션
|
||||
|
||||
**출력:** 개선이 적용된 버전
|
||||
|
||||
## bmad-review-adversarial-general
|
||||
|
||||
**문제가 있다고 가정하고 찾는 비판적 리뷰입니다.** 허술한 작업을 용납하지 않는 회의적인 리뷰어의 관점을 취합니다. 틀린 것뿐 아니라 빠진 것을 찾습니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- 산출물 확정 전 품질 보증이 필요합니다
|
||||
- 사양, 스토리, 문서를 스트레스 테스트하고 싶습니다
|
||||
- 낙관적인 리뷰가 놓치는 검토 공백을 찾고 싶습니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 냉정하고 비판적인 관점으로 내용을 읽습니다
|
||||
2. 완전성, 정확성, 품질 전반의 이슈를 식별합니다
|
||||
3. 존재하지만 잘못된 것만이 아니라 빠진 것을 특히 찾습니다
|
||||
4. 최소 10개 이슈를 찾아야 하며, 부족하면 더 깊게 재분석합니다
|
||||
|
||||
**입력:**
|
||||
|
||||
- `content`(필수) - diff, 사양, 스토리, 문서 또는 모든 산출물
|
||||
- `also_consider`(선택 사항) - 추가로 염두에 둘 영역
|
||||
|
||||
**출력:** 설명이 있는 10개 이상의 발견 사항 Markdown 목록
|
||||
|
||||
## bmad-review-edge-case-hunter
|
||||
|
||||
**모든 분기 경로와 경계 조건을 따라가며 처리되지 않은 사례만 보고합니다.** 엣지 케이스 유형을 기계적으로 도출하는 순수 경로 추적 기법입니다. 적대적 리뷰와 상호 보완적이며, 태도 기반이 아니라 기법 기반입니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- 코드나 로직에 대한 철저한 엣지 케이스 검토가 필요합니다
|
||||
- 적대적 리뷰를 보완하고 싶습니다(다른 기법, 다른 발견 사항)
|
||||
- 경계 조건을 확인하기 위해 diff나 함수를 리뷰합니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 내용의 모든 분기 경로를 열거합니다
|
||||
2. 누락된 else/기본값, 보호되지 않은 입력, off-by-one, 산술 오버플로, 암시적 타입 강제 변환, 경쟁 상태, 타임아웃 공백 같은 엣지 케이스 유형을 기계적으로 도출합니다
|
||||
3. 각 경로를 기존 방어 로직과 대조합니다
|
||||
4. 처리되지 않은 경로만 보고합니다. 이미 처리된 경로는 조용히 버립니다
|
||||
|
||||
**입력:**
|
||||
|
||||
- `content`(필수) - diff, 전체 파일, 함수
|
||||
- `also_consider`(선택 사항) - 추가로 염두에 둘 영역
|
||||
|
||||
**출력:** 각 발견 사항이 `location`, `trigger_condition`, `guard_snippet`, `potential_consequence`를 포함하는 JSON 배열
|
||||
|
||||
:::note[상호 보완 리뷰]
|
||||
상호 보완적 검토를 위해 `bmad-review-adversarial-general`과 `bmad-review-edge-case-hunter`를 함께 실행하세요. 적대적 리뷰는 품질과 완전성 이슈를 잡고, 엣지 케이스 헌터는 처리되지 않은 경로를 잡습니다.
|
||||
:::
|
||||
|
||||
## bmad-editorial-review-prose
|
||||
|
||||
**전달 명확성에 집중한 엄격한 문장 교정입니다.** 이해를 방해하는 문장 문제를 리뷰합니다. Microsoft Writing Style Guide 기준을 적용하고 작성자 목소리를 보존합니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- 문서를 초안으로 작성했고 문장을 다듬고 싶습니다
|
||||
- 특정 독자를 위한 명확성을 보장해야 합니다
|
||||
- 취향 기반 수정 없이 전달만 개선하고 싶습니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 코드 블록과 프런트매터를 건너뛰고 내용을 읽습니다
|
||||
2. 스타일 선호가 아닌 전달 이슈를 식별합니다
|
||||
3. 여러 위치의 같은 이슈를 중복 제거합니다
|
||||
4. 세 열 수정 테이블을 생성합니다
|
||||
|
||||
**입력:**
|
||||
|
||||
- `content`(필수) - Markdown, 일반 텍스트, XML
|
||||
- `style_guide`(선택 사항) - 프로젝트별 스타일 가이드
|
||||
- `reader_type`(선택 사항) - 명확성/흐름용 `humans`(기본값) 또는 정밀도/일관성용 `llm`
|
||||
|
||||
**출력:** 세 열 Markdown 테이블: `Original Text | Revised Text | Changes`
|
||||
|
||||
## bmad-editorial-review-structure
|
||||
|
||||
**구조 편집입니다. 삭제, 병합, 이동, 압축을 제안합니다.** 문장 교정 전에 문서 구성을 리뷰하고 명확성과 흐름을 개선하는 실질적 변경을 제안합니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- 여러 하위 프로세스에서 생성된 문서에 구조적 일관성이 필요합니다
|
||||
- 이해도를 유지하면서 문서 길이를 줄이고 싶습니다
|
||||
- 범위 위반이나 묻힌 핵심 정보를 식별해야 합니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 5개 구조 모델(튜토리얼, 참조, 설명, 프롬프트, 전략)에 대해 문서를 분석합니다
|
||||
2. 중복, 범위 위반, 묻힌 정보를 식별합니다
|
||||
3. 우선순위 권장 사항을 생성합니다: `CUT`, `MERGE`, `MOVE`, `CONDENSE`, `QUESTION`, `PRESERVE`
|
||||
4. 총 단어 감소량과 감소율을 추정합니다
|
||||
|
||||
**입력:**
|
||||
|
||||
- `content`(필수) - 리뷰할 문서
|
||||
- `purpose`(선택 사항) - 의도한 목적(예: "빠른 시작 튜토리얼")
|
||||
- `target_audience`(선택 사항) - 독자
|
||||
- `reader_type`(선택 사항) - `humans` 또는 `llm`
|
||||
- `length_target`(선택 사항) - 목표 감소량(예: "30% 줄이기")
|
||||
|
||||
**출력:** 문서 요약, 우선순위 권장 사항 목록, 예상 감소량
|
||||
|
||||
## bmad-shard-doc
|
||||
|
||||
**큰 Markdown 파일을 정리된 섹션 파일로 나눕니다.** 2단계 헤더를 분할 지점으로 사용해 독립적인 섹션 파일과 색인이 있는 폴더를 만듭니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- Markdown 문서가 너무 커져 효과적으로 관리하기 어렵습니다(500줄 이상)
|
||||
- 단일 문서를 탐색 가능한 섹션으로 나누고 싶습니다
|
||||
- 병렬 편집 또는 LLM 컨텍스트 관리를 위해 별도 파일이 필요합니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 소스 파일이 존재하고 Markdown인지 검증합니다
|
||||
2. 2단계(`##`) 헤더 기준으로 번호가 붙은 섹션 파일로 나눕니다
|
||||
3. 섹션 매니페스트와 링크가 있는 `index.md`를 만듭니다
|
||||
4. 원본을 삭제, 보관, 유지할지 묻습니다
|
||||
|
||||
**입력:** 소스 Markdown 파일 경로, 선택 사항 대상 폴더
|
||||
|
||||
**출력:** `index.md`와 `01-{section}.md`, `02-{section}.md` 등이 있는 폴더
|
||||
|
||||
## bmad-index-docs
|
||||
|
||||
**폴더의 모든 문서 색인을 생성하거나 업데이트합니다.** 디렉터리를 스캔하고 각 파일을 읽어 목적을 이해한 뒤 링크와 설명이 있는 정리된 `index.md`를 만듭니다.
|
||||
|
||||
**사용 시점:**
|
||||
|
||||
- 사용 가능한 문서를 LLM이 빠르게 스캔할 수 있는 가벼운 색인이 필요합니다
|
||||
- 문서 폴더가 커져 정리된 목차가 필요합니다
|
||||
- 최신 상태를 유지하는 자동 생성 개요를 원합니다
|
||||
|
||||
**작동 방식:**
|
||||
|
||||
1. 대상 디렉터리에서 숨김이 아닌 파일을 모두 스캔합니다
|
||||
2. 각 파일을 읽어 실제 목적을 이해합니다
|
||||
3. 유형, 목적, 하위 디렉터리 기준으로 파일을 그룹화합니다
|
||||
4. 간결한 설명(각 3-10단어)을 생성합니다
|
||||
|
||||
**입력:** 대상 폴더 경로
|
||||
|
||||
**출력:** 정리된 파일 목록, 상대 링크, 짧은 설명이 있는 `index.md`
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
---
|
||||
title: 공식 모듈
|
||||
description: 커스텀 에이전트, 창의적 지능, 게임 개발, 테스트를 위한 추가 모듈
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
BMad는 설치 중 선택하는 공식 모듈로 확장됩니다. 이러한 추가 모듈은 내장 핵심 기능과 BMM(애자일 제품군)을 넘어 특정 도메인을 위한 전문 에이전트, 워크플로, 작업을 제공합니다.
|
||||
|
||||
:::tip[모듈 설치]
|
||||
`npx bmad-method install`을 실행하고 원하는 모듈을 선택하세요. 설치 프로그램이 다운로드, 설정, IDE 통합을 자동으로 처리합니다.
|
||||
:::
|
||||
|
||||
## BMad 빌더(BMB)
|
||||
|
||||
안내형 도구를 사용해 커스텀 에이전트, 워크플로, 도메인 특화 모듈을 만듭니다. BMad 빌더는 프레임워크 자체를 확장하는 메타 모듈입니다.
|
||||
|
||||
- **코드:** `bmb`
|
||||
- **npm:** [`bmad-builder`](https://www.npmjs.com/package/bmad-builder)
|
||||
- **GitHub:** [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder)
|
||||
|
||||
**제공:**
|
||||
|
||||
- 에이전트 빌더 - 커스텀 전문성과 도구 접근 권한이 있는 전문 AI 에이전트 생성
|
||||
- 워크플로 빌더 - 단계와 결정 지점이 있는 구조화된 프로세스 설계
|
||||
- 모듈 빌더 - 에이전트와 워크플로를 공유 및 게시 가능한 모듈로 패키징
|
||||
- YAML 설정과 npm 게시 지원이 있는 대화형 설정
|
||||
|
||||
## 창의적 지능 제품군(CIS)
|
||||
|
||||
초기 개발 단계의 구조화된 창의성, 아이디어 발상, 혁신을 위한 AI 기반 도구입니다. 이 제품군은 검증된 프레임워크를 사용해 브레인스토밍, 디자인 사고, 문제 해결을 진행하는 여러 에이전트를 제공합니다.
|
||||
|
||||
- **코드:** `cis`
|
||||
- **npm:** [`bmad-creative-intelligence-suite`](https://www.npmjs.com/package/bmad-creative-intelligence-suite)
|
||||
- **GitHub:** [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)
|
||||
|
||||
**제공:**
|
||||
|
||||
- 혁신 전략가, 디자인 사고 코치, 브레인스토밍 코치 에이전트
|
||||
- 체계적 사고와 수평적 사고를 위한 문제 해결자와 창의적 문제 해결자
|
||||
- 내러티브와 피치를 위한 스토리텔러와 발표 마스터
|
||||
- SCAMPER, 역브레인스토밍, 문제 재구성을 포함한 아이디어 발상 프레임워크
|
||||
|
||||
## 게임 개발 스튜디오(BMGD)
|
||||
|
||||
Unity, Unreal, Godot, 커스텀 엔진에 맞춘 구조화된 게임 개발 워크플로입니다. 빠른 흐름을 통한 신속한 프로토타이핑과 에픽 중심 스프린트를 통한 전체 규모 제작을 지원합니다.
|
||||
|
||||
- **코드:** `gds`
|
||||
- **npm:** [`bmad-game-dev-studio`](https://www.npmjs.com/package/bmad-game-dev-studio)
|
||||
- **GitHub:** [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio)
|
||||
|
||||
**제공:**
|
||||
|
||||
- 게임 디자인 문서 생성 워크플로
|
||||
- 신속한 프로토타이핑을 위한 빠른 개발 모드
|
||||
- 캐릭터, 대화, 세계관 구축을 위한 내러티브 디자인 지원
|
||||
- 21개 이상 게임 유형과 엔진별 아키텍처 가이드 지원
|
||||
|
||||
## 테스트 설계자(TEA)
|
||||
|
||||
전문가 에이전트와 9개의 구조화된 워크플로를 통해 엔터프라이즈급 테스트 전략, 자동화 가이드, 릴리스 게이트 결정을 지원합니다. TEA는 위험 기반 우선순위와 요구사항 추적성으로 내장 QA 에이전트를 크게 넘어섭니다.
|
||||
|
||||
- **코드:** `tea`
|
||||
- **npm:** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||
- **GitHub:** [bmad-code-org/bmad-method-test-architecture-enterprise](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)
|
||||
|
||||
**제공:**
|
||||
|
||||
- Murat 에이전트(마스터 테스트 아키텍트 겸 품질 조언자)
|
||||
- 테스트 설계, ATDD, 자동화, 테스트 리뷰, 추적성 워크플로
|
||||
- NFR 평가, CI 설정, 프레임워크 초기 구조 생성
|
||||
- 선택적 Playwright 유틸리티 및 MCP 통합을 포함한 P0-P3 우선순위
|
||||
|
||||
## 커뮤니티 모듈
|
||||
|
||||
커뮤니티 모듈과 모듈 마켓플레이스가 준비 중입니다. 업데이트는 [BMad GitHub 조직](https://github.com/bmad-code-org)을 확인하세요.
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
---
|
||||
title: 테스트 옵션
|
||||
description: 내장 QA 워크플로와 테스트 설계자(TEA) 모듈의 테스트 자동화 비교
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
BMad는 두 가지 테스트 경로를 제공합니다. 빠른 테스트 생성을 위한 내장 QA 워크플로와 엔터프라이즈급 테스트 전략을 위한 설치 가능한 테스트 설계자 모듈입니다.
|
||||
|
||||
## 무엇을 사용해야 하나요?
|
||||
|
||||
| 기준 | 내장 QA | TEA 모듈 |
|
||||
| --- | --- | --- |
|
||||
| **적합한 경우** | 중소형 프로젝트, 빠른 커버리지 | 대형 프로젝트, 규제 대상 또는 복잡한 도메인 |
|
||||
| **설정** | 설치할 것 없음 - BMM에 포함 | `npx bmad-method install`로 별도 설치 |
|
||||
| **접근 방식** | 테스트를 빠르게 생성하고 나중에 반복 개선 | 먼저 계획하고 추적 가능하게 생성 |
|
||||
| **테스트 유형** | API 및 E2E 테스트 | API, E2E, ATDD, NFR 등 |
|
||||
| **전략** | 정상 경로 + 중요한 엣지 케이스 | 위험 기반 우선순위(P0-P3) |
|
||||
| **워크플로 수** | 1(자동화) | 9개(설계, ATDD, 자동화, 리뷰, 추적 등) |
|
||||
|
||||
:::tip[내장 QA로 시작]
|
||||
대부분의 프로젝트는 내장 QA 워크플로로 시작하면 됩니다. 나중에 테스트 전략, 품질 게이트, 요구사항 추적성이 필요해지면 TEA를 함께 설치하세요.
|
||||
:::
|
||||
|
||||
## 내장 QA 워크플로
|
||||
|
||||
내장 QA 워크플로(`bmad-qa-generate-e2e-tests`)는 BMM(애자일 제품군) 모듈의 일부이며 개발자 에이전트를 통해 사용할 수 있습니다. 설정이나 추가 설치 없이 프로젝트의 기존 테스트 프레임워크를 사용해 실행 가능한 테스트를 빠르게 생성합니다.
|
||||
|
||||
**트리거:** `QA`(개발자 에이전트를 통해) 또는 `bmad-qa-generate-e2e-tests`
|
||||
|
||||
### 하는 일
|
||||
|
||||
QA 자동화 워크플로는 다섯 단계를 거칩니다.
|
||||
|
||||
1. **테스트 프레임워크 감지** - `package.json`과 기존 테스트 파일을 스캔해 프레임워크(Jest, Vitest, Playwright, Cypress 또는 표준 러너)를 찾습니다. 없으면 프로젝트 스택을 분석해 제안합니다.
|
||||
2. **기능 식별** - 무엇을 테스트할지 묻거나 코드베이스에서 기능을 자동으로 발견합니다.
|
||||
3. **API 테스트 생성** - 상태 코드, 응답 구조, 정상 경로, 오류 사례 1-2개를 다룹니다.
|
||||
4. **E2E 테스트 생성** - 의미 기반 로케이터와 사용자에게 보이는 결과 검증으로 사용자 워크플로를 다룹니다.
|
||||
5. **실행 및 검증** - 생성된 테스트를 실행하고 실패를 즉시 수정합니다.
|
||||
|
||||
워크플로는 프로젝트의 구현 산출물 폴더에 저장되는 테스트 요약을 생성합니다.
|
||||
|
||||
### 테스트 패턴
|
||||
|
||||
생성된 테스트는 "단순하고 유지보수하기 쉬운" 철학을 따릅니다.
|
||||
|
||||
- **표준 프레임워크 API만 사용** - 외부 유틸리티나 커스텀 추상화 없음
|
||||
- UI 테스트에는 CSS 선택자 대신 **의미 기반 로케이터** 사용(역할, 레이블, 텍스트)
|
||||
- 순서 의존성이 없는 **독립 테스트**
|
||||
- 하드코딩된 대기(`wait`/`sleep`) 없음
|
||||
- 기능 문서처럼 읽히는 명확한 설명
|
||||
|
||||
:::note[범위]
|
||||
QA 워크플로는 테스트만 생성합니다. 코드 리뷰와 스토리 검증에는 코드 리뷰 워크플로(`CR`)를 사용하세요.
|
||||
:::
|
||||
|
||||
### 내장 QA 사용 시점
|
||||
|
||||
- 새 기능 또는 기존 기능의 빠른 테스트 커버리지
|
||||
- 고급 설정 없는 초보자 친화적 테스트 자동화
|
||||
- 모든 개발자가 읽고 유지할 수 있는 표준 테스트 패턴
|
||||
- 포괄적인 테스트 전략이 불필요한 중소형 프로젝트
|
||||
|
||||
## 테스트 설계자(TEA) 모듈
|
||||
|
||||
TEA는 전문가 에이전트(Murat)와 엔터프라이즈급 테스트를 위한 9개 구조화된 워크플로를 제공하는 단독 실행 모듈입니다. 테스트 생성을 넘어 테스트 전략, 위험 기반 계획, 품질 게이트, 요구사항 추적성을 다룹니다.
|
||||
|
||||
- **문서:** [TEA 모듈 문서](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
||||
- **설치:** `npx bmad-method install` 실행 후 TEA 모듈 선택
|
||||
- **npm:** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||
|
||||
### TEA가 제공하는 것
|
||||
|
||||
| 워크플로 | 목적 |
|
||||
| --- | --- |
|
||||
| 테스트 설계 | 요구사항에 연결된 포괄적 테스트 전략 생성 |
|
||||
| ATDD | 이해관계자 기준을 활용한 인수 테스트 주도 개발 |
|
||||
| 자동화 | 고급 패턴과 유틸리티로 테스트 생성 |
|
||||
| 테스트 리뷰 | 전략 대비 테스트 품질과 커버리지 검증 |
|
||||
| 추적성 | 감사 및 컴플라이언스를 위해 테스트를 요구사항에 매핑 |
|
||||
| NFR 평가 | 성능, 보안 등 비기능 요구사항 평가 |
|
||||
| CI 설정 | 지속적 통합 파이프라인에서 테스트 실행 구성 |
|
||||
| 프레임워크 초기 구조 생성 | 테스트 인프라와 프로젝트 구조 설정 |
|
||||
| 릴리스 게이트 | 데이터 기반 출시 여부 결정 |
|
||||
|
||||
TEA는 P0-P3 위험 기반 우선순위와 선택적 Playwright 유틸리티 및 MCP 도구 통합도 지원합니다.
|
||||
|
||||
### TEA 사용 시점
|
||||
|
||||
- 요구사항 추적성 또는 컴플라이언스 문서화가 필요한 프로젝트
|
||||
- 많은 기능에 대해 위험 기반 테스트 우선순위가 필요한 팀
|
||||
- 릴리스 전 공식 품질 게이트가 있는 엔터프라이즈 환경
|
||||
- 테스트 작성 전에 테스트 전략이 계획되어야 하는 복잡한 도메인
|
||||
- 내장 QA의 단일 워크플로 접근 방식으로는 부족한 프로젝트
|
||||
|
||||
## 테스트가 워크플로와 맞물리는 방식
|
||||
|
||||
QA 자동화 워크플로는 BMad Method 워크플로 맵의 단계 4(구현)에 나타납니다. **전체 에픽이 완료된 후**, 즉 에픽의 모든 스토리가 구현되고 코드 리뷰된 뒤 실행하도록 설계되었습니다. 일반적인 순서는 다음과 같습니다.
|
||||
|
||||
1. 에픽의 각 스토리마다 개발자(`DS`)로 구현하고 코드 리뷰(`CR`)로 검증합니다
|
||||
2. 에픽 완료 후 `QA`(개발자 에이전트를 통해) 또는 TEA의 자동화 워크플로로 테스트를 생성합니다
|
||||
3. `bmad-retrospective`를 실행해 배운 점을 기록합니다
|
||||
|
||||
내장 QA 워크플로는 계획 문서(PRD, 아키텍처)를 로드하지 않고 소스 코드에서 직접 작업합니다. TEA 워크플로는 추적성을 위해 상위 계획 산출물과 통합할 수 있습니다.
|
||||
|
||||
전체 프로세스에서 테스트가 어디에 맞물리는지는 [워크플로 맵](./workflow-map.md)을 참고하세요.
|
||||
|
|
@ -0,0 +1,102 @@
|
|||
---
|
||||
title: "워크플로 맵"
|
||||
description: BMad Method 워크플로 단계와 출력의 시각적 참조
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
BMad Method(BMM)는 BMad 생태계의 모듈이며 컨텍스트 엔지니어링과 계획 모범 사례를 따르는 데 초점을 둡니다. AI 에이전트는 명확하고 구조화된 컨텍스트가 있을 때 가장 잘 작동합니다. BMM 시스템은 4개의 구분된 단계에 걸쳐 그 컨텍스트를 점진적으로 만듭니다. 각 단계와 단계 안의 여러 선택 워크플로는 다음 단계에 필요한 정보를 담은 문서를 만들고, 에이전트는 항상 무엇을 왜 만들어야 하는지 알게 됩니다.
|
||||
|
||||
그 근거와 개념은 업계 전반에서 성공적으로 사용되어 온 애자일 방법론에서 온 사고 프레임워크입니다.
|
||||
|
||||
언제든 무엇을 해야 할지 확실하지 않다면 `bmad-help` 스킬이 흐름을 잡아 주고 다음 단계를 알려줍니다. 이 문서를 참조로 사용할 수도 있지만, 이미 BMad Method를 설치했다면 `bmad-help`가 더 대화형이고 훨씬 빠릅니다. 또한 BMad Method를 확장한 다른 모듈이나 함께 쓰는 보완 모듈을 사용한다면 `bmad-help`도 사용 가능한 항목을 모두 파악해 현재 상황에 가장 적절한 조언을 제공합니다.
|
||||
|
||||
마지막으로 중요한 점: 아래 모든 워크플로는 스킬로 직접 실행하거나, 먼저 에이전트를 로드한 뒤 에이전트 메뉴 항목을 사용해 원하는 도구에서 실행할 수 있습니다.
|
||||
|
||||
<iframe src="/workflow-map-diagram-ko-kr.html" title="BMad Method 워크플로 맵 다이어그램" width="100%" height="100%" style="border-radius: 8px; border: 1px solid #334155; min-height: 900px;"></iframe>
|
||||
|
||||
<p style="font-size: 0.8rem; text-align: right; margin-top: -0.5rem; margin-bottom: 1rem;">
|
||||
<a href="/workflow-map-diagram-ko-kr.html" target="_blank" rel="noopener noreferrer">다이어그램 새 탭에서 열기 ↗</a>
|
||||
</p>
|
||||
|
||||
## 단계 1: 분석(선택)
|
||||
|
||||
계획을 확정하기 전에 문제 영역을 탐색하고 아이디어를 검증합니다. [**각 도구가 무엇을 하고 언제 쓰는지 알아보기**](../explanation/analysis-phase.md).
|
||||
|
||||
| 워크플로 | 목적 | 산출물 |
|
||||
| --- | --- | --- |
|
||||
| `bmad-brainstorming` | 브레인스토밍 코치의 안내를 받아 프로젝트 아이디어를 발산합니다 | `brainstorming-report.md` |
|
||||
| `bmad-domain-research`, `bmad-market-research`, `bmad-technical-research` | 시장, 기술, 도메인 가정을 검증합니다 | 연구 발견 사항 |
|
||||
| `bmad-product-brief` | 전략적 비전을 포착합니다. 개념이 명확할 때 가장 좋습니다 | `product-brief.md` |
|
||||
| `bmad-prfaq` | 워킹 백워드 방식으로 제품 개념을 스트레스 테스트하고 다듬습니다 | `prfaq-{project}.md` |
|
||||
|
||||
## 단계 2: 계획
|
||||
|
||||
무엇을 누구를 위해 만들지 정의합니다.
|
||||
|
||||
| 워크플로 | 목적 | 산출물 |
|
||||
| --- | --- | --- |
|
||||
| `bmad-prd` | PRD를 생성, 업데이트, 검증합니다. 안내형 발견 과정과 세 가지 의도를 하나의 스킬에 담았습니다 | 생성/업데이트: `prd.md`, `addendum.md`, `decision-log.md`; 검증: `validation-report.html` + `.md` |
|
||||
| `bmad-create-ux-design` | UX가 중요할 때 사용자 경험을 설계합니다 | `ux-spec.md` |
|
||||
|
||||
:::tip[하나의 스킬 안에 세 의도]
|
||||
`bmad-prd`는 전체 PRD 수명주기를 처리합니다. 호출할 때 의도를 말하거나 스킬이 물어보게 하세요.
|
||||
|
||||
- **생성** - 안내형 발견 과정을 통해 처음부터 새 PRD를 만듭니다. `prd.md`, `addendum.md`, `decision-log.md`를 생성합니다
|
||||
- **업데이트** - 기존 PRD와 변경 신호를 조정하고, 변경을 적용하기 전에 충돌을 식별합니다
|
||||
- **검증** - 설정 가능한 체크리스트로 PRD를 비판적으로 검토하고 구조화된 HTML 발견 사항 보고서를 생성합니다
|
||||
:::
|
||||
|
||||
:::tip[상위 입력: `bmad-product-brief`]
|
||||
`bmad-product-brief`(단계 1)는 `bmad-prd`가 발견 과정에서 입력으로 사용할 수 있는 `product-brief.md`를 생성합니다. 재설명을 줄이고 두 문서를 서로 맞춰 유지합니다. 두 스킬이 서로 필수는 아닙니다. 무엇을 만들지 이미 안다면 `bmad-prd`로 바로 시작하세요.
|
||||
:::
|
||||
|
||||
## 단계 3: 솔루션 설계
|
||||
|
||||
어떻게 만들지 결정하고 작업을 스토리로 나눕니다.
|
||||
|
||||
| 워크플로 | 목적 | 산출물 |
|
||||
| --- | --- | --- |
|
||||
| `bmad-create-architecture` | 기술적 결정을 명시적으로 만듭니다 | ADR이 있는 `architecture.md` |
|
||||
| `bmad-create-epics-and-stories` | 요구사항을 구현 가능한 작업으로 나눕니다 | 스토리가 있는 에픽 파일 |
|
||||
| `bmad-check-implementation-readiness` | 구현 전 관문 점검 | 통과/우려/실패 결정 |
|
||||
|
||||
## 단계 4: 구현
|
||||
|
||||
스토리 하나씩 구현합니다. 전체 4단계 자동화는 곧 제공됩니다.
|
||||
|
||||
| 워크플로 | 목적 | 산출물 |
|
||||
| --- | --- | --- |
|
||||
| `bmad-sprint-planning` | 추적 상태 초기화(프로젝트당 한 번, 개발 주기 순서화) | `sprint-status.yaml` |
|
||||
| `bmad-create-story` | 구현을 위한 다음 스토리 준비 | `story-[slug].md` |
|
||||
| `bmad-dev-story` | 스토리 구현 | 작동하는 코드 + 테스트 |
|
||||
| `bmad-code-review` | 구현 품질 검증 | 승인 또는 변경 요청 |
|
||||
| `bmad-correct-course` | 스프린트 중 의미 있는 변경 처리 | 업데이트된 계획 또는 경로 재조정 |
|
||||
| `bmad-sprint-status` | 스프린트 진행 상황과 스토리 상태 추적 | 스프린트 상태 업데이트 |
|
||||
| `bmad-retrospective` | 에픽 완료 후 회고 | 배운 점 |
|
||||
| `bmad-investigate` | 입력에 맞게 보정된 증거 등급 발견 사항 기반 포렌식 사례 조사 | `{slug}-investigation.md` |
|
||||
|
||||
## 빠른 흐름(병렬 트랙)
|
||||
|
||||
작고 잘 이해된 작업에서는 단계 1-3을 건너뜁니다.
|
||||
|
||||
| 워크플로 | 목적 | 산출물 |
|
||||
| --- | --- | --- |
|
||||
| `bmad-quick-dev` | 통합 빠른 흐름 - 의도 정리, 계획, 구현, 리뷰, 발표 | `spec-*.md` + 코드 |
|
||||
|
||||
## 컨텍스트 관리
|
||||
|
||||
각 문서는 다음 단계의 컨텍스트가 됩니다. PRD는 아키텍트에게 어떤 제약이 중요한지 알려줍니다. 아키텍처는 개발 에이전트에게 어떤 패턴을 따라야 하는지 알려줍니다. 스토리 파일은 구현을 위한 집중적이고 완결된 컨텍스트를 제공합니다. 이 구조가 없으면 에이전트는 일관되지 않은 결정을 내립니다.
|
||||
|
||||
### 프로젝트 컨텍스트
|
||||
|
||||
:::tip[권장]
|
||||
AI 에이전트가 프로젝트의 규칙과 선호 사항을 따르도록 `project-context.md`를 만드세요. 이 파일은 프로젝트의 헌장처럼 작동해 모든 워크플로에서 구현 결정을 안내합니다. 이 선택 파일은 아키텍처 작성이 끝날 때 생성할 수 있고, 기존 프로젝트에서도 현재 관례와 맞춰야 할 중요한 내용을 포착하기 위해 생성할 수 있습니다.
|
||||
:::
|
||||
|
||||
**만드는 방법:**
|
||||
|
||||
- **수동으로** - `_bmad-output/project-context.md`를 만들고 기술 스택과 구현 규칙을 작성합니다
|
||||
- **생성하기** - `bmad-generate-project-context`를 실행해 아키텍처 또는 코드베이스에서 자동 생성합니다
|
||||
|
||||
[**project-context.md 더 알아보기**](../explanation/project-context.md)
|
||||
|
|
@ -0,0 +1,136 @@
|
|||
---
|
||||
title: 로드맵
|
||||
description: BMad의 다음 단계 - 기능, 개선 사항, 커뮤니티 기여
|
||||
---
|
||||
|
||||
# BMad Method: 공개 로드맵
|
||||
|
||||
BMad Method, BMad Method 모듈(BMM), BMad 빌더(BMB)는 계속 발전하고 있습니다. 현재 진행 중인 작업과 앞으로 예정된 항목을 소개합니다.
|
||||
|
||||
<div class="roadmap-container">
|
||||
|
||||
<h2 class="roadmap-section-title">진행 중</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🧩</span>
|
||||
<h4>범용 스킬 아키텍처</h4>
|
||||
<p>스킬 하나를 어떤 플랫폼에서든 사용할 수 있게 합니다. 한 번 작성하고 어디서나 실행합니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏗️</span>
|
||||
<h4>BMad 빌더 v1</h4>
|
||||
<p>평가, 팀 구성, 점진적 기능 저하를 내장한 프로덕션 준비 AI 에이전트와 워크플로를 만듭니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🧠</span>
|
||||
<h4>프로젝트 컨텍스트 시스템</h4>
|
||||
<p>AI가 실제로 프로젝트를 이해합니다. 코드베이스와 함께 진화하는, 프레임워크를 이해하는 컨텍스트입니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">📦</span>
|
||||
<h4>중앙화된 스킬</h4>
|
||||
<p>한 번 설치하고 어디서나 사용합니다. 파일이 어지럽게 늘어나지 않게 프로젝트 간 스킬을 공유합니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🔄</span>
|
||||
<h4>적응형 스킬</h4>
|
||||
<p>도구를 이해하는 스킬입니다. Claude, Codex, Kimi, OpenCode 등 다양한 도구에 맞춘 변형을 제공합니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">📝</span>
|
||||
<h4>BMad 팀 전문가 블로그</h4>
|
||||
<p>팀이 전하는 가이드, 글, 인사이트입니다. 곧 공개됩니다.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="roadmap-section-title">시작 단계</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏪</span>
|
||||
<h4>스킬 마켓플레이스</h4>
|
||||
<p>커뮤니티가 만든 스킬을 발견하고 설치하고 업데이트합니다. curl 명령 하나로 기능을 확장합니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎨</span>
|
||||
<h4>워크플로 커스터마이징</h4>
|
||||
<p>내 방식에 맞게 조정합니다. Jira, Linear, 커스텀 출력까지, 당신의 워크플로와 규칙에 맞춥니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🚀</span>
|
||||
<h4>1-3단계 최적화</h4>
|
||||
<p>서브 에이전트 컨텍스트 수집으로 빠른 계획을 지원합니다. YOLO 모드의 속도와 안내형 워크플로의 품질을 함께 가져갑니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🌐</span>
|
||||
<h4>엔터프라이즈 준비</h4>
|
||||
<p>SSO, 감사 로그, 팀 워크스페이스. 기업 도입에 필요한 기반 기능입니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">💎</span>
|
||||
<h4>커뮤니티 모듈 확대</h4>
|
||||
<p>엔터테인먼트, 보안, 테라피, 롤플레이 등 훨씬 더 많은 영역으로 BMad Method 플랫폼을 확장합니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">⚡</span>
|
||||
<h4>개발 루프 자동화</h4>
|
||||
<p>개발을 위한 선택형 자동 조종 기능입니다. 품질을 높게 유지하면서 AI가 흐름을 처리하게 합니다.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="roadmap-section-title">커뮤니티와 팀</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎙️</span>
|
||||
<h4>BMad Method 팟캐스트</h4>
|
||||
<p>AI 네이티브 개발에 관한 대화입니다. 2026년 3월 1일 공개 예정입니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎓</span>
|
||||
<h4>BMad Method 마스터 클래스</h4>
|
||||
<p>사용자에서 전문가로 나아갑니다. 모든 단계와 워크플로를 깊게 다룹니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏗️</span>
|
||||
<h4>BMad 빌더 마스터 클래스</h4>
|
||||
<p>직접 에이전트를 만듭니다. 단순한 사용을 넘어 직접 만들 준비가 되었을 때 필요한 고급 기법입니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">⚡</span>
|
||||
<h4>BMad Prototype First</h4>
|
||||
<p>아이디어에서 작동하는 프로토타입까지 한 세션에 이어 갑니다. 구상하던 앱을 빠르게 실체로 만듭니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🌴</span>
|
||||
<h4>BMad BALM!</h4>
|
||||
<p>AI 네이티브 시대의 생활 관리입니다. 작업, 습관, 목표까지 아우르는 AI 코파일럿입니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🖥️</span>
|
||||
<h4>공식 UI</h4>
|
||||
<p>전체 BMad 생태계를 위한 세련된 인터페이스입니다. CLI의 힘과 GUI의 편의성을 함께 제공합니다.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🔒</span>
|
||||
<h4>BMad in a Box</h4>
|
||||
<p>셀프 호스팅, 망 분리, 엔터프라이즈급 배포를 지원합니다. 당신의 AI 어시스턴트를 당신의 인프라에서 직접 통제합니다.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="text-align: center; margin-top: 3rem; padding: 2rem; background: var(--color-bg-card); border-radius: 12px; border: 1px solid var(--color-border);">
|
||||
<h3 style="margin: 0 0 1rem;">기여하고 싶나요?</h3>
|
||||
<p style="color: var(--slate-color-400); margin: 0;">
|
||||
이것은 계획된 항목의 일부일 뿐입니다. BMad 오픈 소스 팀은 기여자를 환영합니다!{" "}<br />
|
||||
<a href="https://github.com/bmad-code-org/BMAD-METHOD" style="color: var(--color-in-progress);">GitHub에서 함께</a> AI 기반 개발의 미래를 만들어 주세요.
|
||||
</p>
|
||||
<p style="color: var(--slate-color-400); margin: 1.5rem 0 0;">
|
||||
우리가 만드는 것을 좋아하시나요? 일회성 및 월간{" "}<a href="https://buymeacoffee.com/bmad" style="color: var(--color-in-progress);">후원</a> 모두 감사히 받습니다.
|
||||
</p>
|
||||
<p style="color: var(--slate-color-400); margin: 1rem 0 0;">
|
||||
기업 후원, 파트너십 문의, 발표 요청, 교육, 미디어 문의는{" "}
|
||||
<a href="mailto:contact@bmadcode.com" style="color: var(--color-in-progress);">contact@bmadcode.com</a>으로 연락하세요.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,289 @@
|
|||
---
|
||||
title: "시작하기"
|
||||
description: BMad를 설치하고 첫 프로젝트를 만듭니다
|
||||
---
|
||||
|
||||
계획, 아키텍처, 구현을 안내하는 전문 에이전트 기반 AI 워크플로로 소프트웨어를 더 빠르게 만드세요.
|
||||
|
||||
## 배울 내용
|
||||
|
||||
- 새 프로젝트에 BMad Method를 설치하고 초기화합니다
|
||||
- 다음에 무엇을 해야 할지 아는 지능형 안내자 **BMad 도움말**을 사용합니다
|
||||
- 프로젝트 규모에 맞는 계획 트랙을 선택합니다
|
||||
- 요구사항부터 작동하는 코드까지 단계별로 진행합니다
|
||||
- 에이전트와 워크플로를 효과적으로 사용합니다
|
||||
|
||||
:::note[필수 조건]
|
||||
- **Node.js 20+** - 설치 프로그램에 필요합니다
|
||||
- **Git** - 버전 관리를 위해 권장합니다
|
||||
- **AI 기반 IDE** - Claude Code, Cursor 또는 유사 도구
|
||||
- **프로젝트 아이디어** - 학습용이라면 단순한 아이디어도 충분합니다
|
||||
:::
|
||||
|
||||
:::tip[가장 쉬운 경로]
|
||||
**설치** → `npx bmad-method install`
|
||||
**질문** → `bmad-help 먼저 무엇을 해야 하나요?`
|
||||
**빌드** → BMad 도움말의 안내에 따라 워크플로를 진행하세요
|
||||
:::
|
||||
|
||||
## BMad 도움말 만나기: 지능형 안내자
|
||||
|
||||
**BMad 도움말은 BMad를 시작하는 가장 빠른 방법입니다.** 워크플로나 단계를 외울 필요가 없습니다. 그냥 물어보면 BMad 도움말이 다음을 수행합니다.
|
||||
|
||||
- **프로젝트를 검사**해 이미 완료된 작업을 확인합니다
|
||||
- 설치된 모듈을 기준으로 **선택지를 보여줍니다**
|
||||
- 첫 필수 작업을 포함해 **다음 단계를 추천합니다**
|
||||
- "SaaS 아이디어가 있는데 어디서 시작하지?" 같은 **질문에 답합니다**
|
||||
|
||||
### BMad 도움말 사용 방법
|
||||
|
||||
AI IDE에서 스킬을 호출해 실행합니다.
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
컨텍스트가 있는 안내를 받으려면 질문과 함께 사용할 수도 있습니다.
|
||||
|
||||
```
|
||||
bmad-help SaaS 제품 아이디어가 있고 원하는 기능도 모두 알고 있습니다. 어디서 시작하면 좋나요?
|
||||
```
|
||||
|
||||
BMad 도움말은 다음을 답합니다.
|
||||
|
||||
- 현재 상황에 권장되는 선택지
|
||||
- 첫 번째 필수 작업
|
||||
- 나머지 과정의 모습
|
||||
|
||||
### 워크플로 끝에서도 동작합니다
|
||||
|
||||
BMad 도움말은 질문에 답하기만 하지 않습니다. **모든 워크플로 끝에서 자동으로 실행되어** 다음에 무엇을 해야 할지 알려줍니다. 추측하거나 문서를 뒤질 필요 없이 다음 필수 워크플로에 대한 명확한 안내를 받습니다.
|
||||
|
||||
:::tip[여기서 시작하세요]
|
||||
BMad를 설치한 뒤 바로 `bmad-help` 스킬을 호출하세요. 설치된 모듈을 감지하고 프로젝트에 맞는 시작점으로 안내합니다.
|
||||
:::
|
||||
|
||||
## BMad 이해하기
|
||||
|
||||
BMad는 전문 AI 에이전트가 있는 안내형 워크플로를 통해 소프트웨어를 만들도록 돕습니다. 과정은 네 단계로 진행됩니다.
|
||||
|
||||
| 단계 | 이름 | 일어나는 일 |
|
||||
| --- | --- | --- |
|
||||
| 1 | 분석 | 브레인스토밍, 리서치, 제품 개요 또는 PRFAQ *(선택)* |
|
||||
| 2 | 계획 | 요구사항 작성(PRD 또는 사양) |
|
||||
| 3 | 솔루션 설계 | 아키텍처 설계 *(BMad Method/엔터프라이즈 전용)* |
|
||||
| 4 | 구현 | 에픽별, 스토리별 구현 |
|
||||
|
||||
단계, 워크플로, 컨텍스트 관리를 살펴보려면 **[워크플로 맵 열기](../reference/workflow-map.md)**를 확인하세요.
|
||||
|
||||
프로젝트 복잡도에 따라 BMad는 세 가지 계획 트랙을 제공합니다.
|
||||
|
||||
| 트랙 | 적합한 경우 | 생성되는 문서 |
|
||||
| --- | --- | --- |
|
||||
| **빠른 흐름** | 버그 수정, 단순 기능, 명확한 범위(1-15개 스토리) | 기술 사양만 |
|
||||
| **BMad Method** | 제품, 플랫폼, 복잡한 기능(10-50개 이상 스토리) | PRD + 아키텍처 + UX |
|
||||
| **엔터프라이즈** | 컴플라이언스, 멀티테넌트 시스템(30개 이상 스토리) | PRD + 아키텍처 + 보안 + DevOps |
|
||||
|
||||
:::note
|
||||
스토리 수는 기준이 아니라 안내입니다. 스토리 수 계산보다 계획 필요성에 따라 트랙을 선택하세요.
|
||||
:::
|
||||
|
||||
## 설치
|
||||
|
||||
프로젝트 디렉터리에서 터미널을 열고 실행합니다.
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
기본 릴리스 채널 대신 최신 사전 릴리스 빌드를 원한다면 `npx bmad-method@next install`을 사용하세요.
|
||||
|
||||
모듈 선택 프롬프트가 나오면 **BMad Method**를 선택합니다.
|
||||
|
||||
설치 프로그램은 두 폴더를 만듭니다.
|
||||
|
||||
- `_bmad/` - 에이전트, 워크플로, 작업, 설정
|
||||
- `_bmad-output/` - 지금은 비어 있지만 산출물이 저장될 위치입니다
|
||||
|
||||
:::tip[다음 단계]
|
||||
프로젝트 폴더에서 AI IDE를 열고 다음을 실행하세요.
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
BMad 도움말이 완료된 작업을 감지하고 정확한 다음 단계를 추천합니다. "내 선택지는 무엇인가요?" 또는 "SaaS 아이디어가 있는데 어디서 시작해야 하나요?"처럼 물어볼 수도 있습니다.
|
||||
:::
|
||||
|
||||
:::note[에이전트를 로드하고 워크플로를 실행하는 방법]
|
||||
각 워크플로에는 IDE에서 이름으로 호출하는 **스킬**이 있습니다(예: `bmad-prd`). AI 도구가 `bmad-*` 이름을 인식하고 실행하므로 에이전트를 따로 로드할 필요가 없습니다. 일반 대화를 위해 에이전트 스킬을 직접 호출할 수도 있습니다(예: PM 에이전트용 `bmad-agent-pm`).
|
||||
:::
|
||||
|
||||
:::caution[새 채팅]
|
||||
각 워크플로는 항상 새 채팅에서 시작하세요. 이렇게 하면 컨텍스트 제한으로 인한 문제를 예방할 수 있습니다.
|
||||
:::
|
||||
|
||||
## 1단계: 계획 만들기
|
||||
|
||||
1-3단계를 진행합니다. **각 워크플로는 새 채팅에서 실행하세요.**
|
||||
|
||||
:::tip[프로젝트 컨텍스트(선택)]
|
||||
시작하기 전에 `project-context.md`를 만들어 기술 선호도와 구현 규칙을 문서화하는 것을 고려하세요. 이렇게 하면 모든 AI 에이전트가 프로젝트 전반에서 당신의 규칙을 따릅니다.
|
||||
|
||||
`_bmad-output/project-context.md`에 직접 만들거나 아키텍처 이후 `bmad-generate-project-context`로 생성할 수 있습니다. [자세히 알아보기](../explanation/project-context.md).
|
||||
:::
|
||||
|
||||
### 1단계: 분석(선택)
|
||||
|
||||
이 단계의 모든 워크플로는 선택 사항입니다. [**무엇을 써야 할지 모르겠나요?**](../explanation/analysis-phase.md)
|
||||
|
||||
- **브레인스토밍**(`bmad-brainstorming`) - 안내형 아이디어 발산
|
||||
- **리서치**(`bmad-market-research` / `bmad-domain-research` / `bmad-technical-research`) - 시장, 도메인, 기술 리서치
|
||||
- **제품 개요**(`bmad-product-brief`) - 개념이 명확할 때 권장되는 기초 문서
|
||||
- **PRFAQ**(`bmad-prfaq`) - 제품 개념을 압박하고 다듬는 워킹 백워드 챌린지
|
||||
|
||||
### 2단계: 계획(필수)
|
||||
|
||||
**BMad Method 및 엔터프라이즈 트랙:**
|
||||
|
||||
1. 새 채팅에서 `bmad-prd`를 실행합니다. 의도(생성, 업데이트, 검증)를 직접 말하거나 스킬이 묻게 둡니다
|
||||
2. 출력: `prd.md`, `addendum.md`, `decision-log.md`
|
||||
|
||||
:::note[`bmad-prd` 의도]
|
||||
- **생성** - 처음부터 코칭형 발견 과정을 진행합니다. 스킬이 워크스페이스 폴더 이름을 정하고 만족할 만한 PRD까지 안내합니다
|
||||
- **업데이트** - 기존 PRD와 변경 신호를 지정합니다. 변경을 적용하기 전에 충돌을 드러냅니다
|
||||
- **검증** - 완료된 PRD를 체크리스트로 비평하고 HTML 발견 사항 보고서를 생성합니다
|
||||
:::
|
||||
|
||||
**빠른 흐름 트랙:**
|
||||
|
||||
- `bmad-quick-dev`를 실행합니다. 계획과 구현을 하나의 워크플로에서 처리하므로 구현 단계로 바로 넘어갑니다
|
||||
|
||||
:::note[UX 설계(선택)]
|
||||
프로젝트에 사용자 인터페이스가 있다면 PRD를 만든 뒤 **UX 디자이너 에이전트**(`bmad-agent-ux-designer`)를 호출하고 UX 설계 워크플로(`bmad-create-ux-design`)를 실행하세요.
|
||||
:::
|
||||
|
||||
### 3단계: 솔루션 설계(BMad Method/엔터프라이즈)
|
||||
|
||||
**아키텍처 만들기**
|
||||
|
||||
1. 새 채팅에서 **아키텍트 에이전트**(`bmad-agent-architect`)를 호출합니다
|
||||
2. `bmad-create-architecture`(`bmad-create-architecture`)를 실행합니다
|
||||
3. 출력: 기술 결정이 담긴 아키텍처 문서
|
||||
|
||||
**에픽과 스토리 만들기**
|
||||
|
||||
:::tip[V6 개선]
|
||||
이제 에픽과 스토리는 아키텍처 *이후* 생성됩니다. 데이터베이스, API 패턴, 기술 스택 같은 아키텍처 결정이 작업 분해 방식에 직접 영향을 주므로 스토리 품질이 좋아집니다.
|
||||
:::
|
||||
|
||||
1. 새 채팅에서 **PM 에이전트**(`bmad-agent-pm`)를 호출합니다
|
||||
2. `bmad-create-epics-and-stories`(`bmad-create-epics-and-stories`)를 실행합니다
|
||||
3. 워크플로는 PRD와 아키텍처를 모두 사용해 기술적 맥락이 반영된 스토리를 만듭니다
|
||||
|
||||
**구현 준비도 점검** *(강력 권장)*
|
||||
|
||||
1. 새 채팅에서 **아키텍트 에이전트**(`bmad-agent-architect`)를 호출합니다
|
||||
2. `bmad-check-implementation-readiness`(`bmad-check-implementation-readiness`)를 실행합니다
|
||||
3. 모든 계획 문서 간 응집성을 검증합니다
|
||||
|
||||
## 2단계: 프로젝트 만들기
|
||||
|
||||
계획이 완료되면 구현으로 이동합니다. **각 워크플로는 새 채팅에서 실행해야 합니다.**
|
||||
|
||||
### 스프린트 계획 초기화
|
||||
|
||||
**개발자 에이전트**(`bmad-agent-dev`)를 호출하고 `bmad-sprint-planning`(`bmad-sprint-planning`)을 실행합니다. 모든 에픽과 스토리를 추적하는 `sprint-status.yaml`이 생성됩니다.
|
||||
|
||||
### 빌드 사이클
|
||||
|
||||
각 스토리마다 새 채팅으로 이 사이클을 반복합니다.
|
||||
|
||||
| 단계 | 에이전트 | 워크플로 | 명령 | 목적 |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| 1 | DEV | `bmad-create-story` | `bmad-create-story` | 에픽에서 스토리 파일 생성 |
|
||||
| 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | 스토리 구현 |
|
||||
| 3 | DEV | `bmad-code-review` | `bmad-code-review` | 품질 검증 *(권장)* |
|
||||
|
||||
에픽의 모든 스토리를 완료한 뒤 **개발자 에이전트**(`bmad-agent-dev`)를 호출하고 `bmad-retrospective`(`bmad-retrospective`)를 실행합니다.
|
||||
|
||||
## 달성한 것
|
||||
|
||||
BMad로 빌드하는 기초를 배웠습니다.
|
||||
|
||||
- BMad를 설치하고 IDE에 맞게 설정했습니다
|
||||
- 선택한 계획 트랙으로 프로젝트를 초기화했습니다
|
||||
- 계획 문서(PRD, 아키텍처, 에픽과 스토리)를 만들었습니다
|
||||
- 구현을 위한 빌드 사이클을 이해했습니다
|
||||
|
||||
이제 프로젝트에는 다음이 있습니다.
|
||||
|
||||
```text
|
||||
your-project/
|
||||
├── _bmad/ # BMad 설정
|
||||
├── _bmad-output/
|
||||
│ ├── planning-artifacts/
|
||||
│ │ ├── PRD.md # 요구사항 문서
|
||||
│ │ ├── architecture.md # 기술 결정
|
||||
│ │ └── epics/ # 에픽과 스토리 파일
|
||||
│ ├── implementation-artifacts/
|
||||
│ │ └── sprint-status.yaml # 스프린트 추적
|
||||
│ └── project-context.md # 구현 규칙(선택)
|
||||
└── ...
|
||||
```
|
||||
|
||||
## 빠른 참조
|
||||
|
||||
| 워크플로 | 명령 | 에이전트 | 목적 |
|
||||
| --- | --- | --- | --- |
|
||||
| **`bmad-help`** | `bmad-help` | 무관 | **무엇이든 물어볼 수 있는 지능형 안내자** |
|
||||
| `bmad-prd` | `bmad-prd` | 무관 | PRD 생성, 업데이트 또는 검증 |
|
||||
| `bmad-create-architecture` | `bmad-create-architecture` | 아키텍트 | 아키텍처 문서 생성 |
|
||||
| `bmad-generate-project-context` | `bmad-generate-project-context` | 분석가 | 프로젝트 컨텍스트 파일 생성 |
|
||||
| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | PM | PRD를 에픽으로 분해 |
|
||||
| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | 아키텍트 | 계획 응집성 검증 |
|
||||
| `bmad-sprint-planning` | `bmad-sprint-planning` | DEV | 스프린트 추적 초기화 |
|
||||
| `bmad-create-story` | `bmad-create-story` | DEV | 스토리 파일 생성 |
|
||||
| `bmad-dev-story` | `bmad-dev-story` | DEV | 스토리 구현 |
|
||||
| `bmad-code-review` | `bmad-code-review` | DEV | 구현된 코드 리뷰 |
|
||||
|
||||
## 자주 묻는 질문
|
||||
|
||||
**항상 아키텍처가 필요한가요?**
|
||||
오직 BMad Method와 엔터프라이즈 트랙에서만 필요합니다. 빠른 흐름은 사양에서 구현으로 바로 넘어갑니다.
|
||||
|
||||
**나중에 계획을 바꿀 수 있나요?**
|
||||
네. `bmad-correct-course` 워크플로가 구현 중 범위 변경을 처리합니다.
|
||||
|
||||
**먼저 브레인스토밍하고 싶다면요?**
|
||||
PRD를 시작하기 전에 분석가 에이전트(`bmad-agent-analyst`)를 호출하고 `bmad-brainstorming`(`bmad-brainstorming`)을 실행하세요.
|
||||
|
||||
**엄격한 순서를 따라야 하나요?**
|
||||
반드시 그렇지는 않습니다. 흐름에 익숙해지면 위의 빠른 참조를 사용해 워크플로를 직접 실행할 수 있습니다.
|
||||
|
||||
## 도움 받기
|
||||
|
||||
:::tip[첫 번째 목적지: BMad 도움말]
|
||||
**언제든 `bmad-help`를 호출하세요.** 막혔을 때 가장 빠른 방법입니다. 무엇이든 물어보세요.
|
||||
|
||||
- "설치 후 무엇을 해야 하나요?"
|
||||
- "워크플로 X에서 막혔어요"
|
||||
- "Y에 대한 선택지는 무엇인가요?"
|
||||
- "지금까지 완료된 것을 보여 주세요"
|
||||
|
||||
BMad 도움말은 프로젝트를 검사하고 완료한 작업을 감지한 뒤 다음에 무엇을 해야 할지 정확히 알려줍니다.
|
||||
:::
|
||||
|
||||
- **워크플로 중** - 에이전트가 질문과 설명으로 안내합니다
|
||||
- **커뮤니티** - [Discord](https://discord.gg/gk8jAdXWmj)(#bmad-method-help, #report-bugs-and-issues)
|
||||
|
||||
## 핵심 요약
|
||||
|
||||
:::tip[이것만 기억하세요]
|
||||
- **`bmad-help`로 시작하세요** - 프로젝트와 선택지를 아는 지능형 안내자입니다
|
||||
- **항상 새 채팅을 사용하세요** - 각 워크플로마다 새 채팅을 시작합니다
|
||||
- **트랙이 중요합니다** - 빠른 흐름은 `bmad-quick-dev`를 사용하고, BMad Method/엔터프라이즈는 PRD와 아키텍처가 필요합니다
|
||||
- **BMad 도움말은 자동으로 실행됩니다** - 모든 워크플로는 다음 단계 안내로 끝납니다
|
||||
:::
|
||||
|
||||
시작할 준비가 되었나요? BMad를 설치하고 `bmad-help`를 호출한 뒤 안내에 따라 첫 흐름을 시작하세요.
|
||||
|
|
@ -88,5 +88,5 @@ Tell the user the sequence in one sentence, then walk it. Polish goes last so it
|
|||
4. **Triage open items.** All Open Questions, `[ASSUMPTION]` tags, `[NOTE FOR PM]` callouts. Phase-blockers (would make the PRD unsafe for UX/architecture/epics) surfaced one at a time and resolved; non-blockers deferred with owner + revisit condition logged to `.decision-log.md`. If phase-blocker count is high, flag it.
|
||||
5. **Polish.** Apply `{workflow.doc_standards}` to `prd.md` and `addendum.md` in declared order (structural passes before prose — prose should not polish soon-to-be-cut text). Parallelize across documents, sequential within.
|
||||
6. **External handoffs.** Execute `{workflow.external_handoffs}`; surface returned URLs/IDs. Skip and flag unavailable tools.
|
||||
7. **Close.** Set `prd.md` frontmatter `status: final` and `updated` to `{date}` so future invocations distinguish this PRD from in-progress drafts. Record finalization to `.decision-log.md`. Share artifact paths. Common next: `bmad-ux`, `bmad-create-architecture`, `bmad-create-epics-and-stories`; invoke `bmad-help` for authoritative routing.
|
||||
7. **Close.** Set `prd.md` frontmatter `status: final` and `updated` to `{date}` so future invocations distinguish this PRD from in-progress drafts. Record finalization to `.decision-log.md`. Share artifact paths. Common next: `bmad-ux`, `bmad-architecture`, `bmad-create-epics-and-stories`; invoke `bmad-help` for authoritative routing.
|
||||
8. Run `{workflow.on_complete}` if non-empty.
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ UX may lead, follow, or stand alone. Inherit `sources:` by reference; the spines
|
|||
1. Resolve customization: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`. On failure, read `{skill-root}/customize.toml` directly and use defaults.
|
||||
2. Run `{workflow.activation_steps_prepend}`. Treat `{workflow.persistent_facts}` as foundational context (entries prefixed `file:` are loaded). `{workflow.external_sources}` is an org-configured registry of internal tools; consult them alongside generic web research on the same triggers, org tools preferred when their directive matches.
|
||||
3. Load `{project-root}/_bmad/bmm/config.yaml` (+ `config.user.yaml` if present). Resolve `{user_name}`, `{communication_language}`, `{document_output_language}`, `{planning_artifacts}`, `{project_name}`, `{date}`. Missing keys → neutral defaults; never block.
|
||||
4. If headless, follow `references/headless.md` for the whole run. Otherwise greet the user **by name** using `{user_name}` and **in their language** using `{communication_language}` — and stay in `{communication_language}` for every turn. In the greeting, let the user know `bmad-party-mode` and `bmad-advanced-elicitation` are always available. Then scan for misroute on the first message: PRD → `bmad-prd`; architecture → `bmad-create-architecture`; game UX → BMad GDS; agent/skill → `bmad-workflow-builder`; brief → `bmad-product-brief`.
|
||||
4. If headless, follow `references/headless.md` for the whole run. Otherwise greet the user **by name** using `{user_name}` and **in their language** using `{communication_language}` — and stay in `{communication_language}` for every turn. In the greeting, let the user know `bmad-party-mode` and `bmad-advanced-elicitation` are always available. Then scan for misroute on the first message: PRD → `bmad-prd`; architecture → `bmad-architecture`; game UX → BMad GDS; agent/skill → `bmad-workflow-builder`; brief → `bmad-product-brief`.
|
||||
5. Detect intent: **Create**, **Update**, **Validate**. For Create, before binding a fresh workspace, scan `{workflow.ux_output_path}` for prior in-progress runs (folders matching `{workflow.run_folder_pattern}` whose `DESIGN.md` frontmatter `status` is not `final`) and offer to resume rather than starting over.
|
||||
|
||||
Run `{workflow.activation_steps_append}`.
|
||||
|
|
@ -87,4 +87,4 @@ Outcomes, in order:
|
|||
- **Key-screen mocks rendered.** Key-screens tool → `.working/` for surfaces where layout drives behavior or anchors visual language.
|
||||
- **Mock coverage confirmed.** Walk every IA surface; classify *mocked* vs *spine-only*. Ask: *"These will be built from spine tables alone — any need a visual reference?"* Render more if named; log spine-only choices.
|
||||
- **Layout extracted, artifacts promoted.** Distill subagent re-reads each `.working/` and `imports/` artifact; lifts visual decisions into DESIGN.md and behavioral decisions into EXPERIENCE.md. Promote `.working/` keepers to `mockups/` (HTML) or `wireframes/` (Excalidraw); imports stay. Inline relative links at relevant spine sections; state spines-win-on-conflict once.
|
||||
- **Polished, handed off, closed.** Apply `{workflow.doc_standards}` in order. Execute `{workflow.external_handoffs}`; surface URLs. Set both files' `status: final`, `updated: {date}`. Log finalization. Share paths. Common next: `bmad-create-architecture`, `bmad-create-epics-and-stories`, `bmad-dev-story`. Run `{workflow.on_complete}`.
|
||||
- **Polished, handed off, closed.** Apply `{workflow.doc_standards}` in order. Execute `{workflow.external_handoffs}`; surface URLs. Set both files' `status: final`, `updated: {date}`. Log finalization. Share paths. Common next: `bmad-architecture`, `bmad-create-epics-and-stories`, `bmad-dev-story`. Run `{workflow.on_complete}`.
|
||||
|
|
|
|||
|
|
@ -56,8 +56,8 @@ principles = [
|
|||
|
||||
[[agent.menu]]
|
||||
code = "CA"
|
||||
description = "Guided workflow to document technical decisions to keep implementation on track"
|
||||
skill = "bmad-create-architecture"
|
||||
description = "Produce the architecture spine: the invariants that keep independently-built units consistent"
|
||||
skill = "bmad-architecture"
|
||||
|
||||
[[agent.menu]]
|
||||
code = "IR"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,86 @@
|
|||
---
|
||||
name: bmad-architecture
|
||||
description: 'Produce the architecture: a lean spine of invariants that keeps everything built from it consistent, projected into whatever format the work needs. Use when the user says "create the architecture", "create technical architecture", "architecture spine", or "create a solution design".'
|
||||
---
|
||||
# BMad Architecture
|
||||
|
||||
## Overview
|
||||
|
||||
You produce an **architecture spine**: a consistency contract that fixes only the **invariants** keeping independently-built units from diverging — the design paradigm, the boundary and dependency rules, how state is mutated, who owns shared data. Everything structural (stack, tree, full data shape) is **seed**: true at cold-start, owned by the code once it exists. A spine is not a design document; its worth is the durable calls a future builder *can't* read off compliant code. Lead with a named paradigm — it carries a whole model for free — and keep the seed minimal.
|
||||
|
||||
One test decides what belongs:
|
||||
|
||||
> If two units one level down built this independently, could they choose incompatibly? Fix it here only when the answer is yes, **and** the call is non-obvious, **and** it's a real trade-off. Otherwise name it under Deferred and move on.
|
||||
|
||||
Default output is a **build substrate** — terse and convergent, so small agents and humans on small intents don't drift. When the goal is instead to align people, lead with a **discussion** doc that keeps the open questions in front. Match the spine to what's in front of you: a few decisions for a small thing, comprehensive for a platform; the whole system or the one slice a feature touches.
|
||||
|
||||
Record decisions, not rationale (rationale lives in the memlog). Carry shape in diagrams, not prose. Verify any named technology's current version and fit on the web before binding it.
|
||||
|
||||
## How you work
|
||||
|
||||
You're a coach, and the **Coaching path is the default** — this runs against the model's instinct to just produce an architecture, so hold the line on it. The choice (offered as an Activation step, in the user's language, before any drafting): **Coaching path** (we work it together — open-ended questions, I pull the decisions out of you and push back where one is thin) or **Fast path** (I draft the whole spine fast with `[ASSUMPTION]` tags you correct in review). Unless the user clearly wants speed, **coach; don't silently draft.** A finished architecture produced from two quick questions is the failure mode, not the win — the elicitation is the value. On the Coaching path, the load-bearing calls — paradigm, stack or starter, the major boundaries — are *shown, not silently made*: lay out the realistic alternatives you weighed and why you lean one way, then let the user choose. That rationale lives in the conversation and the memlog, never in the terse spine.
|
||||
|
||||
Elicit, don't quiz: open-ended "how are you thinking about X?" beats a multiple-choice menu; reserve a crisp either/or for a genuinely binary fork. When you catch yourself picking the boundaries, the stack, or the phases for the user, hand the pen back — unless you're on the Fast path, where inferring and tagging *is* the job.
|
||||
|
||||
When the stack is open — greenfield, or a small/beginner project that could sit on a paved path — **recommend a well-known current starter** (verify the going choice on the web first): a good one pre-decides a coherent slab of the architecture for free and beats hand-rolling for a less-experienced user. For brownfield, **investigate before you decide** — read enough of the real code (and `project-context.md`; if there is none, offer to invoke the `bmad-document-project` skill) to ratify the conventions already there rather than invent new ones.
|
||||
|
||||
## Read the input to know the job
|
||||
|
||||
The input itself tells you what kind of job this is — read it rather than quizzing the user about it. A spec package (`SPEC.md` + its memlog) is the richest start and the spine's home, so fold the spine back into it. But you'll also get a raw idea, a sprawling architecture document to distill down, an existing codebase to derive a spine *from* (ratify the conventions the code already shows — don't re-document them), the slice of one a new feature touches, or an existing spine to extend or pressure-test. Prefer a `.memlog.md` over re-reading the source it came from. Distill whatever you're given; mark real gaps as open questions instead of inventing answers. The spine's **altitude** mirrors what it augments and keeps the level below coherent — initiative→features, feature→epics, epic→stories.
|
||||
|
||||
**Inheriting a parent spine** (e.g. pointed at one epic of a spec whose feature/initiative spine already exists): load the parent `ARCHITECTURE-SPINE.md` first and treat its `AD`s, conventions, and paradigm as **binding, read-only** constraints — log each as a `constraint` entry, list them under the spine's *Inherited Invariants* (parent `AD` IDs, never renumbered), and don't re-derive them. Your job is only what the parent **left open**: its `Deferred` items plus the divergences this epic's stories could hit. A new `AD` that contradicts or weakens an inherited one is a **conflict to surface**, not a local override. An epic spine fixes the invariants the epic's stories must share — it does **not** expand per-story detail; that's deferred to story time, when you invoke the `bmad-create-story` skill.
|
||||
|
||||
## How a run works
|
||||
|
||||
The **memlog** (`.memlog.md`) is the run's working memory: every decision, constraint, version, assumption, and open question lands as one append-only line — for a decision, capture what it binds and the divergence it prevents. It is the shared canonical memlog (the same `{project-root}/_bmad/scripts/memlog.py` bmad-spec writes through), so it carries no lifecycle status — terminal moments are logged as `event` entries, not a frontmatter flag. The spine is **distilled from the memlog at the end**, not written as you go. Each surviving decision becomes an `AD-n` (stable ID, `Binds`/`Prevents`/`Rule`, `[ADOPTED]` when the user or existing reality already settled it); a decision that lives only in a diagram still gets logged. Resume a prior run by reloading its memlog.
|
||||
|
||||
Writes go through the shared script (don't read the file back except on resume):
|
||||
|
||||
- `python3 {project-root}/_bmad/scripts/memlog.py init --workspace {doc_workspace} --field scope="…" --field purpose="…" --field altitude="…"`
|
||||
- `python3 {project-root}/_bmad/scripts/memlog.py append --workspace {doc_workspace} --type <decision|constraint|version|assumption|question|direction|event> --text "…"`
|
||||
- A terminal moment (spine finalized, a validation verdict) is an `append --type event` entry — there is no status field to set.
|
||||
|
||||
## Resolution rules
|
||||
|
||||
- Bare paths and `{skill-root}` (e.g. `references/headless.md`) resolve from this skill's installed directory.
|
||||
- `{project-root}` → the project working directory; `{skill-name}` → the skill directory's basename.
|
||||
- `{workflow.<name>}` → a merged `customize.toml` field; `{doc_workspace}` → the bound run folder.
|
||||
- Forward slashes only. Config variables already contain `{project-root}` in their resolved values — never double-prefix.
|
||||
|
||||
## On Activation
|
||||
|
||||
**Forwarded activation:** if a caller (e.g. the `bmad-create-architecture` shim) invoked you with a stated intent and pre-resolved customization fields, honor them verbatim — skip your own intent inference, use the supplied values for those named fields, and resolve only the remaining fields from your own `customize.toml`. So a legacy per-project override still reaches the run.
|
||||
|
||||
1. Resolve customization: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` (on failure read `{skill-root}/customize.toml`, use defaults). Run `{workflow.activation_steps_prepend}`, then `{workflow.activation_steps_append}`. Hold `{workflow.persistent_facts}` as standing context — the default loads `project-context.md`, load-bearing for brownfield — and consult `{workflow.external_sources}` on demand.
|
||||
2. Load `{project-root}/_bmad/bmm/config.yaml` (+ `config.user.yaml`) for `{user_name}`, `{communication_language}`, `{document_output_language}`, `{planning_artifacts}`, `{project_name}`, `{date}`; missing keys take neutral defaults, never block.
|
||||
3. Headless (no interactive user) → follow `references/headless.md` for the whole run. Otherwise greet `{user_name}` in `{communication_language}`. Detect the intent from the conversation and input — **create** (the default), **update** an existing spine, or **validate** one (see those sections). If the real ask is requirements / UX / a capability contract / epic breakdown / an agent, invoke the `bmad-prd`, `bmad-ux`, `bmad-spec`, `bmad-create-epics-and-stories`, or `bmad-workflow-builder` (if the BMad Builder module is installed) skill instead.
|
||||
4. If a run folder for this target already exists under `{workflow.spine_output_path}`, offer to resume from its memlog rather than restart.
|
||||
5. Interactive create: offer the working mode in `{communication_language}` — **Coaching path** (default) or **Fast path** (see *How you work*) — before any drafting; default to Coaching unless the user asks for speed.
|
||||
6. **Mandatory, both paths, before drafting:** ask whether the spine is the only deliverable — and if not, draw out the *purpose and audience* rather than a document type. "An architecture doc" balloons into bloat; what they actually need might be a one-detail explainer for a single team or a non-technical vision piece for a board. Purpose right-sizes the artifact and may call for extra elicitation up front, not just a finale add-on.
|
||||
|
||||
For a new spine, bind `{doc_workspace}` to `{workflow.spine_output_path}/{workflow.run_folder_pattern}/`, seed `ARCHITECTURE-SPINE.md` from `{workflow.spine_template}`, run `memlog.py init`, and tell the user the path. **At epic altitude, scope the folder to the epic** (set `run_folder_pattern` per `customize.toml`) so per-epic runs don't collide.
|
||||
|
||||
## Reviewer Gate
|
||||
|
||||
The spine's pre-handoff review — full mechanics in `references/reviewer-gate.md`. Load it when finalizing or validating: a deterministic `lint_spine.py` pass, then a rubric walker (good-spine checklist) + every `{workflow.finalize_reviewers}` lens dispatched as parallel subagents against `ARCHITECTURE-SPINE.md`, scaled to stakes. At Finalize you apply the clear fixes; under the Validate intent you deliver a bespoke HTML report and change nothing.
|
||||
|
||||
## Finalize
|
||||
|
||||
Walk the sequence; reviewer fixes land before polish.
|
||||
|
||||
1. **Distill.** Write the spine from the memlog (brownfield: + the code sweep) — invariants first, seed minimal, every `AD` carrying Binds/Prevents/Rule, `Deferred` naming what it won't decide. No placeholders; never invent to fill a gap. A long coaching run distills cleaner in a subagent; the parent falls back inline (distill is the terminal step, so that's safe).
|
||||
2. **Reconcile inputs.** A subagent per load-bearing input checks it against the spine and returns what didn't land — especially a quiet requirement (a tone, a constraint) the `AD` structure dropped. Before the gate.
|
||||
3. **Reviewer pass.** Run the Reviewer Gate (`references/reviewer-gate.md`). Resolve before polish.
|
||||
4. **Triage.** Open questions and `[ASSUMPTION]` tags: blockers (unsafe for what's next) resolved one at a time; the rest deferred with a revisit condition in the memlog.
|
||||
5. **Renderings & polish.** The spine is the build deliverable; with it and the memlog now in place, produce any *additional* human-facing artifact the user needs, scoped to the purpose and audience drawn out up front. The up-front question already flagged whether one's needed; if it wasn't, still offer one here, seeding concrete options: an interactive HTML+SVG deck to walk a team through the architecture and drive discussion, a fuller HTML/md solution design, a C4 set, or a view of how the work splits across teams/epics. Build only what they pick, right-sized to that purpose; apply `{workflow.doc_standards}` polish to that prose only, never to the spine.
|
||||
6. **External handoffs.** Run `{workflow.external_handoffs}`; surface returned URLs/IDs. Offer to invoke the `bmad-spec` skill to adopt the spine as a companion, keeping `AD` IDs stable so downstream can cite them.
|
||||
7. **Close.** Set the spine's own frontmatter `status: final`, `updated: {date}`; log a `memlog.py append --type event --text "spine finalized"` (the memlog has no status field). Share paths. Next, **lead with `bmad-spec`** — recommend adopting/refreshing the spine as a spec companion (always the top recommendation when a spec was an input, and a useful next step even when it wasn't), then `bmad-create-epics-and-stories` or — epic altitude — `bmad-create-story`; or invoke `bmad-help` to route.
|
||||
8. Run `{workflow.on_complete}`.
|
||||
|
||||
## Update
|
||||
|
||||
Amend an existing spine. Resume from its `.memlog.md` (the authority on what was decided), not the rendered spine. Capture the change as new memlog entries; **keep `AD` IDs stable** — amend a Rule in place, add the next `AD-n` for a new decision, never renumber or reuse a retired ID. Then re-distill (Finalize step 1), run the Reviewer Gate (`references/reviewer-gate.md`), and close as in Finalize. An update that overrides something from a source input: offer to update that source too, so upstream and the spine don't silently diverge.
|
||||
|
||||
## Validate
|
||||
|
||||
The standalone intent — critique an existing spine without changing it. Run the Reviewer Gate (`references/reviewer-gate.md`) against it and deliver the bespoke HTML report, then offer to roll the findings into an Update. (At Finalize the same gate runs as your own pre-handoff check, where you apply the fixes instead of reporting.)
|
||||
|
|
@ -0,0 +1,129 @@
|
|||
---
|
||||
name: '{name}'
|
||||
type: architecture-spine
|
||||
purpose: build-substrate # build-substrate (default) · discussion · report · deck
|
||||
altitude: feature # initiative (keeps features) · feature (keeps epics) · epic (keeps stories)
|
||||
paradigm: '{named design pattern, e.g. hexagonal, layered, pipes-and-filters, actor}'
|
||||
scope: '{what this spine governs}'
|
||||
status: draft # draft · final
|
||||
created: '{date}'
|
||||
updated: '{date}'
|
||||
stack: # SEED — verified current at authoring; the code owns this once it exists
|
||||
languages: []
|
||||
frameworks: []
|
||||
key_deps: [] # name@version
|
||||
binds: [] # capability / unit IDs governed (from the driving spec; at epic altitude, also the parent AD IDs inherited)
|
||||
sources: []
|
||||
companions: []
|
||||
---
|
||||
|
||||
# Architecture Spine — {name}
|
||||
|
||||
> A consistency contract, not a design document. It fixes the **invariants** that keep the
|
||||
> independently-built level below ({features | epics | stories}) coherent — the durable rules a
|
||||
> clean codebase can't reveal. Structure is **seed**: the code owns the detail, the spine keeps the shape.
|
||||
> Decisions, not rationale (that lives in the memlog). Diagrams over prose.
|
||||
>
|
||||
> **Scale to the job — drop any section a project doesn't need.** A small intent may be just a
|
||||
> paradigm + a few `AD`s + conventions, seed omitted; a platform earns the full set. An inherited
|
||||
> epic spine is usually mostly Inherited Invariants + a thin Deferred. Empty sections are cut, not left as headers.
|
||||
|
||||
## Design Paradigm
|
||||
|
||||
Name the pattern — a known one loads a whole model for free — and map its layers to namespaces /
|
||||
directories. The smallest, most durable thing in the file.
|
||||
|
||||
## Inherited Invariants
|
||||
|
||||
Present only when this spine inherits a parent at a higher altitude (e.g. an epic spine under a
|
||||
feature/initiative spine). The parent's `AD`s, conventions, and paradigm that bind here, listed by
|
||||
their original parent IDs — **read-only, never renumbered, not re-derived**. This spine adds only
|
||||
what the parent left open; anything here that a local decision would contradict is a conflict to
|
||||
surface, not override.
|
||||
|
||||
| Inherited | From parent | Binds here |
|
||||
| --- | --- | --- |
|
||||
| {AD-n / convention} | {parent spine} | {what it constrains in this scope} |
|
||||
|
||||
## Invariants & Rules
|
||||
|
||||
The durable heart: the calls a future builder can't read from compliant code. Each `AD-n` has a
|
||||
stable ID (never reused), a binding scope, the divergence it prevents, and an enforceable rule.
|
||||
Cover the boundary/dependency rules (who may depend on whom) and how state is mutated — a
|
||||
dependency-direction diagram says these better than prose. An `AD-n` the user asserted as
|
||||
already-settled (or one verified from existing reality) carries an `[ADOPTED]` tag after its
|
||||
title, so its provenance is legible versus decisions made here.
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
%% arrows = allowed dependency direction (a rule, not just structure)
|
||||
```
|
||||
|
||||
### AD-1 — {decision}
|
||||
|
||||
- **Binds:** {capability / unit IDs, areas, or `all`}
|
||||
- **Prevents:** {the divergence this stops}
|
||||
- **Rule:** {the constraint downstream must follow}
|
||||
|
||||
## Consistency Conventions
|
||||
|
||||
The defaults that bind everything where independent builders would otherwise drift. Cut rows that
|
||||
don't apply.
|
||||
|
||||
| Concern | Convention |
|
||||
| --- | --- |
|
||||
| Naming (entities, files, interfaces, events) | |
|
||||
| Data & formats (IDs, dates, error shapes, envelopes) | |
|
||||
| State & cross-cutting (mutation, errors, logging, config, auth) | |
|
||||
|
||||
## Structural Seed
|
||||
|
||||
Cold-start scaffolding, kept minimal — include an item only where its shape is non-obvious at this
|
||||
altitude (at epic altitude the parent usually already fixed it, so the seed is often empty). The code
|
||||
owns the **detail** (every file, every column); once code exists it becomes the source of truth for
|
||||
detail, and this seed is a starting scaffold, not a mirror to maintain against it. Evolve a seed item
|
||||
only when the **shape** itself changes — a new container, a new core entity, a stack bump — and let
|
||||
the memlog keep the history.
|
||||
|
||||
- **Stack & Versions** — the substrate (mirrors frontmatter `stack`).
|
||||
- **System Shape** — a container/context view (at epic altitude, the slice of the parent system this scope touches). Use `flowchart` with a `subgraph` per boundary; C4 mermaid is experimental and won't render in most viewers.
|
||||
- **Core Entities** — an ERD of entities and their relationships. Names and relationships only; attributes belong to the code unless one is itself an invariant (then it's an `AD`, not seed).
|
||||
- **Project Structure** — a minimal source tree, only as deep as consistency needs.
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
user(["{actor}"])
|
||||
subgraph sys["{system boundary}"]
|
||||
a["{container}<br/>{tech} — {role}"]
|
||||
end
|
||||
db[("{datastore}")]
|
||||
ext["{external system}"]
|
||||
user --> a
|
||||
a --> db
|
||||
a -->|{via port}| ext
|
||||
```
|
||||
|
||||
```mermaid
|
||||
erDiagram
|
||||
ENTITY_A ||--o{ ENTITY_B : "{relationship}"
|
||||
ENTITY_B ||--o| ENTITY_C : "{relationship}"
|
||||
```
|
||||
|
||||
```text
|
||||
{root}/
|
||||
{dir}/ # {what lives here}
|
||||
```
|
||||
|
||||
## Capability → Architecture Map
|
||||
|
||||
Bridges the spec's capabilities to the architecture (and is the consistency auditor's checklist).
|
||||
Present when a spec drove this run.
|
||||
|
||||
| Capability / Area | Lives in | Governed by |
|
||||
| --- | --- | --- |
|
||||
| {CAP-n / area} | {component / module} | {AD-n, convention, paradigm} |
|
||||
|
||||
## Deferred
|
||||
|
||||
Decisions intentionally pushed down, each with the reason it can wait. The half of the contract
|
||||
that keeps the spine lean.
|
||||
|
|
@ -0,0 +1,100 @@
|
|||
# DO NOT EDIT -- overwritten on every update.
|
||||
#
|
||||
# Workflow customization surface for bmad-architecture.
|
||||
#
|
||||
# Override files (not edited here):
|
||||
# {project-root}/_bmad/custom/bmad-architecture.toml (team)
|
||||
# {project-root}/_bmad/custom/bmad-architecture.user.toml (personal)
|
||||
|
||||
[workflow]
|
||||
|
||||
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||
# scalars: override wins • arrays: append
|
||||
|
||||
# Steps to run before the standard activation (config load, greet).
|
||||
# Use for pre-flight loads, approved-stack policy checks, etc.
|
||||
activation_steps_prepend = []
|
||||
|
||||
# Steps to run after greet but before the workflow begins.
|
||||
# Use for context-heavy setup that should happen once the user has been acknowledged.
|
||||
activation_steps_append = []
|
||||
|
||||
# Persistent facts the workflow keeps in mind for the whole run
|
||||
# (approved stacks, banned dependencies, platform constraints, compliance guardrails).
|
||||
# Each entry is either a literal sentence, a skill prefixed with `skill:`, or a `file:`-prefixed
|
||||
# path/glob whose contents are loaded as facts.
|
||||
#
|
||||
# Default loads project-context.md if bmad-generate-project-context produced one — giving the
|
||||
# architect persistent awareness of the project's tech, domain, and conventions (load-bearing
|
||||
# for brownfield). Common opt-ins (set in team/user override TOML):
|
||||
# "Our org is AWS-only -- do not propose GCP or Azure."
|
||||
# "file:{project-root}/docs/engineering-standards.md"
|
||||
persistent_facts = [
|
||||
"file:{project-root}/**/project-context.md",
|
||||
]
|
||||
|
||||
# Executed when the workflow completes (after the spine is final and the user has been told).
|
||||
# String scalar (single instruction) or array of instructions executed in order. Empty for none.
|
||||
on_complete = ""
|
||||
|
||||
# The architecture spine template. Treated as expert prior knowledge, not a checklist — the LLM
|
||||
# adapts it to the project, altitude, and domain, and drops sections a project genuinely doesn't
|
||||
# need. Override the path in team/user TOML to enforce a different spine shape.
|
||||
spine_template = "assets/spine-template.md"
|
||||
|
||||
# Run folder location. ARCHITECTURE-SPINE.md, its .memlog.md, and any fuller rendering the run
|
||||
# produces all land inside `{spine_output_path}/{run_folder_pattern}/`. Resume-check scans
|
||||
# `{spine_output_path}` for prior unfinished runs.
|
||||
#
|
||||
# The default pattern fits the common case (one spine per project, at the altitude above epics).
|
||||
# At EPIC altitude, override run_folder_pattern to carry the epic identity so per-epic runs don't
|
||||
# collide on the same day — e.g. set it (team/user TOML) to "architecture-epic-{epic_id}", binding
|
||||
# {epic_id} from the driving spec / the activating payload. Headless callers may instead pass an
|
||||
# explicit doc_workspace and bypass the pattern entirely.
|
||||
spine_output_path = "{planning_artifacts}/architecture"
|
||||
run_folder_pattern = "architecture-{project_name}-{date}"
|
||||
|
||||
# Prose-editorial standards applied at finalize ONLY to a fuller prose document the run produces
|
||||
# (a discussion report, full architecture doc, or design addendum) — never to the spine or other
|
||||
# short, structured outputs, which are terse and carry decisions in AD-n blocks and diagrams by
|
||||
# design. Each entry is a `skill:`, `file:`, or plain-text directive applied before the user sees
|
||||
# the polished draft. Suggested order: structural passes first, prose mechanics last. Append-only.
|
||||
doc_standards = [
|
||||
"skill:bmad-editorial-review-structure",
|
||||
"skill:bmad-editorial-review-prose",
|
||||
]
|
||||
|
||||
# External-source registry. Natural-language directives describing knowledge bases, MCP tools, or
|
||||
# internal systems the LLM may consult ON DEMAND during the run (not preemptively) — approved-stack
|
||||
# catalogs, internal platform docs, version registries. Each entry names the tool, the trigger
|
||||
# condition, and any fields it needs. If a named tool is unavailable at runtime, the LLM falls back
|
||||
# to standard behavior (e.g. web research) and notes the gap. Empty by default.
|
||||
#
|
||||
# Examples (set in team/user override TOML):
|
||||
# "When choosing a datastore, consult corp:platform_catalog before recommending one."
|
||||
# "For current library versions, query corp:artifact_registry before web search."
|
||||
external_sources = []
|
||||
|
||||
# External-handoff routing applied at Finalize to push outputs beyond local files (Confluence,
|
||||
# Notion, ticket systems). Each entry names the MCP tool, the destination, and required fields.
|
||||
# Runs after polish; returned URLs/IDs are surfaced. Unavailable tools are skipped and flagged;
|
||||
# local files always exist. Empty by default.
|
||||
external_handoffs = []
|
||||
|
||||
# --- Finalize reviewers ---
|
||||
# Extra review lenses spawned as parallel subagents at the validation gate (Finalize and the
|
||||
# Validate intent), on top of the skill's built-in good-spine checklist and the lint_spine.py
|
||||
# mechanical floor. The GATE is stakes-gated — a throwaway spine may run it quietly or skip it —
|
||||
# but whenever the gate runs, every entry here runs with it (the configured floor, never cherry-
|
||||
# picked); only ad-hoc lenses are optional, and headless never skips the gate.
|
||||
#
|
||||
# Entries follow the standard prefix convention:
|
||||
# "skill:NAME" invoke the named review skill as a subagent against ARCHITECTURE-SPINE.md
|
||||
# "file:PATH" load the file as a review prompt; spawn an adversarial subagent applying it
|
||||
# plain text use the text directly as the subagent's review prompt
|
||||
#
|
||||
# Resolved on-demand (not at activation). Override TOML may append.
|
||||
finalize_reviewers = [
|
||||
"Verify every committed decision was web-researched or reality-checked rather than asserted from training data: current library/framework versions, that each named technology still exists and fits, and — greenfield — the live defaults of any starter it leans on. Flag anything that could be out of date and wasn't confirmed against the web, the existing project, or the current starter.",
|
||||
"Attack the spine as an adversary: construct two units one level down that each obey every AD to the letter yet still build incompatibly — clashing shared-data shapes, two owners of one entity, conflicting state-mutation paths. Every pair you find is a hole to close with a new or tightened AD.",
|
||||
]
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# Headless
|
||||
|
||||
No interactive user: infer everything, ask nothing, but never invent — record inferences as `assumptions[]` and gaps that need a human as `open_questions[]`. Detect headless from a `headless: true` flag, a non-interactive / no-TTY invocation, an activation hook that declares it, or a first message that pre-supplies all inputs and asks for an artifact path back; when ambiguous, default to interactive.
|
||||
|
||||
Drive the run from the payload in the first message — `intent`, `altitude`, `purpose`, the driving input (spec package / PRD / raw intent / brownfield path), a parent spine path at lower altitude, and `doc_workspace` if a specific folder is required. Infer anything absent from the inputs or workspace; don't invent stack, constraints, or scope to fill a gap. You still verify named tech on the web (you can't ask, but you can check) and still drive every write through the shared `{project-root}/_bmad/scripts/memlog.py`. Run the full Reviewer Gate (`references/reviewer-gate.md`) non-interactively: `scripts/lint_spine.py` plus **every `{workflow.finalize_reviewers}` lens as a parallel subagent** (and any ad-hoc lens the spine's criticality warrants). Headless skips only the human picking from the menu — never the reviewers themselves; apply the clear fixes and record anything unresolved in `open_questions[]`. For a true authority collision, list it in `conflicts_with_prior_decisions[]`. For the Validate intent, always write the report to `{doc_workspace}` and add `"offer_to_update": true`. If intent stays ambiguous after inference, halt blocked.
|
||||
|
||||
End with JSON only, omitting keys for artifacts not produced — the shape below is the fully-produced (`complete`) case; a `blocked` run produces no spine, so it omits `spine`, `memlog`, and `companions` entirely (see the note under the block):
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "complete | partial | blocked",
|
||||
"intent": "create | update | validate",
|
||||
"altitude": "initiative | feature | epic",
|
||||
"purpose": "build-substrate | discussion",
|
||||
"doc_workspace": "<resolved run folder>",
|
||||
"spine": "{doc_workspace}/ARCHITECTURE-SPINE.md",
|
||||
"memlog": "{doc_workspace}/.memlog.md",
|
||||
"companions": [],
|
||||
"assumptions": [],
|
||||
"open_questions": [],
|
||||
"conflicts_with_prior_decisions": [],
|
||||
"reason": "<one line, only when blocked>"
|
||||
}
|
||||
```
|
||||
|
||||
`complete` stands alone · `partial` (spine produced, but `open_questions[]` non-empty or critical inputs inferred) means review before downstream use · `blocked` means no spine produced — return only `status`, `intent`, `reason`, and `doc_workspace` (if bound), omitting `spine`, `memlog`, `companions`, and the artifact arrays that don't exist.
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Reviewer Gate
|
||||
|
||||
The spine's pre-handoff review. Runs at Finalize (after distill + reconcile) and *is* the Validate intent. The difference is the ending: at Finalize you apply the clear fixes yourself; under Validate you report and don't change the spine.
|
||||
|
||||
Cheap deterministic pass first: `python3 {skill-root}/scripts/lint_spine.py --workspace {doc_workspace}` settles the mechanical misses (placeholders, duplicate `AD` IDs, missing Binds/Prevents/Rule, unpinned deps), so reviewers spend judgment on the semantic half.
|
||||
|
||||
Assemble the menu: a **rubric walker** that judges the spine against the good-spine checklist below, **+ every entry in `{workflow.finalize_reviewers}`**, + ad-hoc lenses you invent or offer as the spine's rigor, altitude, and criticality warrant — a security/compliance lens for regulated stakes, a seam reviewer cross-team, a data-integrity lens for a heavy data model. Scale *whether and how heavily the gate runs* to the stakes: a throwaway prototype may run it quietly or skip the gate entirely; a high-criticality or platform-altitude spine earns more lenses and the explicit all / subset / skip menu. But once the gate runs, the `{workflow.finalize_reviewers}` always run — they are the configured floor, never cherry-picked out; only the ad-hoc lenses are optional. (Headless never skips the gate.)
|
||||
|
||||
Dispatch every entry as a **parallel subagent against `ARCHITECTURE-SPINE.md`** (prefix convention: `skill:` / `file:` / plain text). Each writes its full review to `{doc_workspace}/review-{slug}.md` and returns ONLY a compact summary (verdict, top 2–5 findings, file path) — the parent never holds full review text. An inline self-check does not count: the independent context is the point, because a fresh reviewer finds the divergences the author talks past. If subagents are unavailable, run sequentially — write the file first, then flush it from context.
|
||||
|
||||
**Good-spine checklist** (what the rubric walker judges): it fixes the real divergence points for the level below and misses none; every `AD`'s Rule is enforceable and actually prevents its stated divergence; nothing under Deferred could let two units diverge; named tech is verified-current; it ratifies rather than contradicts a brownfield codebase; if a spec drove it, it covers that spec's capabilities; and if a parent spine is inherited, no new `AD` weakens or contradicts an inherited one.
|
||||
|
||||
Surface findings tiered, never dumped: a one-sentence gate verdict, then critical + high; medium/low roll into a tail ("plus N more in {file}"). Per finding: autofix, discuss, defer to Deferred / open items, or ignore. **At Finalize this is your own gate — apply the clear fixes rather than handing over a list; surface only what genuinely needs the user.** Under the **Validate intent**, fold every reviewer's output into one bespoke HTML + markdown report and open the HTML.
|
||||
|
|
@ -0,0 +1,260 @@
|
|||
#!/usr/bin/env python3
|
||||
# /// script
|
||||
# requires-python = ">=3.10"
|
||||
# ///
|
||||
"""lint-spine — the mechanical half of spine decision-integrity, done deterministically.
|
||||
|
||||
LLMs miscount IDs and miss literal placeholders; a grep does not. This linter owns the
|
||||
checks a script does better than a prompt, and leaves the semantic half (is each Rule
|
||||
actually enforceable? does the boundary make sense?) to the rubric walker.
|
||||
|
||||
It reads ARCHITECTURE-SPINE.md from a workspace and reports, as compact JSON on stdout:
|
||||
|
||||
- placeholder literal TBD / TODO / "similar to AD-n" / unfilled {template-token}
|
||||
- ad_id duplicate or non-monotonic AD-n identifiers
|
||||
- ad_fields an AD-n block missing Binds / Prevents / Rule
|
||||
- version_pin a frontmatter key_deps entry with no @version
|
||||
|
||||
Fenced code blocks are blanked (replaced with equal-count blank lines) before scanning, so
|
||||
mermaid and source trees don't trip false positives AND reported line numbers still line up
|
||||
with the real file. Reported lines are absolute file lines (frontmatter offset added). Exit
|
||||
code is always 0 — findings travel in the JSON; the caller (Reviewer Gate / rubric walker)
|
||||
decides what to do with them.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import re
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
SPINE = "ARCHITECTURE-SPINE.md"
|
||||
|
||||
AD_HEADING = re.compile(r"^#{2,4}\s*AD-(\d+)\b(.*)$", re.MULTILINE)
|
||||
HEADING = re.compile(r"^#{1,6}\s", re.MULTILINE)
|
||||
FENCE = re.compile(r"```.*?```", re.DOTALL)
|
||||
PLACEHOLDER_WORD = re.compile(r"\b(TBD|TODO|FIXME|XXX)\b")
|
||||
SIMILAR_TO = re.compile(r"similar to AD-\d+", re.IGNORECASE)
|
||||
TEMPLATE_TOKEN = re.compile(r"\{[a-z_][a-z0-9_ /.-]*\}")
|
||||
|
||||
|
||||
def split_frontmatter(text: str) -> tuple[str, str, int]:
|
||||
"""Return (frontmatter, body, body_line_offset).
|
||||
|
||||
Frontmatter is the content between the first two lines that are *exactly* `---`
|
||||
(line-exact, like memlog.split — a `---` inside a value or a body thematic break never
|
||||
truncates it). body_line_offset is the number of file lines before the body begins, so a
|
||||
body-relative line number plus the offset gives the absolute file line. Absent frontmatter
|
||||
→ ('', text, 0)."""
|
||||
lines = text.split("\n")
|
||||
if lines and lines[0] == "---":
|
||||
for i in range(1, len(lines)):
|
||||
if lines[i] == "---":
|
||||
fm = "\n".join(lines[1:i])
|
||||
body = "\n".join(lines[i + 1:])
|
||||
return fm, body, i + 1
|
||||
return "", text, 0
|
||||
|
||||
|
||||
def blank_fences(text: str) -> str:
|
||||
"""Replace each fenced block with the same number of newlines, so scanning skips fenced
|
||||
content while every line number outside the fence stays put."""
|
||||
return FENCE.sub(lambda m: "\n" * m.group(0).count("\n"), text)
|
||||
|
||||
|
||||
def line_of(text: str, idx: int) -> int:
|
||||
return text.count("\n", 0, idx) + 1
|
||||
|
||||
|
||||
def find_placeholders(body: str, offset: int) -> list[dict]:
|
||||
findings: list[dict] = []
|
||||
scan = blank_fences(body)
|
||||
# (regex, label, severity) — TBD/TODO and dangling cross-refs are unambiguous; a bare
|
||||
# {template-token} can be legitimate brace prose, so it is flagged low ("possible") to keep
|
||||
# the mechanical pass near-zero false-positive rather than train reviewers to ignore it.
|
||||
for rx, label, severity in (
|
||||
(PLACEHOLDER_WORD, "placeholder marker", "high"),
|
||||
(SIMILAR_TO, "unresolved cross-reference", "high"),
|
||||
(TEMPLATE_TOKEN, "possible unfilled template token (verify)", "low"),
|
||||
):
|
||||
for m in rx.finditer(scan):
|
||||
findings.append({
|
||||
"category": "placeholder",
|
||||
"severity": severity,
|
||||
"detail": f"{label}: {m.group(0)!r}",
|
||||
"location": f"{SPINE} (line {offset + line_of(scan, m.start())})",
|
||||
})
|
||||
return findings
|
||||
|
||||
|
||||
def find_frontmatter_placeholders(frontmatter: str) -> list[dict]:
|
||||
"""Catch unfilled tokens left in frontmatter (e.g. paradigm/scope/date) — part of the
|
||||
spine contract, but outside the body that find_placeholders scans."""
|
||||
findings: list[dict] = []
|
||||
for rx, label, severity in (
|
||||
(PLACEHOLDER_WORD, "placeholder marker", "high"),
|
||||
(TEMPLATE_TOKEN, "possible unfilled template token (verify)", "low"),
|
||||
):
|
||||
for m in rx.finditer(frontmatter):
|
||||
findings.append({
|
||||
"category": "placeholder",
|
||||
"severity": severity,
|
||||
"detail": f"frontmatter {label}: {m.group(0)!r}",
|
||||
"location": f"{SPINE} frontmatter (line {1 + line_of(frontmatter, m.start())})",
|
||||
})
|
||||
return findings
|
||||
|
||||
|
||||
def find_ad_issues(body: str, offset: int) -> list[dict]:
|
||||
findings: list[dict] = []
|
||||
scan = blank_fences(body) # AD headings shown inside a code fence are not live ADs
|
||||
matches = list(AD_HEADING.finditer(scan))
|
||||
seen: dict[int, int] = {}
|
||||
prev: int | None = None
|
||||
for m in matches:
|
||||
num = int(m.group(1))
|
||||
file_line = offset + line_of(scan, m.start())
|
||||
loc = f"{SPINE} AD-{num} (line {file_line})"
|
||||
if num in seen:
|
||||
findings.append({
|
||||
"category": "ad_id",
|
||||
"severity": "high",
|
||||
"detail": f"AD-{num} id reused (also at line {seen[num]})",
|
||||
"location": loc,
|
||||
})
|
||||
else:
|
||||
seen[num] = file_line
|
||||
if prev is not None and num <= prev:
|
||||
findings.append({
|
||||
"category": "ad_id",
|
||||
"severity": "high",
|
||||
"detail": f"AD-{num} is non-monotonic (follows AD-{prev}); ids must ascend and never renumber",
|
||||
"location": loc,
|
||||
})
|
||||
prev = num if prev is None else max(prev, num)
|
||||
|
||||
# block text = from this heading to the next heading of any level
|
||||
start = m.end()
|
||||
nxt = HEADING.search(scan, start)
|
||||
block = scan[start:nxt.start()] if nxt else scan[start:]
|
||||
low = block.lower()
|
||||
missing = [f for f in ("binds", "prevents", "rule") if f not in low]
|
||||
if missing:
|
||||
findings.append({
|
||||
"category": "ad_fields",
|
||||
"severity": "high",
|
||||
"detail": f"AD-{num} missing required field(s): {', '.join(missing)}",
|
||||
"location": loc,
|
||||
})
|
||||
return findings
|
||||
|
||||
|
||||
def find_unpinned_deps(frontmatter: str) -> list[dict]:
|
||||
findings: list[dict] = []
|
||||
lines = frontmatter.splitlines()
|
||||
in_key_deps = False
|
||||
key_indent = 0
|
||||
for raw in lines:
|
||||
stripped = raw.strip()
|
||||
if not stripped or stripped.startswith("#"):
|
||||
continue
|
||||
indent = len(raw) - len(raw.lstrip())
|
||||
m = re.match(r"key_deps:\s*(.*)$", stripped)
|
||||
if m:
|
||||
in_key_deps = True
|
||||
key_indent = indent
|
||||
inline = _strip_comment(m.group(1)).strip()
|
||||
if inline and inline not in ("[]", "[ ]"):
|
||||
# inline list form: key_deps: [a@1, b] — consumed here, no block follows
|
||||
for item in re.findall(r"[^\[\],]+", inline.strip("[]")):
|
||||
_check_dep(item.strip().strip("'\""), findings)
|
||||
in_key_deps = False
|
||||
continue
|
||||
if in_key_deps:
|
||||
if indent <= key_indent and not stripped.startswith("-"):
|
||||
in_key_deps = False
|
||||
continue
|
||||
if stripped.startswith("-"):
|
||||
# block-sequence form: `- name@version`
|
||||
_check_dep(_strip_comment(stripped[1:]).strip().strip("'\""), findings)
|
||||
else:
|
||||
# map form: `name: version` — pinned iff a non-empty value is present
|
||||
mm = re.match(r"([^:]+):\s*(.*)$", stripped)
|
||||
if mm:
|
||||
name = mm.group(1).strip().strip("'\"")
|
||||
val = _strip_comment(mm.group(2)).strip().strip("'\"")
|
||||
if name and not val:
|
||||
findings.append({
|
||||
"category": "version_pin",
|
||||
"severity": "medium",
|
||||
"detail": f"key_deps entry {name!r} has no version pin",
|
||||
"location": f"{SPINE} frontmatter stack.key_deps",
|
||||
})
|
||||
return findings
|
||||
|
||||
|
||||
def _strip_comment(s: str) -> str:
|
||||
"""Drop a trailing YAML ` # comment`, leaving an inline `name@1.2` intact."""
|
||||
return re.sub(r"(^|\s)#.*$", "", s)
|
||||
|
||||
|
||||
def _check_dep(item: str, findings: list[dict]) -> None:
|
||||
if not item or item.startswith("#"):
|
||||
return
|
||||
if "@" not in item:
|
||||
findings.append({
|
||||
"category": "version_pin",
|
||||
"severity": "medium",
|
||||
"detail": f"key_deps entry {item!r} has no @version pin",
|
||||
"location": f"{SPINE} frontmatter stack.key_deps",
|
||||
})
|
||||
|
||||
|
||||
def lint(text: str) -> dict:
|
||||
frontmatter, body, offset = split_frontmatter(text)
|
||||
findings: list[dict] = []
|
||||
findings += find_frontmatter_placeholders(frontmatter)
|
||||
findings += find_placeholders(body, offset)
|
||||
findings += find_ad_issues(body, offset)
|
||||
findings += find_unpinned_deps(frontmatter)
|
||||
counts: dict[str, int] = {}
|
||||
for f in findings:
|
||||
counts[f["severity"]] = counts.get(f["severity"], 0) + 1
|
||||
return {
|
||||
"ok": len(findings) == 0,
|
||||
"spine": SPINE,
|
||||
"total_findings": len(findings),
|
||||
"by_severity": counts,
|
||||
"findings": findings,
|
||||
}
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> int:
|
||||
ap = argparse.ArgumentParser(description="Lint an architecture spine for mechanical integrity.")
|
||||
ap.add_argument("--workspace", required=True, help="run folder containing ARCHITECTURE-SPINE.md")
|
||||
ap.add_argument("-o", "--output", help="write JSON here instead of stdout")
|
||||
args = ap.parse_args(argv)
|
||||
|
||||
spine_path = Path(args.workspace) / SPINE
|
||||
if not spine_path.exists():
|
||||
result = {"ok": False, "error": f"{spine_path} not found", "findings": [], "total_findings": 0}
|
||||
else:
|
||||
try:
|
||||
text = spine_path.read_text(encoding="utf-8")
|
||||
except (OSError, UnicodeDecodeError) as e:
|
||||
# honor the "exit code is always 0" contract: a read/decode failure travels in JSON
|
||||
result = {"ok": False, "error": f"could not read {spine_path}: {e}", "findings": [], "total_findings": 0}
|
||||
else:
|
||||
result = lint(text)
|
||||
|
||||
out = json.dumps(result, indent=2)
|
||||
if args.output:
|
||||
Path(args.output).write_text(out + "\n", encoding="utf-8")
|
||||
else:
|
||||
print(out)
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
|
|
@ -0,0 +1,228 @@
|
|||
# /// script
|
||||
# requires-python = ">=3.10"
|
||||
# dependencies = ["pytest>=8.0"]
|
||||
# ///
|
||||
"""Tests for lint_spine.py. Run: uv run --with pytest pytest scripts/tests/test_lint_spine.py
|
||||
|
||||
The spine under test: a clean spine lints empty; the linter catches exactly the
|
||||
mechanical defects a prompt is unreliable at — literal placeholders, AD-n id breakage,
|
||||
AD-n blocks missing required fields, and unpinned dependency versions.
|
||||
"""
|
||||
import importlib.util
|
||||
import json
|
||||
import re
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
_SPEC = importlib.util.spec_from_file_location(
|
||||
"lint_spine", Path(__file__).resolve().parent.parent / "lint_spine.py"
|
||||
)
|
||||
lint_spine = importlib.util.module_from_spec(_SPEC)
|
||||
sys.modules["lint_spine"] = lint_spine
|
||||
_SPEC.loader.exec_module(lint_spine)
|
||||
|
||||
|
||||
CLEAN = """---
|
||||
name: 'Demo'
|
||||
stack:
|
||||
key_deps:
|
||||
- fastapi@0.115
|
||||
- pydantic@2.9
|
||||
---
|
||||
|
||||
## Invariants & Rules
|
||||
|
||||
### AD-1 — single write path
|
||||
|
||||
- **Binds:** all
|
||||
- **Prevents:** divergent mutation
|
||||
- **Rule:** state changes only through the command bus
|
||||
|
||||
### AD-2 — layered deps `[ADOPTED]`
|
||||
|
||||
- **Binds:** all
|
||||
- **Prevents:** import cycles
|
||||
- **Rule:** ui -> app -> domain, never backward
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A --> B{decision}
|
||||
```
|
||||
"""
|
||||
|
||||
|
||||
def cats(result):
|
||||
return sorted(f["category"] for f in result["findings"])
|
||||
|
||||
|
||||
def test_clean_spine_passes():
|
||||
result = lint_spine.lint(CLEAN)
|
||||
assert result["ok"] is True
|
||||
assert result["total_findings"] == 0
|
||||
|
||||
|
||||
def test_mermaid_braces_not_flagged():
|
||||
# the {decision} node lives in a fenced block and must not read as a template token
|
||||
result = lint_spine.lint(CLEAN)
|
||||
assert "placeholder" not in cats(result)
|
||||
|
||||
|
||||
def test_placeholder_markers_caught():
|
||||
text = CLEAN.replace("the command bus", "TBD")
|
||||
result = lint_spine.lint(text)
|
||||
assert "placeholder" in cats(result)
|
||||
|
||||
|
||||
def test_similar_to_caught():
|
||||
text = CLEAN.replace("import cycles", "similar to AD-1")
|
||||
result = lint_spine.lint(text)
|
||||
assert any("cross-reference" in f["detail"] for f in result["findings"])
|
||||
|
||||
|
||||
def test_unfilled_template_token_caught():
|
||||
text = CLEAN.replace("single write path", "{decision}")
|
||||
result = lint_spine.lint(text)
|
||||
assert any(f["category"] == "placeholder" for f in result["findings"])
|
||||
|
||||
|
||||
def test_duplicate_ad_id_caught():
|
||||
text = CLEAN.replace("### AD-2 — layered deps `[ADOPTED]`", "### AD-1 — layered deps")
|
||||
result = lint_spine.lint(text)
|
||||
assert "ad_id" in cats(result)
|
||||
|
||||
|
||||
def test_non_monotonic_ad_id_caught():
|
||||
text = CLEAN.replace("### AD-2 — layered deps `[ADOPTED]`", "### AD-5 — layered deps").replace(
|
||||
"### AD-1 — single write path", "### AD-9 — single write path"
|
||||
)
|
||||
result = lint_spine.lint(text)
|
||||
assert any("non-monotonic" in f["detail"] for f in result["findings"])
|
||||
|
||||
|
||||
def test_missing_field_caught():
|
||||
text = CLEAN.replace("- **Rule:** state changes only through the command bus\n", "")
|
||||
result = lint_spine.lint(text)
|
||||
assert any(f["category"] == "ad_fields" and "rule" in f["detail"] for f in result["findings"])
|
||||
|
||||
|
||||
def test_unpinned_dep_caught():
|
||||
text = CLEAN.replace("- fastapi@0.115", "- fastapi")
|
||||
result = lint_spine.lint(text)
|
||||
assert "version_pin" in cats(result)
|
||||
|
||||
|
||||
def test_inline_key_deps_unpinned():
|
||||
text = CLEAN.replace(" key_deps:\n - fastapi@0.115\n - pydantic@2.9", " key_deps: [fastapi, redis@7]")
|
||||
result = lint_spine.lint(text)
|
||||
pins = [f for f in result["findings"] if f["category"] == "version_pin"]
|
||||
assert len(pins) == 1 and "fastapi" in pins[0]["detail"]
|
||||
|
||||
|
||||
def test_empty_key_deps_ok():
|
||||
text = CLEAN.replace(" key_deps:\n - fastapi@0.115\n - pydantic@2.9", " key_deps: []")
|
||||
result = lint_spine.lint(text)
|
||||
assert "version_pin" not in cats(result)
|
||||
|
||||
|
||||
def test_yaml_comments_not_parsed_as_deps():
|
||||
# a SEED comment on the key_deps line must not read as an unpinned dependency
|
||||
text = CLEAN.replace(
|
||||
" key_deps:\n - fastapi@0.115\n - pydantic@2.9",
|
||||
" key_deps: # SEED — verified current 2026-06\n - fastapi@0.115 # web framework",
|
||||
)
|
||||
result = lint_spine.lint(text)
|
||||
assert "version_pin" not in cats(result)
|
||||
|
||||
|
||||
def test_template_token_is_low_severity():
|
||||
# a bare {token} can be legitimate brace prose; it is flagged, but low (not high) so the
|
||||
# mechanical pass stays near-zero false-positive
|
||||
text = CLEAN.replace("single write path", "{decision}")
|
||||
result = lint_spine.lint(text)
|
||||
toks = [f for f in result["findings"] if f["category"] == "placeholder" and "template token" in f["detail"]]
|
||||
assert toks and all(f["severity"] == "low" for f in toks)
|
||||
|
||||
|
||||
def test_no_frontmatter_body_still_scanned():
|
||||
text = "## Invariants\n\n### AD-1 — x\n\n- **Binds:** all\n- **Prevents:** drift\n- **Rule:** TBD\n"
|
||||
result = lint_spine.lint(text)
|
||||
assert "placeholder" in cats(result) # TBD caught even with no frontmatter
|
||||
|
||||
|
||||
def test_frontmatter_value_with_dashes_not_truncated():
|
||||
# a value containing '---' must not be read as the closing fence (line-exact close)
|
||||
text = "---\nscope: 'phase 1 --- phase 2'\nstack:\n key_deps:\n - fastapi\n---\n\n## Invariants\n"
|
||||
result = lint_spine.lint(text)
|
||||
assert any(f["category"] == "version_pin" for f in result["findings"]) # read past the inline ---
|
||||
|
||||
|
||||
def test_ad_heading_in_fence_not_counted():
|
||||
text = (
|
||||
"---\nname: 'x'\n---\n\n"
|
||||
"### AD-1 — real\n\n- **Binds:** all\n- **Prevents:** drift\n- **Rule:** do x\n\n"
|
||||
"## Docs\n\n```text\n### AD-2 — illustrative only, no fields\n```\n"
|
||||
)
|
||||
result = lint_spine.lint(text)
|
||||
assert result["ok"] is True # the fenced AD-2 is not a live AD → no ad_fields/ad_id finding
|
||||
|
||||
|
||||
def test_map_form_key_deps_unpinned_caught():
|
||||
text = "---\nstack:\n key_deps:\n fastapi: '0.115'\n redis:\n---\n\n## Invariants\n"
|
||||
result = lint_spine.lint(text)
|
||||
pins = [f for f in result["findings"] if f["category"] == "version_pin"]
|
||||
assert len(pins) == 1 and "redis" in pins[0]["detail"]
|
||||
|
||||
|
||||
def test_map_form_key_deps_pinned_ok():
|
||||
text = "---\nstack:\n key_deps:\n fastapi: '0.115'\n---\n\n## Invariants\n"
|
||||
result = lint_spine.lint(text)
|
||||
assert "version_pin" not in cats(result)
|
||||
|
||||
|
||||
def test_placeholder_line_number_is_absolute():
|
||||
# a TBD after a multi-line fence reports its real file line (fence blanked, not collapsed)
|
||||
text = (
|
||||
"---\nname: 'x'\n---\n\n"
|
||||
"## A\n\n"
|
||||
"```text\nf1\nf2\nf3\n```\n\n"
|
||||
"TBD here\n"
|
||||
)
|
||||
result = lint_spine.lint(text)
|
||||
ph = next(f for f in result["findings"] if "TBD" in f["detail"])
|
||||
n = int(re.search(r"line (\d+)", ph["location"]).group(1))
|
||||
assert n == 13
|
||||
|
||||
|
||||
def test_missing_spine_file_reports_error(tmp_path, capsys):
|
||||
rc = lint_spine.main(["--workspace", str(tmp_path)])
|
||||
out = json.loads(capsys.readouterr().out)
|
||||
assert rc == 0 and out["ok"] is False and "not found" in out["error"]
|
||||
|
||||
|
||||
def test_frontmatter_unfilled_token_caught():
|
||||
# an unfilled {scope}/{paradigm}/{date} in frontmatter is part of the contract and must lint
|
||||
text = "---\nname: 'x'\nscope: '{what this spine governs}'\n---\n\n## Invariants\n"
|
||||
result = lint_spine.lint(text)
|
||||
fm = [f for f in result["findings"] if f["category"] == "placeholder" and "frontmatter" in f["detail"]]
|
||||
assert fm and any("template token" in f["detail"] for f in fm)
|
||||
|
||||
|
||||
def test_frontmatter_tbd_caught():
|
||||
text = "---\nname: 'x'\nstatus: TBD\n---\n\n## Invariants\n"
|
||||
result = lint_spine.lint(text)
|
||||
assert any(f["category"] == "placeholder" and "frontmatter" in f["detail"] and "TBD" in f["detail"]
|
||||
for f in result["findings"])
|
||||
|
||||
|
||||
def test_unreadable_spine_returns_error_not_crash(tmp_path, capsys):
|
||||
# a spine that exists but can't be UTF-8 decoded must yield error JSON + exit 0, not a traceback
|
||||
(tmp_path / lint_spine.SPINE).write_bytes(b"\xff\xfe bad bytes not utf-8")
|
||||
rc = lint_spine.main(["--workspace", str(tmp_path)])
|
||||
out = json.loads(capsys.readouterr().out)
|
||||
assert rc == 0 and out["ok"] is False and "could not read" in out["error"]
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(pytest.main([__file__, "-q"]))
|
||||
|
|
@ -1,74 +1,30 @@
|
|||
---
|
||||
name: bmad-create-architecture
|
||||
description: 'Create architecture solution design decisions for AI agent consistency. Use when the user says "lets create architecture" or "create technical architecture" or "create a solution design"'
|
||||
description: 'DEPRECATED — consolidated into bmad-architecture create intent - this skill will be removed in v7 in favor of `bmad-architecture`.'
|
||||
---
|
||||
|
||||
# Architecture Workflow
|
||||
# DEPRECATED — forwards to bmad-architecture (create intent)
|
||||
|
||||
**Goal:** Create comprehensive architecture decisions through collaborative step-by-step discovery that ensures AI agents implement consistently.
|
||||
|
||||
**Your Role:** You are an architectural facilitator collaborating with a peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and architectural knowledge, while the user brings domain expertise and product vision. Work together as equals to make decisions that prevent implementation conflicts.
|
||||
|
||||
## Conventions
|
||||
|
||||
- Bare paths (e.g. `steps/step-01-init.md`) resolve from the skill root.
|
||||
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||
- `{skill-name}` resolves to the skill directory's basename.
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
This uses **micro-file architecture** for disciplined execution:
|
||||
|
||||
- Each step is a self-contained file with embedded rules
|
||||
- Sequential progression with user control at each step
|
||||
- Document state tracked in frontmatter
|
||||
- Append-only document building through conversation
|
||||
- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation.
|
||||
This skill was consolidated into `bmad-architecture`. It is retained as a thin compatibility shim so existing invocations by name and `_bmad/custom/bmad-create-architecture.toml` override files keep working. New work should invoke `bmad-architecture` directly — it detects create / update / validate intent from the conversation.
|
||||
|
||||
## On Activation
|
||||
|
||||
### Step 1: Resolve the Workflow Block
|
||||
1. Resolve customization: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`. This picks up any `{project-root}/_bmad/custom/bmad-create-architecture.toml` and `bmad-create-architecture.user.toml` overrides for the legacy fields (`activation_steps_prepend`, `activation_steps_append`, `persistent_facts`, `on_complete`).
|
||||
|
||||
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||
2. Load `{project-root}/_bmad/bmm/config.yaml` (and `config.user.yaml` if present) to resolve `{user_name}` and `{communication_language}`.
|
||||
|
||||
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
||||
3. Emit a deprecation notice to the user in `{communication_language}`:
|
||||
|
||||
1. `{skill-root}/customize.toml` — defaults
|
||||
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||
> Notice: `bmad-create-architecture` is deprecated and will be removed in a future release. It now forwards to `bmad-architecture` with create intent. To silence this notice and access the full new customization surface (`spine_template`, `spine_output_path`, `run_folder_pattern`, `doc_standards`, `external_sources`, `external_handoffs`, `finalize_reviewers`), migrate `_bmad/custom/bmad-create-architecture.toml` to `_bmad/custom/bmad-architecture.toml` and invoke `bmad-architecture` directly next time. Customization fields that were in this version still remain in the new version and will be respected if present in `_bmad/custom/bmad-architecture.toml`, but the new version also supports additional fields that you can take advantage of by migrating.
|
||||
|
||||
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
||||
4. Invoke `bmad-architecture` with the following context. Pass these as the activating context so `bmad-architecture` honors them instead of resolving its own customization from scratch:
|
||||
|
||||
### Step 2: Execute Prepend Steps
|
||||
- **Intent:** `create` — skip `bmad-architecture`'s usual intent detection step.
|
||||
- **Pre-resolved legacy customization** — use these in place of resolving from `bmad-architecture`'s own `customize.toml` for the four legacy fields. For everything else (`spine_template`, `spine_output_path`, `run_folder_pattern`, `doc_standards`, `external_sources`, `external_handoffs`, `finalize_reviewers`), use `bmad-architecture`'s own defaults and overrides as normal:
|
||||
- `activation_steps_prepend` = the resolved value from step 1
|
||||
- `activation_steps_append` = the resolved value from step 1
|
||||
- `persistent_facts` = the resolved value from step 1
|
||||
- `on_complete` = the resolved value from step 1
|
||||
- **Original user input:** forward whatever the user said when invoking this skill verbatim.
|
||||
|
||||
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||
|
||||
### Step 3: Load Persistent Facts
|
||||
|
||||
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
||||
|
||||
### Step 4: Load Config
|
||||
|
||||
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
- Use `{user_name}` for greeting
|
||||
- Use `{communication_language}` for all communications
|
||||
- Use `{document_output_language}` for output documents
|
||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||
- Use `{project_knowledge}` for additional context scanning
|
||||
|
||||
### Step 5: Greet the User
|
||||
|
||||
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||
|
||||
### Step 6: Execute Append Steps
|
||||
|
||||
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||
|
||||
Activation is complete. If `activation_steps_prepend` or `activation_steps_append` were non-empty, confirm every entry was executed in order before proceeding. Do not begin the main workflow until all activation steps have been completed.
|
||||
|
||||
## Execution
|
||||
|
||||
Read fully and follow: `./steps/step-01-init.md` to begin the workflow.
|
||||
|
||||
**Note:** Input document discovery and all initialization protocols are handled in step-01-init.md.
|
||||
`bmad-architecture` takes the workflow from here. Do not execute any further steps in this shim.
|
||||
|
|
|
|||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
stepsCompleted: []
|
||||
inputDocuments: []
|
||||
workflowType: 'architecture'
|
||||
project_name: '{{project_name}}'
|
||||
user_name: '{{user_name}}'
|
||||
date: '{{date}}'
|
||||
---
|
||||
|
||||
# Architecture Decision Document
|
||||
|
||||
_This document builds collaboratively through step-by-step discovery. Sections are appended as we work through each architectural decision together._
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
domain,signals,complexity_level,suggested_workflow,web_searches
|
||||
e_commerce,"shopping,cart,checkout,payment,products,store",medium,standard,"ecommerce architecture patterns, payment processing, inventory management"
|
||||
fintech,"banking,payment,trading,finance,money,investment",high,enhanced,"financial security, PCI compliance, trading algorithms, fraud detection"
|
||||
healthcare,"medical,diagnostic,clinical,patient,hospital,health",high,enhanced,"HIPAA compliance, medical data security, FDA regulations, health tech"
|
||||
social,"social network,community,users,friends,posts,sharing",high,advanced,"social graph algorithms, feed ranking, notification systems, privacy"
|
||||
education,"learning,course,student,teacher,training,academic",medium,standard,"LMS architecture, progress tracking, assessment systems, video streaming"
|
||||
productivity,"productivity,workflow,tasks,management,business,tools",medium,standard,"collaboration patterns, real-time editing, notification systems, integration"
|
||||
media,"content,media,video,audio,streaming,broadcast",high,advanced,"CDN architecture, video encoding, streaming protocols, content delivery"
|
||||
iot,"IoT,sensors,devices,embedded,smart,connected",high,advanced,"device communication, real-time data processing, edge computing, security"
|
||||
government,"government,civic,public,admin,policy,regulation",high,enhanced,"accessibility standards, security clearance, data privacy, audit trails"
|
||||
process_control,"industrial automation,process control,PLC,SCADA,DCS,HMI,operational technology,control system,cyberphysical,MES,instrumentation,I&C,P&ID",high,advanced,"industrial process control architecture, SCADA system design, OT cybersecurity architecture, real-time control systems"
|
||||
building_automation,"building automation,BAS,BMS,HVAC,smart building,fire alarm,fire protection,fire suppression,life safety,elevator,DDC,access control,sequence of operations,commissioning",high,advanced,"building automation architecture, BACnet integration patterns, smart building design, building management system security"
|
||||
gaming,"game,gaming,multiplayer,real-time,interactive,entertainment",high,advanced,"real-time multiplayer, game engine architecture, matchmaking, leaderboards"
|
||||
|
|
|
@ -1,7 +0,0 @@
|
|||
project_type,detection_signals,description,typical_starters
|
||||
web_app,"website,web application,browser,frontend,UI,interface",Web-based applications running in browsers,Next.js, Vite, Remix
|
||||
mobile_app,"mobile,iOS,Android,app,smartphone,tablet",Native mobile applications,React Native, Expo, Flutter
|
||||
api_backend,"API,REST,GraphQL,backend,service,microservice",Backend services and APIs,NestJS, Express, Fastify
|
||||
full_stack,"full-stack,complete,web+mobile,frontend+backend",Applications with both frontend and backend,T3 App, RedwoodJS, Blitz
|
||||
cli_tool,"CLI,command line,terminal,console,tool",Command-line interface tools,oclif, Commander, Caporal
|
||||
desktop_app,"desktop,Electron,Tauri,native app,macOS,Windows",Desktop applications,Electron, Tauri, Flutter Desktop
|
||||
|
Can't render this file because it has a wrong number of fields in line 2.
|
|
|
@ -1,153 +0,0 @@
|
|||
# Step 1: Architecture Workflow Initialization
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on initialization and setup only - don't look ahead to future steps
|
||||
- 🚪 DETECT existing workflow state and handle continuation properly
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 💾 Initialize document and update frontmatter
|
||||
- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until setup is complete
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Variables from workflow.md are available in memory
|
||||
- Previous context = what's in output document + frontmatter
|
||||
- Don't assume knowledge from other steps
|
||||
- Input document discovery happens in this step
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Initialize the Architecture workflow by detecting continuation state, discovering input documents, and setting up the document for collaborative architectural decision making.
|
||||
|
||||
## INITIALIZATION SEQUENCE:
|
||||
|
||||
### 1. Check for Existing Workflow
|
||||
|
||||
First, check if the output document already exists:
|
||||
|
||||
- Look for existing {planning_artifacts}/`*architecture*.md`
|
||||
- If exists, read the complete file(s) including frontmatter
|
||||
- If not exists, this is a fresh workflow
|
||||
|
||||
### 2. Handle Continuation (If Document Exists)
|
||||
|
||||
If the document exists and has frontmatter with `stepsCompleted`:
|
||||
|
||||
- **STOP here** and load `./step-01b-continue.md` immediately
|
||||
- Do not proceed with any initialization tasks
|
||||
- Let step-01b handle the continuation logic
|
||||
|
||||
### 3. Fresh Workflow Setup (If No Document)
|
||||
|
||||
If no document exists or no `stepsCompleted` in frontmatter:
|
||||
|
||||
#### A. Input Document Discovery
|
||||
|
||||
Discover and load context documents using smart discovery. Documents can be in the following locations:
|
||||
- {planning_artifacts}/**
|
||||
- {output_folder}/**
|
||||
- {project_knowledge}/**
|
||||
- {project-root}/docs/**
|
||||
|
||||
Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content)
|
||||
|
||||
Try to discover the following:
|
||||
- Product Brief (`*brief*.md`)
|
||||
- Product Requirements Document (`*prd*.md`)
|
||||
- UX Design (`*ux-design*.md`) and other
|
||||
- Research Documents (`*research*.md`)
|
||||
- Project Documentation (generally multiple documents might be found for this in the `{project_knowledge}` or `{project-root}/docs` folder.)
|
||||
- Project Context (`**/project-context.md`)
|
||||
|
||||
<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
|
||||
|
||||
**Loading Rules:**
|
||||
|
||||
- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
|
||||
- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process
|
||||
- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
|
||||
- index.md is a guide to what's relevant whenever available
|
||||
- Track all successfully loaded files in frontmatter `inputDocuments` array
|
||||
|
||||
#### B. Validate Required Inputs
|
||||
|
||||
Before proceeding, verify we have the essential inputs:
|
||||
|
||||
**PRD Validation:**
|
||||
|
||||
- If no PRD found: "Architecture requires a PRD to work from. Please run the PRD workflow first or provide the PRD file path."
|
||||
- Do NOT proceed without PRD
|
||||
|
||||
**Other Input that might exist:**
|
||||
|
||||
- UX Spec: "Provides UI/UX architectural requirements"
|
||||
|
||||
#### C. Create Initial Document
|
||||
|
||||
Copy the template from `../architecture-decision-template.md` to `{planning_artifacts}/architecture.md`
|
||||
|
||||
#### D. Complete Initialization and Report
|
||||
|
||||
Complete setup and report to user:
|
||||
|
||||
**Document Setup:**
|
||||
|
||||
- Created: `{planning_artifacts}/architecture.md` from template
|
||||
- Initialized frontmatter with workflow state
|
||||
|
||||
**Input Documents Discovered:**
|
||||
Report what was found:
|
||||
"Welcome {{user_name}}! I've set up your Architecture workspace for {{project_name}}.
|
||||
|
||||
**Documents Found:**
|
||||
|
||||
- PRD: {number of PRD files loaded or "None found - REQUIRED"}
|
||||
- UX Design: {number of UX files loaded or "None found"}
|
||||
- Research: {number of research files loaded or "None found"}
|
||||
- Project docs: {number of project files loaded or "None found"}
|
||||
- Project context: {project_context_rules count of rules for AI agents found}
|
||||
|
||||
**Files loaded:** {list of specific file names or "No additional documents found"}
|
||||
|
||||
Ready to begin architectural decision making. Do you have any other documents you'd like me to include?
|
||||
|
||||
[C] Continue to project context analysis
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Existing workflow detected and handed off to step-01b correctly
|
||||
✅ Fresh workflow initialized with template and frontmatter
|
||||
✅ Input documents discovered and loaded using sharded-first logic
|
||||
✅ All discovered files tracked in frontmatter `inputDocuments`
|
||||
✅ PRD requirement validated and communicated
|
||||
✅ User confirmed document setup and can proceed
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Proceeding with fresh initialization when existing workflow exists
|
||||
❌ Not updating frontmatter with discovered input documents
|
||||
❌ Creating document without proper template
|
||||
❌ Not checking sharded folders first before whole files
|
||||
❌ Not reporting what documents were found to user
|
||||
❌ Proceeding without validating PRD requirement
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects [C] to continue, only after ensuring all the template output has been created, then load `./step-02-context.md` to analyze the project context and begin architectural decision making.
|
||||
|
||||
Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and setup is confirmed!
|
||||
|
|
@ -1,173 +0,0 @@
|
|||
# Step 1b: Workflow Continuation Handler
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on understanding current state and getting user confirmation
|
||||
- 🚪 HANDLE workflow resumption smoothly and transparently
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 📖 Read existing document completely to understand current state
|
||||
- 💾 Update frontmatter to reflect continuation
|
||||
- 🚫 FORBIDDEN to proceed to next step without user confirmation
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Existing document and frontmatter are available
|
||||
- Input documents already loaded should be in frontmatter `inputDocuments`
|
||||
- Steps already completed are in `stepsCompleted` array
|
||||
- Focus on understanding where we left off
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Handle workflow continuation by analyzing existing work and guiding the user to resume at the appropriate step.
|
||||
|
||||
## CONTINUATION SEQUENCE:
|
||||
|
||||
### 1. Analyze Current Document State
|
||||
|
||||
Read the existing architecture document completely and analyze:
|
||||
|
||||
**Frontmatter Analysis:**
|
||||
|
||||
- `stepsCompleted`: What steps have been done
|
||||
- `inputDocuments`: What documents were loaded
|
||||
- `lastStep`: Last step that was executed
|
||||
- `project_name`, `user_name`, `date`: Basic context
|
||||
|
||||
**Content Analysis:**
|
||||
|
||||
- What sections exist in the document
|
||||
- What architectural decisions have been made
|
||||
- What appears incomplete or in progress
|
||||
- Any TODOs or placeholders remaining
|
||||
|
||||
### 2. Present Continuation Summary
|
||||
|
||||
Show the user their current progress:
|
||||
|
||||
"Welcome back {{user_name}}! I found your Architecture work for {{project_name}}.
|
||||
|
||||
**Current Progress:**
|
||||
|
||||
- Steps completed: {{stepsCompleted list}}
|
||||
- Last step worked on: Step {{lastStep}}
|
||||
- Input documents loaded: {{number of inputDocuments}} files
|
||||
|
||||
**Document Sections Found:**
|
||||
{list all H2/H3 sections found in the document}
|
||||
|
||||
{if_incomplete_sections}
|
||||
**Incomplete Areas:**
|
||||
|
||||
- {areas that appear incomplete or have placeholders}
|
||||
{/if_incomplete_sections}
|
||||
|
||||
**What would you like to do?**
|
||||
[R] Resume from where we left off
|
||||
[C] Continue to next logical step
|
||||
[O] Overview of all remaining steps
|
||||
[X] Start over (will overwrite existing work)
|
||||
"
|
||||
|
||||
### 3. Handle User Choice
|
||||
|
||||
#### If 'R' (Resume from where we left off):
|
||||
|
||||
- Identify the next step based on `stepsCompleted`
|
||||
- Load the appropriate step file to continue
|
||||
- Example: If `stepsCompleted: [1, 2, 3]`, load `./step-04-decisions.md`
|
||||
|
||||
#### If 'C' (Continue to next logical step):
|
||||
|
||||
- Analyze the document content to determine logical next step
|
||||
- May need to review content quality and completeness
|
||||
- If content seems complete for current step, advance to next
|
||||
- If content seems incomplete, suggest staying on current step
|
||||
|
||||
#### If 'O' (Overview of all remaining steps):
|
||||
|
||||
- Provide brief description of all remaining steps
|
||||
- Let user choose which step to work on
|
||||
- Don't assume sequential progression is always best
|
||||
|
||||
#### If 'X' (Start over):
|
||||
|
||||
- Confirm: "This will delete all existing architectural decisions. Are you sure? (y/n)"
|
||||
- If confirmed: Delete existing document and read fully and follow: `./step-01-init.md`
|
||||
- If not confirmed: Return to continuation menu
|
||||
|
||||
### 4. Navigate to Selected Step
|
||||
|
||||
After user makes choice:
|
||||
|
||||
**Load the selected step file:**
|
||||
|
||||
- Update frontmatter `lastStep` to reflect current navigation
|
||||
- Execute the selected step file
|
||||
- Let that step handle the detailed continuation logic
|
||||
|
||||
**State Preservation:**
|
||||
|
||||
- Maintain all existing content in the document
|
||||
- Keep `stepsCompleted` accurate
|
||||
- Track the resumption in workflow status
|
||||
|
||||
### 5. Special Continuation Cases
|
||||
|
||||
#### If `stepsCompleted` is empty but document has content:
|
||||
|
||||
- This suggests an interrupted workflow
|
||||
- Ask user: "I see the document has content but no steps are marked as complete. Should I analyze what's here and set the appropriate step status?"
|
||||
|
||||
#### If document appears corrupted or incomplete:
|
||||
|
||||
- Ask user: "The document seems incomplete. Would you like me to try to recover what's here, or would you prefer to start fresh?"
|
||||
|
||||
#### If document is complete but workflow not marked as done:
|
||||
|
||||
- Ask user: "The architecture looks complete! Should I mark this workflow as finished, or is there more you'd like to work on?"
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Existing document state properly analyzed and understood
|
||||
✅ User presented with clear continuation options
|
||||
✅ User choice handled appropriately and transparently
|
||||
✅ Workflow state preserved and updated correctly
|
||||
✅ Navigation to appropriate step handled smoothly
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not reading the complete existing document before making suggestions
|
||||
❌ Losing track of what steps were actually completed
|
||||
❌ Automatically proceeding without user confirmation of next steps
|
||||
❌ Not checking for incomplete or placeholder content
|
||||
❌ Losing existing document content during resumption
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects their continuation option, load the appropriate step file based on their choice. The step file will handle the detailed work from that point forward.
|
||||
|
||||
Valid step files to load:
|
||||
- `./step-02-context.md`
|
||||
- `./step-03-starter.md`
|
||||
- `./step-04-decisions.md`
|
||||
- `./step-05-patterns.md`
|
||||
- `./step-06-structure.md`
|
||||
- `./step-07-validation.md`
|
||||
- `./step-08-complete.md`
|
||||
|
||||
Remember: The goal is smooth, transparent resumption that respects the work already done while giving the user control over how to proceed.
|
||||
|
|
@ -1,224 +0,0 @@
|
|||
# Step 2: Project Context Analysis
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on understanding project scope and requirements for architecture
|
||||
- 🎯 ANALYZE loaded documents, don't assume or generate requirements
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating project context analysis
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper insights about project context and architectural implications
|
||||
- **P (Party Mode)**: Bring multiple perspectives to analyze project requirements from different architectural angles
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Invoke the `bmad-advanced-elicitation` skill
|
||||
- When 'P' selected: Invoke the `bmad-party-mode` skill
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from step 1 are available
|
||||
- Input documents already loaded are in memory (PRD, epics, UX spec, etc.)
|
||||
- Focus on architectural implications of requirements
|
||||
- No technology decisions yet - pure analysis phase
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Fully read and Analyze the loaded project documents to understand architectural scope, requirements, and constraints before beginning decision making.
|
||||
|
||||
## CONTEXT ANALYSIS SEQUENCE:
|
||||
|
||||
### 1. Review Project Requirements
|
||||
|
||||
**From PRD Analysis:**
|
||||
|
||||
- Extract and analyze Functional Requirements (FRs)
|
||||
- Identify Non-Functional Requirements (NFRs) like performance, security, compliance
|
||||
- Note any technical constraints or dependencies mentioned
|
||||
- Count and categorize requirements to understand project scale
|
||||
|
||||
**From Epics/Stories (if available):**
|
||||
|
||||
- Map epic structure and user stories to architectural components
|
||||
- Extract acceptance criteria for technical implications
|
||||
- Identify cross-cutting concerns that span multiple epics
|
||||
- Estimate story complexity for architectural planning
|
||||
|
||||
**From UX Design (if available):**
|
||||
|
||||
- Extract architectural implications from UX requirements:
|
||||
- Component complexity (simple forms vs rich interactions)
|
||||
- Animation/transition requirements
|
||||
- Real-time update needs (live data, collaborative features)
|
||||
- Platform-specific UI requirements
|
||||
- Accessibility standards (WCAG compliance level)
|
||||
- Responsive design breakpoints
|
||||
- Offline capability requirements
|
||||
- Performance expectations (load times, interaction responsiveness)
|
||||
|
||||
### 2. Project Scale Assessment
|
||||
|
||||
Calculate and present project complexity:
|
||||
|
||||
**Complexity Indicators:**
|
||||
|
||||
- Real-time features requirements
|
||||
- Multi-tenancy needs
|
||||
- Regulatory compliance requirements
|
||||
- Integration complexity
|
||||
- User interaction complexity
|
||||
- Data complexity and volume
|
||||
|
||||
### 3. Reflect Understanding
|
||||
|
||||
Present your analysis back to user for validation:
|
||||
|
||||
"I'm reviewing your project documentation for {{project_name}}.
|
||||
|
||||
{if_epics_loaded}I see {{epic_count}} epics with {{story_count}} total stories.{/if_epics_loaded}
|
||||
{if_no_epics}I found {{fr_count}} functional requirements organized into {{fr_category_list}}.{/if_no_epics}
|
||||
{if_ux_loaded}I also found your UX specification which defines the user experience requirements.{/if_ux_loaded}
|
||||
|
||||
**Key architectural aspects I notice:**
|
||||
|
||||
- [Summarize core functionality from FRs]
|
||||
- [Note critical NFRs that will shape architecture]
|
||||
- {if_ux_loaded}[Note UX complexity and technical requirements]{/if_ux_loaded}
|
||||
- [Identify unique technical challenges or constraints]
|
||||
- [Highlight any regulatory or compliance requirements]
|
||||
|
||||
**Scale indicators:**
|
||||
|
||||
- Project complexity appears to be: [low/medium/high/enterprise]
|
||||
- Primary technical domain: [web/mobile/api/backend/full-stack/etc]
|
||||
- Cross-cutting concerns identified: [list major ones]
|
||||
|
||||
This analysis will help me guide you through the architectural decisions needed to ensure AI agents implement this consistently.
|
||||
|
||||
Does this match your understanding of the project scope and requirements?"
|
||||
|
||||
### 4. Generate Project Context Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
```markdown
|
||||
## Project Context Analysis
|
||||
|
||||
### Requirements Overview
|
||||
|
||||
**Functional Requirements:**
|
||||
{{analysis of FRs and what they mean architecturally}}
|
||||
|
||||
**Non-Functional Requirements:**
|
||||
{{NFRs that will drive architectural decisions}}
|
||||
|
||||
**Scale & Complexity:**
|
||||
{{project_scale_assessment}}
|
||||
|
||||
- Primary domain: {{technical_domain}}
|
||||
- Complexity level: {{complexity_level}}
|
||||
- Estimated architectural components: {{component_count}}
|
||||
|
||||
### Technical Constraints & Dependencies
|
||||
|
||||
{{known_constraints_dependencies}}
|
||||
|
||||
### Cross-Cutting Concerns Identified
|
||||
|
||||
{{concerns_that_will_affect_multiple_components}}
|
||||
```
|
||||
|
||||
### 5. Present Content and Menu
|
||||
|
||||
Show the generated content and present choices:
|
||||
|
||||
"I've drafted the Project Context Analysis based on your requirements. This sets the foundation for our architectural decisions.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 4]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's dive deeper into architectural implications
|
||||
[P] Party Mode - Bring different perspectives to analyze requirements
|
||||
[C] Continue - Save this analysis and begin architectural decisions"
|
||||
|
||||
### 6. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Invoke the `bmad-advanced-elicitation` skill with the current context analysis
|
||||
- Process the enhanced architectural insights that come back
|
||||
- Ask user: "Accept these enhancements to the project context analysis? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Invoke the `bmad-party-mode` skill with the current project context
|
||||
- Process the collaborative improvements to architectural understanding
|
||||
- Ask user: "Accept these changes to the project context analysis? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load `./step-03-starter.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 4.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ All input documents thoroughly analyzed for architectural implications
|
||||
✅ Project scope and complexity clearly assessed and validated
|
||||
✅ Technical constraints and dependencies identified
|
||||
✅ Cross-cutting concerns mapped for architectural planning
|
||||
✅ User confirmation of project understanding
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Skimming documents without deep architectural analysis
|
||||
❌ Missing or misinterpreting critical NFRs
|
||||
❌ Not validating project understanding with user
|
||||
❌ Underestimating complexity indicators
|
||||
❌ Generating content without real analysis of loaded documents
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-03-starter.md` to evaluate starter template options.
|
||||
|
||||
Remember: Do NOT proceed to step-03 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
|
@ -1,329 +0,0 @@
|
|||
# Step 3: Starter Template Evaluation
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on evaluating starter template options with current versions
|
||||
- 🌐 ALWAYS search the web to verify current versions - NEVER trust hardcoded versions
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete architecture
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 🌐 Search the web to verify current versions and options
|
||||
- ⚠️ Present A/P/C menu after generating starter template analysis
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to explore unconventional starter options or custom approaches
|
||||
- **P (Party Mode)**: Bring multiple perspectives to evaluate starter trade-offs for different use cases
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Invoke the `bmad-advanced-elicitation` skill
|
||||
- When 'P' selected: Invoke the `bmad-party-mode` skill
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Project context from step 2 is available and complete
|
||||
- Project context file from step-01 may contain technical preferences
|
||||
- No architectural decisions made yet - evaluating foundations
|
||||
- Focus on technical preferences discovery and starter evaluation
|
||||
- Consider project requirements and existing preferences when evaluating options
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Discover technical preferences and evaluate starter template options, leveraging existing technical preferences and establishing solid architectural foundations.
|
||||
|
||||
## STARTER EVALUATION SEQUENCE:
|
||||
|
||||
### 0. Check Technical Preferences & Context
|
||||
|
||||
**Check Project Context for Existing Technical Preferences:**
|
||||
"Before we dive into starter templates, let me check if you have any technical preferences already documented.
|
||||
|
||||
{{if_project_context_exists}}
|
||||
I found some technical rules in your project context file:
|
||||
{{extracted_technical_preferences_from_project_context}}
|
||||
|
||||
**Project Context Technical Rules Found:**
|
||||
|
||||
- Languages/Frameworks: {{languages_frameworks_from_context}}
|
||||
- Tools & Libraries: {{tools_from_context}}
|
||||
- Development Patterns: {{patterns_from_context}}
|
||||
- Platform Preferences: {{platforms_from_context}}
|
||||
|
||||
{{else}}
|
||||
No existing technical preferences found in project context file. We'll establish your technical preferences now.
|
||||
{{/if_project_context}}"
|
||||
|
||||
**Discover User Technical Preferences:**
|
||||
"Based on your project context, let's discuss your technical preferences:
|
||||
|
||||
{{primary_technology_category}} Preferences:
|
||||
|
||||
- **Languages**: Do you have preferences between TypeScript/JavaScript, Python, Go, Rust, etc.?
|
||||
- **Frameworks**: Any existing familiarity or preferences (React, Vue, Angular, Next.js, etc.)?
|
||||
- **Databases**: Any preferences or existing infrastructure (PostgreSQL, MongoDB, MySQL, etc.)?
|
||||
|
||||
**Development Experience:**
|
||||
|
||||
- What's your team's experience level with different technologies?
|
||||
- Are there any technologies you want to learn vs. what you're comfortable with?
|
||||
|
||||
**Platform/Deployment Preferences:**
|
||||
|
||||
- Cloud provider preferences (AWS, Vercel, Railway, etc.)?
|
||||
- Container preferences (Docker, Serverless, Traditional)?
|
||||
|
||||
**Integrations:**
|
||||
|
||||
- Any existing systems or APIs you need to integrate with?
|
||||
- Third-party services you plan to use (payment, authentication, analytics, etc.)?
|
||||
|
||||
These preferences will help me recommend the most suitable starter templates and guide our architectural decisions."
|
||||
|
||||
### 1. Identify Primary Technology Domain
|
||||
|
||||
Based on project context analysis and technical preferences, identify the primary technology stack:
|
||||
|
||||
- **Web application** → Look for Next.js, Vite, Remix, SvelteKit starters
|
||||
- **Mobile app** → Look for React Native, Expo, Flutter starters
|
||||
- **API/Backend** → Look for NestJS, Express, Fastify, Supabase starters
|
||||
- **CLI tool** → Look for CLI framework starters (oclif, commander, etc.)
|
||||
- **Full-stack** → Look for T3, RedwoodJS, Blitz, Next.js starters
|
||||
- **Desktop** → Look for Electron, Tauri starters
|
||||
|
||||
### 2. UX Requirements Consideration
|
||||
|
||||
If UX specification was loaded, consider UX requirements when selecting starter:
|
||||
|
||||
- **Rich animations** → Framer Motion compatible starter
|
||||
- **Complex forms** → React Hook Form included starter
|
||||
- **Real-time features** → Socket.io or WebSocket ready starter
|
||||
- **Design system** → Storybook-enabled starter
|
||||
- **Offline capability** → Service worker or PWA configured starter
|
||||
|
||||
### 3. Research Current Starter Options
|
||||
|
||||
Search the web to find current, maintained starter templates:
|
||||
|
||||
```
|
||||
Search the web: "{{primary_technology}} starter template CLI create command latest"
|
||||
Search the web: "{{primary_technology}} boilerplate generator latest options"
|
||||
Search the web: "{{primary_technology}} production-ready starter best practices"
|
||||
```
|
||||
|
||||
### 4. Investigate Top Starter Options
|
||||
|
||||
For each promising starter found, investigate details:
|
||||
|
||||
```
|
||||
Search the web: "{{starter_name}} default setup technologies included latest"
|
||||
Search the web: "{{starter_name}} project structure file organization"
|
||||
Search the web: "{{starter_name}} production deployment capabilities"
|
||||
Search the web: "{{starter_name}} recent updates maintenance status"
|
||||
```
|
||||
|
||||
### 5. Analyze What Each Starter Provides
|
||||
|
||||
For each viable starter option, document:
|
||||
|
||||
**Technology Decisions Made:**
|
||||
|
||||
- Language/TypeScript configuration
|
||||
- Styling solution (CSS, Tailwind, Styled Components, etc.)
|
||||
- Testing framework setup
|
||||
- Linting/Formatting configuration
|
||||
- Build tooling and optimization
|
||||
- Project structure and organization
|
||||
|
||||
**Architectural Patterns Established:**
|
||||
|
||||
- Code organization patterns
|
||||
- Component structure conventions
|
||||
- API layering approach
|
||||
- State management setup
|
||||
- Routing patterns
|
||||
- Environment configuration
|
||||
|
||||
**Development Experience Features:**
|
||||
|
||||
- Hot reloading and development server
|
||||
- TypeScript configuration
|
||||
- Debugging setup
|
||||
- Testing infrastructure
|
||||
- Documentation generation
|
||||
|
||||
### 6. Present Starter Options
|
||||
|
||||
Based on user skill level and project needs:
|
||||
|
||||
**For Expert Users:**
|
||||
"Found {{starter_name}} which provides:
|
||||
{{quick_decision_list_of_key_decisions}}
|
||||
|
||||
This would establish our base architecture with these technical decisions already made. Use it?"
|
||||
|
||||
**For Intermediate Users:**
|
||||
"I found {{starter_name}}, which is a well-maintained starter for {{project_type}} projects.
|
||||
|
||||
It makes these architectural decisions for us:
|
||||
{{decision_list_with_explanations}}
|
||||
|
||||
This gives us a solid foundation following current best practices. Should we use it?"
|
||||
|
||||
**For Beginner Users:**
|
||||
"I found {{starter_name}}, which is like a pre-built foundation for your project.
|
||||
|
||||
Think of it like buying a prefab house frame instead of cutting each board yourself.
|
||||
|
||||
It makes these decisions for us:
|
||||
{{friendly_explanation_of_decisions}}
|
||||
|
||||
This is a great starting point that follows best practices and saves us from making dozens of small technical choices. Should we use it?"
|
||||
|
||||
### 7. Get Current CLI Commands
|
||||
|
||||
If user shows interest in a starter, get the exact current commands:
|
||||
|
||||
```
|
||||
Search the web: "{{starter_name}} CLI command options flags latest"
|
||||
Search the web: "{{starter_name}} create new project command examples"
|
||||
```
|
||||
|
||||
### 8. Generate Starter Template Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
````markdown
|
||||
## Starter Template Evaluation
|
||||
|
||||
### Primary Technology Domain
|
||||
|
||||
{{identified_domain}} based on project requirements analysis
|
||||
|
||||
### Starter Options Considered
|
||||
|
||||
{{analysis_of_evaluated_starters}}
|
||||
|
||||
### Selected Starter: {{starter_name}}
|
||||
|
||||
**Rationale for Selection:**
|
||||
{{why_this_starter_was_chosen}}
|
||||
|
||||
**Initialization Command:**
|
||||
|
||||
```bash
|
||||
{{full_starter_command_with_options}}
|
||||
```
|
||||
|
||||
**Architectural Decisions Provided by Starter:**
|
||||
|
||||
**Language & Runtime:**
|
||||
{{language_typescript_setup}}
|
||||
|
||||
**Styling Solution:**
|
||||
{{styling_solution_configuration}}
|
||||
|
||||
**Build Tooling:**
|
||||
{{build_tools_and_optimization}}
|
||||
|
||||
**Testing Framework:**
|
||||
{{testing_setup_and_configuration}}
|
||||
|
||||
**Code Organization:**
|
||||
{{project_structure_and_patterns}}
|
||||
|
||||
**Development Experience:**
|
||||
{{development_tools_and_workflow}}
|
||||
|
||||
**Note:** Project initialization using this command should be the first implementation story.
|
||||
|
||||
````
|
||||
|
||||
### 9. Present Content and Menu
|
||||
|
||||
Show the generated content and present choices:
|
||||
|
||||
"I've analyzed starter template options for {{project_type}} projects.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 8]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Explore custom approaches or unconventional starters
|
||||
[P] Party Mode - Evaluate trade-offs from different perspectives
|
||||
[C] Continue - Save this decision and move to architectural decisions"
|
||||
|
||||
### 10. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Invoke the `bmad-advanced-elicitation` skill with current starter analysis
|
||||
- Process enhanced insights about starter options or custom approaches
|
||||
- Ask user: "Accept these changes to the starter template evaluation? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Invoke the `bmad-party-mode` skill with starter evaluation context
|
||||
- Process collaborative insights about starter trade-offs
|
||||
- Ask user: "Accept these changes to the starter template evaluation? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
||||
- Load `./step-04-decisions.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 8.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Primary technology domain correctly identified from project context
|
||||
✅ Current, maintained starter templates researched and evaluated
|
||||
✅ All versions verified using web search, not hardcoded
|
||||
✅ Architectural implications of starter choice clearly documented
|
||||
✅ User provided with clear rationale for starter selection
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not verifying current versions with web search
|
||||
❌ Ignoring UX requirements when evaluating starters
|
||||
❌ Not documenting what architectural decisions the starter makes
|
||||
❌ Failing to consider maintenance status of starter templates
|
||||
❌ Not providing clear rationale for starter selection
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-04-decisions.md` to begin making specific architectural decisions.
|
||||
|
||||
Remember: Do NOT proceed to step-04 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
|
@ -1,318 +0,0 @@
|
|||
# Step 4: Core Architectural Decisions
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on making critical architectural decisions collaboratively
|
||||
- 🌐 ALWAYS search the web to verify current technology versions
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 🌐 Search the web to verify technology versions and options
|
||||
- ⚠️ Present A/P/C menu after each major decision category
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices for each decision category:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to explore innovative approaches to specific decisions
|
||||
- **P (Party Mode)**: Bring multiple perspectives to evaluate decision trade-offs
|
||||
- **C (Continue)**: Save the current decisions and proceed to next decision category
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Invoke the `bmad-advanced-elicitation` skill
|
||||
- When 'P' selected: Invoke the `bmad-party-mode` skill
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Project context from step 2 is available
|
||||
- Starter template choice from step 3 is available
|
||||
- Project context file may contain technical preferences and rules
|
||||
- Technical preferences discovered in step 3 are available
|
||||
- Focus on decisions not already made by starter template or existing preferences
|
||||
- Collaborative decision making, not recommendations
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Facilitate collaborative architectural decision making, leveraging existing technical preferences and starter template decisions, focusing on remaining choices critical to the project's success.
|
||||
|
||||
## DECISION MAKING SEQUENCE:
|
||||
|
||||
### 1. Load Decision Framework & Check Existing Preferences
|
||||
|
||||
**Review Technical Preferences from Step 3:**
|
||||
"Based on our technical preferences discussion in step 3, let's build on those foundations:
|
||||
|
||||
**Your Technical Preferences:**
|
||||
{{user_technical_preferences_from_step_3}}
|
||||
|
||||
**Starter Template Decisions:**
|
||||
{{starter_template_decisions}}
|
||||
|
||||
**Project Context Technical Rules:**
|
||||
{{project_context_technical_rules}}"
|
||||
|
||||
**Identify Remaining Decisions:**
|
||||
Based on technical preferences, starter template choice, and project context, identify remaining critical decisions:
|
||||
|
||||
**Already Decided (Don't re-decide these):**
|
||||
|
||||
- {{starter_template_decisions}}
|
||||
- {{user_technology_preferences}}
|
||||
- {{project_context_technical_rules}}
|
||||
|
||||
**Critical Decisions:** Must be decided before implementation can proceed
|
||||
**Important Decisions:** Shape the architecture significantly
|
||||
**Nice-to-Have:** Can be deferred if needed
|
||||
|
||||
### 2. Decision Categories by Priority
|
||||
|
||||
#### Category 1: Data Architecture
|
||||
|
||||
- Database choice (if not determined by starter)
|
||||
- Data modeling approach
|
||||
- Data validation strategy
|
||||
- Migration approach
|
||||
- Caching strategy
|
||||
|
||||
#### Category 2: Authentication & Security
|
||||
|
||||
- Authentication method
|
||||
- Authorization patterns
|
||||
- Security middleware
|
||||
- Data encryption approach
|
||||
- API security strategy
|
||||
|
||||
#### Category 3: API & Communication
|
||||
|
||||
- API design patterns (REST, GraphQL, etc.)
|
||||
- API documentation approach
|
||||
- Error handling standards
|
||||
- Rate limiting strategy
|
||||
- Communication between services
|
||||
|
||||
#### Category 4: Frontend Architecture (if applicable)
|
||||
|
||||
- State management approach
|
||||
- Component architecture
|
||||
- Routing strategy
|
||||
- Performance optimization
|
||||
- Bundle optimization
|
||||
|
||||
#### Category 5: Infrastructure & Deployment
|
||||
|
||||
- Hosting strategy
|
||||
- CI/CD pipeline approach
|
||||
- Environment configuration
|
||||
- Monitoring and logging
|
||||
- Scaling strategy
|
||||
|
||||
### 3. Facilitate Each Decision Category
|
||||
|
||||
For each category, facilitate collaborative decision making:
|
||||
|
||||
**Present the Decision:**
|
||||
Based on user skill level and project context:
|
||||
|
||||
**Expert Mode:**
|
||||
"{{Decision_Category}}: {{Specific_Decision}}
|
||||
|
||||
Options: {{concise_option_list_with_tradeoffs}}
|
||||
|
||||
What's your preference for this decision?"
|
||||
|
||||
**Intermediate Mode:**
|
||||
"Next decision: {{Human_Friendly_Category}}
|
||||
|
||||
We need to choose {{Specific_Decision}}.
|
||||
|
||||
Common options:
|
||||
{{option_list_with_brief_explanations}}
|
||||
|
||||
For your project, I'd lean toward {{recommendation}} because {{reason}}. What are your thoughts?"
|
||||
|
||||
**Beginner Mode:**
|
||||
"Let's talk about {{Human_Friendly_Category}}.
|
||||
|
||||
{{Educational_Context_About_Why_This_Matters}}
|
||||
|
||||
Think of it like {{real_world_analogy}}.
|
||||
|
||||
Your main options:
|
||||
{{friendly_options_with_pros_cons}}
|
||||
|
||||
My suggestion: {{recommendation}}
|
||||
This is good for you because {{beginner_friendly_reason}}.
|
||||
|
||||
What feels right to you?"
|
||||
|
||||
**Verify Technology Versions:**
|
||||
If decision involves specific technology:
|
||||
|
||||
```
|
||||
Search the web: "{{technology}} latest stable version"
|
||||
Search the web: "{{technology}} current LTS version"
|
||||
Search the web: "{{technology}} production readiness"
|
||||
```
|
||||
|
||||
**Get User Input:**
|
||||
"What's your preference? (or 'explain more' for details)"
|
||||
|
||||
**Handle User Response:**
|
||||
|
||||
- If user wants more info: Provide deeper explanation
|
||||
- If user has preference: Discuss implications and record decision
|
||||
- If user wants alternatives: Explore other options
|
||||
|
||||
**Record the Decision:**
|
||||
|
||||
- Category: {{category}}
|
||||
- Decision: {{user_choice}}
|
||||
- Version: {{verified_version_if_applicable}}
|
||||
- Rationale: {{user_reasoning_or_default}}
|
||||
- Affects: {{components_or_epics}}
|
||||
- Provided by Starter: {{yes_if_from_starter}}
|
||||
|
||||
### 4. Check for Cascading Implications
|
||||
|
||||
After each major decision, identify related decisions:
|
||||
|
||||
"This choice means we'll also need to decide:
|
||||
|
||||
- {{related_decision_1}}
|
||||
- {{related_decision_2}}"
|
||||
|
||||
### 5. Generate Decisions Content
|
||||
|
||||
After facilitating all decision categories, prepare the content to append:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
```markdown
|
||||
## Core Architectural Decisions
|
||||
|
||||
### Decision Priority Analysis
|
||||
|
||||
**Critical Decisions (Block Implementation):**
|
||||
{{critical_decisions_made}}
|
||||
|
||||
**Important Decisions (Shape Architecture):**
|
||||
{{important_decisions_made}}
|
||||
|
||||
**Deferred Decisions (Post-MVP):**
|
||||
{{decisions_deferred_with_rationale}}
|
||||
|
||||
### Data Architecture
|
||||
|
||||
{{data_related_decisions_with_versions_and_rationale}}
|
||||
|
||||
### Authentication & Security
|
||||
|
||||
{{security_related_decisions_with_versions_and_rationale}}
|
||||
|
||||
### API & Communication Patterns
|
||||
|
||||
{{api_related_decisions_with_versions_and_rationale}}
|
||||
|
||||
### Frontend Architecture
|
||||
|
||||
{{frontend_related_decisions_with_versions_and_rationale}}
|
||||
|
||||
### Infrastructure & Deployment
|
||||
|
||||
{{infrastructure_related_decisions_with_versions_and_rationale}}
|
||||
|
||||
### Decision Impact Analysis
|
||||
|
||||
**Implementation Sequence:**
|
||||
{{ordered_list_of_decisions_for_implementation}}
|
||||
|
||||
**Cross-Component Dependencies:**
|
||||
{{how_decisions_affect_each_other}}
|
||||
```
|
||||
|
||||
### 6. Present Content and Menu
|
||||
|
||||
Show the generated decisions content and present choices:
|
||||
|
||||
"I've documented all the core architectural decisions we've made together.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 5]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Explore innovative approaches to any specific decisions
|
||||
[P] Party Mode - Review decisions from multiple perspectives
|
||||
[C] Continue - Save these decisions and move to implementation patterns"
|
||||
|
||||
### 7. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Invoke the `bmad-advanced-elicitation` skill with specific decision categories
|
||||
- Process enhanced insights about particular decisions
|
||||
- Ask user: "Accept these enhancements to the architectural decisions? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Invoke the `bmad-party-mode` skill with architectural decisions context
|
||||
- Process collaborative insights about decision trade-offs
|
||||
- Ask user: "Accept these changes to the architectural decisions? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Load `./step-05-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 5.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ All critical architectural decisions made collaboratively
|
||||
✅ Technology versions verified using web search
|
||||
✅ Decision rationale clearly documented
|
||||
✅ Cascading implications identified and addressed
|
||||
✅ User provided appropriate level of explanation for skill level
|
||||
✅ A/P/C menu presented and handled correctly for each category
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Making recommendations instead of facilitating decisions
|
||||
❌ Not verifying technology versions with web search
|
||||
❌ Missing cascading implications between decisions
|
||||
❌ Not adapting explanations to user skill level
|
||||
❌ Forgetting to document decisions made by starter template
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-patterns.md` to define implementation patterns that ensure consistency across AI agents.
|
||||
|
||||
Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
|
@ -1,359 +0,0 @@
|
|||
# Step 5: Implementation Patterns & Consistency Rules
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on patterns that prevent AI agent implementation conflicts
|
||||
- 🎯 EMPHASIZE what agents could decide DIFFERENTLY if not specified
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 🎯 Focus on consistency, not implementation details
|
||||
- ⚠️ Present A/P/C menu after generating patterns content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop comprehensive consistency patterns
|
||||
- **P (Party Mode)**: Bring multiple perspectives to identify potential conflict points
|
||||
- **C (Continue)**: Save the patterns and proceed to project structure
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Invoke the `bmad-advanced-elicitation` skill
|
||||
- When 'P' selected: Invoke the `bmad-party-mode` skill
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Core architectural decisions from step 4 are complete
|
||||
- Technology stack is decided and versions are verified
|
||||
- Focus on HOW agents should implement, not WHAT they should implement
|
||||
- Consider what could vary between different AI agents
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Define implementation patterns and consistency rules that ensure multiple AI agents write compatible, consistent code that works together seamlessly.
|
||||
|
||||
## PATTERNS DEFINITION SEQUENCE:
|
||||
|
||||
### 1. Identify Potential Conflict Points
|
||||
|
||||
Based on the chosen technology stack and decisions, identify where AI agents could make different choices:
|
||||
|
||||
**Naming Conflicts:**
|
||||
|
||||
- Database table/column naming conventions
|
||||
- API endpoint naming patterns
|
||||
- File and directory naming
|
||||
- Component/function/variable naming
|
||||
- Route parameter formats
|
||||
|
||||
**Structural Conflicts:**
|
||||
|
||||
- Where tests are located
|
||||
- How components are organized
|
||||
- Where utilities and helpers go
|
||||
- Configuration file organization
|
||||
- Static asset organization
|
||||
|
||||
**Format Conflicts:**
|
||||
|
||||
- API response wrapper formats
|
||||
- Error response structures
|
||||
- Date/time formats in APIs and UI
|
||||
- JSON field naming conventions
|
||||
- API status code usage
|
||||
|
||||
**Communication Conflicts:**
|
||||
|
||||
- Event naming conventions
|
||||
- Event payload structures
|
||||
- State update patterns
|
||||
- Action naming conventions
|
||||
- Logging formats and levels
|
||||
|
||||
**Process Conflicts:**
|
||||
|
||||
- Loading state handling
|
||||
- Error recovery patterns
|
||||
- Retry implementation approaches
|
||||
- Authentication flow patterns
|
||||
- Validation timing and methods
|
||||
|
||||
### 2. Facilitate Pattern Decisions
|
||||
|
||||
For each conflict category, facilitate collaborative pattern definition:
|
||||
|
||||
**Present the Conflict Point:**
|
||||
"Given that we're using {{tech_stack}}, different AI agents might handle {{conflict_area}} differently.
|
||||
|
||||
For example, one agent might name database tables 'users' while another uses 'Users' - this would cause conflicts.
|
||||
|
||||
We need to establish consistent patterns that all agents follow."
|
||||
|
||||
**Show Options and Trade-offs:**
|
||||
"Common approaches for {{pattern_category}}:
|
||||
|
||||
1. {{option_1}} - {{pros_and_cons}}
|
||||
2. {{option_2}} - {{pros_and_cons}}
|
||||
3. {{option_3}} - {{pros_and_cons}}
|
||||
|
||||
Which approach makes the most sense for our project?"
|
||||
|
||||
**Get User Decision:**
|
||||
"What's your preference for this pattern? (or discuss the trade-offs more)"
|
||||
|
||||
### 3. Define Pattern Categories
|
||||
|
||||
#### Naming Patterns
|
||||
|
||||
**Database Naming:**
|
||||
|
||||
- Table naming: users, Users, or user?
|
||||
- Column naming: user_id or userId?
|
||||
- Foreign key format: user_id or fk_user?
|
||||
- Index naming: idx_users_email or users_email_index?
|
||||
|
||||
**API Naming:**
|
||||
|
||||
- REST endpoint naming: /users or /user? Plural or singular?
|
||||
- Route parameter format: :id or {id}?
|
||||
- Query parameter naming: user_id or userId?
|
||||
- Header naming conventions: X-Custom-Header or Custom-Header?
|
||||
|
||||
**Code Naming:**
|
||||
|
||||
- Component naming: UserCard or user-card?
|
||||
- File naming: UserCard.tsx or user-card.tsx?
|
||||
- Function naming: getUserData or get_user_data?
|
||||
- Variable naming: userId or user_id?
|
||||
|
||||
#### Structure Patterns
|
||||
|
||||
**Project Organization:**
|
||||
|
||||
- Where do tests live? **tests**/ or \*.test.ts co-located?
|
||||
- How are components organized? By feature or by type?
|
||||
- Where do shared utilities go?
|
||||
- How are services and repositories organized?
|
||||
|
||||
**File Structure:**
|
||||
|
||||
- Config file locations and naming
|
||||
- Static asset organization
|
||||
- Documentation placement
|
||||
- Environment file organization
|
||||
|
||||
#### Format Patterns
|
||||
|
||||
**API Formats:**
|
||||
|
||||
- API response wrapper? {data: ..., error: ...} or direct response?
|
||||
- Error format? {message, code} or {error: {type, detail}}?
|
||||
- Date format in JSON? ISO strings or timestamps?
|
||||
- Success response structure?
|
||||
|
||||
**Data Formats:**
|
||||
|
||||
- JSON field naming: snake_case or camelCase?
|
||||
- Boolean representations: true/false or 1/0?
|
||||
- Null handling patterns
|
||||
- Array vs object for single items
|
||||
|
||||
#### Communication Patterns
|
||||
|
||||
**Event Systems:**
|
||||
|
||||
- Event naming convention: user.created or UserCreated?
|
||||
- Event payload structure standards
|
||||
- Event versioning approach
|
||||
- Async event handling patterns
|
||||
|
||||
**State Management:**
|
||||
|
||||
- State update patterns: immutable updates or direct mutation?
|
||||
- Action naming conventions
|
||||
- Selector patterns
|
||||
- State organization principles
|
||||
|
||||
#### Process Patterns
|
||||
|
||||
**Error Handling:**
|
||||
|
||||
- Global error handling approach
|
||||
- Error boundary patterns
|
||||
- User-facing error message format
|
||||
- Logging vs user error distinction
|
||||
|
||||
**Loading States:**
|
||||
|
||||
- Loading state naming conventions
|
||||
- Global vs local loading states
|
||||
- Loading state persistence
|
||||
- Loading UI patterns
|
||||
|
||||
### 4. Generate Patterns Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
```markdown
|
||||
## Implementation Patterns & Consistency Rules
|
||||
|
||||
### Pattern Categories Defined
|
||||
|
||||
**Critical Conflict Points Identified:**
|
||||
{{number_of_potential_conflicts}} areas where AI agents could make different choices
|
||||
|
||||
### Naming Patterns
|
||||
|
||||
**Database Naming Conventions:**
|
||||
{{database_naming_rules_with_examples}}
|
||||
|
||||
**API Naming Conventions:**
|
||||
{{api_naming_rules_with_examples}}
|
||||
|
||||
**Code Naming Conventions:**
|
||||
{{code_naming_rules_with_examples}}
|
||||
|
||||
### Structure Patterns
|
||||
|
||||
**Project Organization:**
|
||||
{{project_structure_rules_with_examples}}
|
||||
|
||||
**File Structure Patterns:**
|
||||
{{file_organization_rules_with_examples}}
|
||||
|
||||
### Format Patterns
|
||||
|
||||
**API Response Formats:**
|
||||
{{api_response_structure_rules}}
|
||||
|
||||
**Data Exchange Formats:**
|
||||
{{data_format_rules_with_examples}}
|
||||
|
||||
### Communication Patterns
|
||||
|
||||
**Event System Patterns:**
|
||||
{{event_naming_and_structure_rules}}
|
||||
|
||||
**State Management Patterns:**
|
||||
{{state_update_and_organization_rules}}
|
||||
|
||||
### Process Patterns
|
||||
|
||||
**Error Handling Patterns:**
|
||||
{{consistent_error_handling_approaches}}
|
||||
|
||||
**Loading State Patterns:**
|
||||
{{loading_state_management_rules}}
|
||||
|
||||
### Enforcement Guidelines
|
||||
|
||||
**All AI Agents MUST:**
|
||||
|
||||
- {{mandatory_pattern_1}}
|
||||
- {{mandatory_pattern_2}}
|
||||
- {{mandatory_pattern_3}}
|
||||
|
||||
**Pattern Enforcement:**
|
||||
|
||||
- How to verify patterns are followed
|
||||
- Where to document pattern violations
|
||||
- Process for updating patterns
|
||||
|
||||
### Pattern Examples
|
||||
|
||||
**Good Examples:**
|
||||
{{concrete_examples_of_correct_pattern_usage}}
|
||||
|
||||
**Anti-Patterns:**
|
||||
{{examples_of_what_to_avoid}}
|
||||
```
|
||||
|
||||
### 5. Present Content and Menu
|
||||
|
||||
Show the generated patterns content and present choices:
|
||||
|
||||
"I've documented implementation patterns that will prevent conflicts between AI agents working on this project.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 4]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Explore additional consistency patterns
|
||||
[P] Party Mode - Review patterns from different implementation perspectives
|
||||
[C] Continue - Save these patterns and move to project structure"
|
||||
|
||||
### 6. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Invoke the `bmad-advanced-elicitation` skill with current patterns
|
||||
- Process enhanced consistency rules that come back
|
||||
- Ask user: "Accept these additional pattern refinements? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Invoke the `bmad-party-mode` skill with implementation patterns context
|
||||
- Process collaborative insights about potential conflicts
|
||||
- Ask user: "Accept these changes to the implementation patterns? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Load `./step-06-structure.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 4.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ All potential AI agent conflict points identified and addressed
|
||||
✅ Comprehensive patterns defined for naming, structure, and communication
|
||||
✅ Concrete examples provided for each pattern
|
||||
✅ Enforcement guidelines clearly documented
|
||||
✅ User collaborated on pattern decisions rather than receiving recommendations
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Missing potential conflict points that could cause agent conflicts
|
||||
❌ Being too prescriptive about implementation details instead of focusing on consistency
|
||||
❌ Not providing concrete examples for each pattern
|
||||
❌ Failing to address cross-cutting concerns like error handling
|
||||
❌ Not considering the chosen technology stack when defining patterns
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-06-structure.md` to define the complete project structure.
|
||||
|
||||
Remember: Do NOT proceed to step-06 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
|
@ -1,379 +0,0 @@
|
|||
# Step 6: Project Structure & Boundaries
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on defining complete project structure and clear boundaries
|
||||
- 🗺️ MAP requirements/epics to architectural components
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 🗺️ Create complete project tree, not generic placeholders
|
||||
- ⚠️ Present A/P/C menu after generating project structure
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to explore innovative project organization approaches
|
||||
- **P (Party Mode)**: Bring multiple perspectives to evaluate project structure trade-offs
|
||||
- **C (Continue)**: Save the project structure and proceed to validation
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Invoke the `bmad-advanced-elicitation` skill
|
||||
- When 'P' selected: Invoke the `bmad-party-mode` skill
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- All previous architectural decisions are complete
|
||||
- Implementation patterns and consistency rules are defined
|
||||
- Focus on physical project structure and component boundaries
|
||||
- Map requirements to specific files and directories
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Define the complete project structure and architectural boundaries based on all decisions made, creating a concrete implementation guide for AI agents.
|
||||
|
||||
## PROJECT STRUCTURE SEQUENCE:
|
||||
|
||||
### 1. Analyze Requirements Mapping
|
||||
|
||||
Map project requirements to architectural components:
|
||||
|
||||
**From Epics (if available):**
|
||||
"Epic: {{epic_name}} → Lives in {{module/directory/service}}"
|
||||
|
||||
- User stories within the epic
|
||||
- Cross-epic dependencies
|
||||
- Shared components needed
|
||||
|
||||
**From FR Categories (if no epics):**
|
||||
"FR Category: {{fr_category_name}} → Lives in {{module/directory/service}}"
|
||||
|
||||
- Related functional requirements
|
||||
- Shared functionality across categories
|
||||
- Integration points between categories
|
||||
|
||||
### 2. Define Project Directory Structure
|
||||
|
||||
Based on technology stack and patterns, create the complete project structure:
|
||||
|
||||
**Root Configuration Files:**
|
||||
|
||||
- Package management files (package.json, requirements.txt, etc.)
|
||||
- Build and development configuration
|
||||
- Environment configuration files
|
||||
- CI/CD pipeline files
|
||||
- Documentation files
|
||||
|
||||
**Source Code Organization:**
|
||||
|
||||
- Application entry points
|
||||
- Core application structure
|
||||
- Feature/module organization
|
||||
- Shared utilities and libraries
|
||||
- Configuration and environment files
|
||||
|
||||
**Test Organization:**
|
||||
|
||||
- Unit test locations and structure
|
||||
- Integration test organization
|
||||
- End-to-end test structure
|
||||
- Test utilities and fixtures
|
||||
|
||||
**Build and Distribution:**
|
||||
|
||||
- Build output directories
|
||||
- Distribution files
|
||||
- Static assets
|
||||
- Documentation build
|
||||
|
||||
### 3. Define Integration Boundaries
|
||||
|
||||
Map how components communicate and where boundaries exist:
|
||||
|
||||
**API Boundaries:**
|
||||
|
||||
- External API endpoints
|
||||
- Internal service boundaries
|
||||
- Authentication and authorization boundaries
|
||||
- Data access layer boundaries
|
||||
|
||||
**Component Boundaries:**
|
||||
|
||||
- Frontend component communication patterns
|
||||
- State management boundaries
|
||||
- Service communication patterns
|
||||
- Event-driven integration points
|
||||
|
||||
**Data Boundaries:**
|
||||
|
||||
- Database schema boundaries
|
||||
- Data access patterns
|
||||
- Caching boundaries
|
||||
- External data integration points
|
||||
|
||||
### 4. Create Complete Project Tree
|
||||
|
||||
Generate a comprehensive directory structure showing all files and directories:
|
||||
|
||||
**Technology-Specific Structure Examples:**
|
||||
|
||||
**Next.js Full-Stack:**
|
||||
|
||||
```
|
||||
project-name/
|
||||
├── README.md
|
||||
├── package.json
|
||||
├── next.config.js
|
||||
├── tailwind.config.js
|
||||
├── tsconfig.json
|
||||
├── .env.local
|
||||
├── .env.example
|
||||
├── .gitignore
|
||||
├── .github/
|
||||
│ └── workflows/
|
||||
│ └── ci.yml
|
||||
├── src/
|
||||
│ ├── app/
|
||||
│ │ ├── globals.css
|
||||
│ │ ├── layout.tsx
|
||||
│ │ └── page.tsx
|
||||
│ ├── components/
|
||||
│ │ ├── ui/
|
||||
│ │ ├── forms/
|
||||
│ │ └── features/
|
||||
│ ├── lib/
|
||||
│ │ ├── db.ts
|
||||
│ │ ├── auth.ts
|
||||
│ │ └── utils.ts
|
||||
│ ├── types/
|
||||
│ └── middleware.ts
|
||||
├── prisma/
|
||||
│ ├── schema.prisma
|
||||
│ └── migrations/
|
||||
├── tests/
|
||||
│ ├── __mocks__/
|
||||
│ ├── components/
|
||||
│ └── e2e/
|
||||
└── public/
|
||||
└── assets/
|
||||
```
|
||||
|
||||
**API Backend (NestJS):**
|
||||
|
||||
```
|
||||
project-name/
|
||||
├── package.json
|
||||
├── nest-cli.json
|
||||
├── tsconfig.json
|
||||
├── .env
|
||||
├── .env.example
|
||||
├── .gitignore
|
||||
├── README.md
|
||||
├── src/
|
||||
│ ├── main.ts
|
||||
│ ├── app.module.ts
|
||||
│ ├── config/
|
||||
│ ├── modules/
|
||||
│ │ ├── auth/
|
||||
│ │ ├── users/
|
||||
│ │ └── common/
|
||||
│ ├── services/
|
||||
│ ├── repositories/
|
||||
│ ├── decorators/
|
||||
│ ├── pipes/
|
||||
│ ├── guards/
|
||||
│ └── interceptors/
|
||||
├── test/
|
||||
│ ├── unit/
|
||||
│ ├── integration/
|
||||
│ └── e2e/
|
||||
├── prisma/
|
||||
│ ├── schema.prisma
|
||||
│ └── migrations/
|
||||
└── docker-compose.yml
|
||||
```
|
||||
|
||||
### 5. Map Requirements to Structure
|
||||
|
||||
Create explicit mapping from project requirements to specific files/directories:
|
||||
|
||||
**Epic/Feature Mapping:**
|
||||
"Epic: User Management
|
||||
|
||||
- Components: src/components/features/users/
|
||||
- Services: src/services/users/
|
||||
- API Routes: src/app/api/users/
|
||||
- Database: prisma/migrations/_*users*_
|
||||
- Tests: tests/features/users/"
|
||||
|
||||
**Cross-Cutting Concerns:**
|
||||
"Authentication System
|
||||
|
||||
- Components: src/components/auth/
|
||||
- Services: src/services/auth/
|
||||
- Middleware: src/middleware/auth.ts
|
||||
- Guards: src/guards/auth.guard.ts
|
||||
- Tests: tests/auth/"
|
||||
|
||||
### 6. Generate Structure Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
```markdown
|
||||
## Project Structure & Boundaries
|
||||
|
||||
### Complete Project Directory Structure
|
||||
```
|
||||
|
||||
{{complete_project_tree_with_all_files_and_directories}}
|
||||
|
||||
```
|
||||
|
||||
### Architectural Boundaries
|
||||
|
||||
**API Boundaries:**
|
||||
{{api_boundary_definitions_and_endpoints}}
|
||||
|
||||
**Component Boundaries:**
|
||||
{{component_communication_patterns_and_boundaries}}
|
||||
|
||||
**Service Boundaries:**
|
||||
{{service_integration_patterns_and_boundaries}}
|
||||
|
||||
**Data Boundaries:**
|
||||
{{data_access_patterns_and_boundaries}}
|
||||
|
||||
### Requirements to Structure Mapping
|
||||
|
||||
**Feature/Epic Mapping:**
|
||||
{{mapping_of_epics_or_features_to_specific_directories}}
|
||||
|
||||
**Cross-Cutting Concerns:**
|
||||
{{mapping_of_shared_functionality_to_locations}}
|
||||
|
||||
### Integration Points
|
||||
|
||||
**Internal Communication:**
|
||||
{{how_components_within_the_project_communicate}}
|
||||
|
||||
**External Integrations:**
|
||||
{{third_party_service_integration_points}}
|
||||
|
||||
**Data Flow:**
|
||||
{{how_data_flows_through_the_architecture}}
|
||||
|
||||
### File Organization Patterns
|
||||
|
||||
**Configuration Files:**
|
||||
{{where_and_how_config_files_are_organized}}
|
||||
|
||||
**Source Organization:**
|
||||
{{how_source_code_is_structured_and_organized}}
|
||||
|
||||
**Test Organization:**
|
||||
{{how_tests_are_structured_and_organized}}
|
||||
|
||||
**Asset Organization:**
|
||||
{{how_static_and_dynamic_assets_are_organized}}
|
||||
|
||||
### Development Workflow Integration
|
||||
|
||||
**Development Server Structure:**
|
||||
{{how_the_project_is organized_for_development}}
|
||||
|
||||
**Build Process Structure:**
|
||||
{{how_the_build_process_uses_the_project_structure}}
|
||||
|
||||
**Deployment Structure:**
|
||||
{{how_the_project_structure_supports_deployment}}
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated project structure content and present choices:
|
||||
|
||||
"I've created a complete project structure based on all our architectural decisions.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Explore innovative project organization approaches
|
||||
[P] Party Mode - Review structure from different development perspectives
|
||||
[C] Continue - Save this structure and move to architecture validation"
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Invoke the `bmad-advanced-elicitation` skill with current project structure
|
||||
- Process enhanced organizational insights that come back
|
||||
- Ask user: "Accept these changes to the project structure? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Invoke the `bmad-party-mode` skill with project structure context
|
||||
- Process collaborative insights about organization trade-offs
|
||||
- Ask user: "Accept these changes to the project structure? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]`
|
||||
- Load `./step-07-validation.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Complete project tree defined with all files and directories
|
||||
✅ All architectural boundaries clearly documented
|
||||
✅ Requirements/epics mapped to specific locations
|
||||
✅ Integration points and communication patterns defined
|
||||
✅ Project structure aligned with chosen technology stack
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Creating generic placeholder structure instead of specific, complete tree
|
||||
❌ Not mapping requirements to specific files and directories
|
||||
❌ Missing important integration boundaries
|
||||
❌ Not considering the chosen technology stack in structure design
|
||||
❌ Not defining how components communicate across boundaries
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-07-validation.md` to validate architectural coherence and completeness.
|
||||
|
||||
Remember: Do NOT proceed to step-07 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
|
@ -1,361 +0,0 @@
|
|||
# Step 7: Architecture Validation & Completion
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on validating architectural coherence and completeness
|
||||
- ✅ VALIDATE all requirements are covered by architectural decisions
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ✅ Run comprehensive validation checks on the complete architecture
|
||||
- ⚠️ Present A/P/C menu after generating validation results
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to address complex architectural issues found during validation
|
||||
- **P (Party Mode)**: Bring multiple perspectives to resolve validation concerns
|
||||
- **C (Continue)**: Save the validation results and complete the architecture
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Invoke the `bmad-advanced-elicitation` skill
|
||||
- When 'P' selected: Invoke the `bmad-party-mode` skill
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Complete architecture document with all sections is available
|
||||
- All architectural decisions, patterns, and structure are defined
|
||||
- Focus on validation, gap analysis, and coherence checking
|
||||
- Prepare for handoff to implementation phase
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Validate the complete architecture for coherence, completeness, and readiness to guide AI agents through consistent implementation.
|
||||
|
||||
## VALIDATION SEQUENCE:
|
||||
|
||||
### 1. Coherence Validation
|
||||
|
||||
Check that all architectural decisions work together:
|
||||
|
||||
**Decision Compatibility:**
|
||||
|
||||
- Do all technology choices work together without conflicts?
|
||||
- Are all versions compatible with each other?
|
||||
- Do patterns align with technology choices?
|
||||
- Are there any contradictory decisions?
|
||||
|
||||
**Pattern Consistency:**
|
||||
|
||||
- Do implementation patterns support the architectural decisions?
|
||||
- Are naming conventions consistent across all areas?
|
||||
- Do structure patterns align with technology stack?
|
||||
- Are communication patterns coherent?
|
||||
|
||||
**Structure Alignment:**
|
||||
|
||||
- Does the project structure support all architectural decisions?
|
||||
- Are boundaries properly defined and respected?
|
||||
- Does the structure enable the chosen patterns?
|
||||
- Are integration points properly structured?
|
||||
|
||||
### 2. Requirements Coverage Validation
|
||||
|
||||
Verify all project requirements are architecturally supported:
|
||||
|
||||
**From Epics (if available):**
|
||||
|
||||
- Does every epic have architectural support?
|
||||
- Are all user stories implementable with these decisions?
|
||||
- Are cross-epic dependencies handled architecturally?
|
||||
- Are there any gaps in epic coverage?
|
||||
|
||||
**From FR Categories (if no epics):**
|
||||
|
||||
- Does every functional requirement have architectural support?
|
||||
- Are all FR categories fully covered by architectural decisions?
|
||||
- Are cross-cutting FRs properly addressed?
|
||||
- Are there any missing architectural capabilities?
|
||||
|
||||
**Non-Functional Requirements:**
|
||||
|
||||
- Are performance requirements addressed architecturally?
|
||||
- Are security requirements fully covered?
|
||||
- Are scalability considerations properly handled?
|
||||
- Are compliance requirements architecturally supported?
|
||||
|
||||
### 3. Implementation Readiness Validation
|
||||
|
||||
Assess if AI agents can implement consistently:
|
||||
|
||||
**Decision Completeness:**
|
||||
|
||||
- Are all critical decisions documented with versions?
|
||||
- Are implementation patterns comprehensive enough?
|
||||
- Are consistency rules clear and enforceable?
|
||||
- Are examples provided for all major patterns?
|
||||
|
||||
**Structure Completeness:**
|
||||
|
||||
- Is the project structure complete and specific?
|
||||
- Are all files and directories defined?
|
||||
- Are integration points clearly specified?
|
||||
- Are component boundaries well-defined?
|
||||
|
||||
**Pattern Completeness:**
|
||||
|
||||
- Are all potential conflict points addressed?
|
||||
- Are naming conventions comprehensive?
|
||||
- Are communication patterns fully specified?
|
||||
- Are process patterns (error handling, etc.) complete?
|
||||
|
||||
### 4. Gap Analysis
|
||||
|
||||
Identify and document any missing elements:
|
||||
|
||||
**Critical Gaps:**
|
||||
|
||||
- Missing architectural decisions that block implementation
|
||||
- Incomplete patterns that could cause conflicts
|
||||
- Missing structural elements needed for development
|
||||
- Undefined integration points
|
||||
|
||||
**Important Gaps:**
|
||||
|
||||
- Areas that need more detailed specification
|
||||
- Patterns that could be more comprehensive
|
||||
- Documentation that would help implementation
|
||||
- Examples that would clarify complex decisions
|
||||
|
||||
**Nice-to-Have Gaps:**
|
||||
|
||||
- Additional patterns that would be helpful
|
||||
- Supplementary documentation
|
||||
- Tooling recommendations
|
||||
- Development workflow optimizations
|
||||
|
||||
### 5. Address Validation Issues
|
||||
|
||||
For any issues found, facilitate resolution:
|
||||
|
||||
**Critical Issues:**
|
||||
"I found some issues that need to be addressed before implementation:
|
||||
|
||||
{{critical_issue_description}}
|
||||
|
||||
These could cause implementation problems. How would you like to resolve this?"
|
||||
|
||||
**Important Issues:**
|
||||
"I noticed a few areas that could be improved:
|
||||
|
||||
{{important_issue_description}}
|
||||
|
||||
These aren't blocking, but addressing them would make implementation smoother. Should we work on these?"
|
||||
|
||||
**Minor Issues:**
|
||||
"Here are some minor suggestions for improvement:
|
||||
|
||||
{{minor_issue_description}}
|
||||
|
||||
These are optional refinements. Would you like to address any of these?"
|
||||
|
||||
### 6. Generate Validation Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
```markdown
|
||||
## Architecture Validation Results
|
||||
|
||||
### Coherence Validation ✅
|
||||
|
||||
**Decision Compatibility:**
|
||||
{{assessment_of_how_all_decisions_work_together}}
|
||||
|
||||
**Pattern Consistency:**
|
||||
{{verification_that_patterns_support_decisions}}
|
||||
|
||||
**Structure Alignment:**
|
||||
{{confirmation_that_structure_supports_architecture}}
|
||||
|
||||
### Requirements Coverage Validation ✅
|
||||
|
||||
**Epic/Feature Coverage:**
|
||||
{{verification_that_all_epics_or_features_are_supported}}
|
||||
|
||||
**Functional Requirements Coverage:**
|
||||
{{confirmation_that_all_FRs_are_architecturally_supported}}
|
||||
|
||||
**Non-Functional Requirements Coverage:**
|
||||
{{verification_that_NFRs_are_addressed}}
|
||||
|
||||
### Implementation Readiness Validation ✅
|
||||
|
||||
**Decision Completeness:**
|
||||
{{assessment_of_decision_documentation_completeness}}
|
||||
|
||||
**Structure Completeness:**
|
||||
{{evaluation_of_project_structure_completeness}}
|
||||
|
||||
**Pattern Completeness:**
|
||||
{{verification_of_implementation_patterns_completeness}}
|
||||
|
||||
### Gap Analysis Results
|
||||
|
||||
{{gap_analysis_findings_with_priority_levels}}
|
||||
|
||||
### Validation Issues Addressed
|
||||
|
||||
{{description_of_any_issues_found_and_resolutions}}
|
||||
|
||||
### Architecture Completeness Checklist
|
||||
|
||||
Mark each item `[x]` only if validation confirms it; leave `[ ]` if it is missing, partial, or unverified. Any unchecked item must be reflected in the Gap Analysis above and in the Overall Status below.
|
||||
|
||||
**Requirements Analysis**
|
||||
|
||||
- [ ] Project context thoroughly analyzed
|
||||
- [ ] Scale and complexity assessed
|
||||
- [ ] Technical constraints identified
|
||||
- [ ] Cross-cutting concerns mapped
|
||||
|
||||
**Architectural Decisions**
|
||||
|
||||
- [ ] Critical decisions documented with versions
|
||||
- [ ] Technology stack fully specified
|
||||
- [ ] Integration patterns defined
|
||||
- [ ] Performance considerations addressed
|
||||
|
||||
**Implementation Patterns**
|
||||
|
||||
- [ ] Naming conventions established
|
||||
- [ ] Structure patterns defined
|
||||
- [ ] Communication patterns specified
|
||||
- [ ] Process patterns documented
|
||||
|
||||
**Project Structure**
|
||||
|
||||
- [ ] Complete directory structure defined
|
||||
- [ ] Component boundaries established
|
||||
- [ ] Integration points mapped
|
||||
- [ ] Requirements to structure mapping complete
|
||||
|
||||
### Architecture Readiness Assessment
|
||||
|
||||
**Overall Status:** {{READY FOR IMPLEMENTATION | READY WITH MINOR GAPS | NOT READY}} (choose READY FOR IMPLEMENTATION only when all 16 checklist items are `[x]` and no Critical Gaps remain; choose NOT READY when any Critical Gap is open or any Requirements Analysis or Architectural Decisions item is unchecked; otherwise READY WITH MINOR GAPS)
|
||||
|
||||
**Confidence Level:** {{high/medium/low}} based on validation results
|
||||
|
||||
**Key Strengths:**
|
||||
{{list_of_architecture_strengths}}
|
||||
|
||||
**Areas for Future Enhancement:**
|
||||
{{areas_that_could_be_improved_later}}
|
||||
|
||||
### Implementation Handoff
|
||||
|
||||
**AI Agent Guidelines:**
|
||||
|
||||
- Follow all architectural decisions exactly as documented
|
||||
- Use implementation patterns consistently across all components
|
||||
- Respect project structure and boundaries
|
||||
- Refer to this document for all architectural questions
|
||||
|
||||
**First Implementation Priority:**
|
||||
{{starter_template_command_or_first_architectural_step}}
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the validation results and present choices:
|
||||
|
||||
"I've completed a comprehensive validation of your architecture.
|
||||
|
||||
**Validation Summary:**
|
||||
|
||||
- ✅ Coherence: All decisions work together
|
||||
- ✅ Coverage: All requirements are supported
|
||||
- ✅ Readiness: AI agents can implement consistently
|
||||
|
||||
**Here's what I'll add to complete the architecture document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Address any complex architectural concerns
|
||||
[P] Party Mode - Review validation from different implementation perspectives
|
||||
[C] Continue - Complete the architecture and finish workflow
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Invoke the `bmad-advanced-elicitation` skill with validation issues
|
||||
- Process enhanced solutions for complex concerns
|
||||
- Ask user: "Accept these architectural improvements? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Invoke the `bmad-party-mode` skill with validation context
|
||||
- Process collaborative insights on implementation readiness
|
||||
- Ask user: "Accept these changes to the validation results? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]`
|
||||
- Load `./step-08-complete.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ All architectural decisions validated for coherence
|
||||
✅ Complete requirements coverage verified
|
||||
✅ Implementation readiness confirmed
|
||||
✅ All gaps identified and addressed
|
||||
✅ Comprehensive validation checklist completed
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Skipping validation of decision compatibility
|
||||
❌ Not verifying all requirements are architecturally supported
|
||||
❌ Missing potential implementation conflicts
|
||||
❌ Not addressing gaps found during validation
|
||||
❌ Providing incomplete validation checklist
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-08-complete.md` to complete the workflow and provide implementation guidance.
|
||||
|
||||
Remember: Do NOT proceed to step-08 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
|
@ -1,82 +0,0 @@
|
|||
# Step 8: Architecture Completion & Handoff
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- ✅ ALWAYS treat this as collaborative completion between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on successful workflow completion and implementation handoff
|
||||
- 🎯 PROVIDE clear next steps for implementation phase
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 🎯 Present completion summary and implementation guidance
|
||||
- 📖 Update frontmatter with final workflow state
|
||||
- 🚫 THIS IS THE FINAL STEP IN THIS WORKFLOW
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Complete the architecture workflow, provide a comprehensive completion summary, and guide the user to the next phase of their project development.
|
||||
|
||||
## COMPLETION SEQUENCE:
|
||||
|
||||
### 1. Congratulate the User on Completion
|
||||
|
||||
Both you and the User completed something amazing here - give a summary of what you achieved together and really congratulate the user on a job well done.
|
||||
|
||||
### 2. Update the created document's frontmatter
|
||||
|
||||
```yaml
|
||||
stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]
|
||||
workflowType: 'architecture'
|
||||
lastStep: 8
|
||||
status: 'complete'
|
||||
completedAt: '{{current_date}}'
|
||||
```
|
||||
|
||||
### 3. Next Steps Guidance
|
||||
|
||||
Architecture complete. Invoke the `bmad-help` skill.
|
||||
|
||||
Upon Completion of task output: offer to answer any questions about the Architecture Document.
|
||||
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Complete architecture document delivered with all sections
|
||||
✅ All architectural decisions documented and validated
|
||||
✅ Implementation patterns and consistency rules finalized
|
||||
✅ Project structure complete with all files and directories
|
||||
✅ User provided with clear next steps and implementation guidance
|
||||
✅ Workflow status properly updated
|
||||
✅ User collaboration maintained throughout completion process
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not providing clear implementation guidance
|
||||
❌ Missing final validation of document completeness
|
||||
❌ Not updating workflow status appropriately
|
||||
❌ Failing to celebrate the successful completion
|
||||
❌ Not providing specific next steps for the user
|
||||
❌ Rushing completion without proper summary
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## WORKFLOW COMPLETE:
|
||||
|
||||
This is the final step of the Architecture workflow. The user now has a complete, validated architecture document ready for AI agent implementation.
|
||||
|
||||
The architecture will serve as the single source of truth for all technical decisions, ensuring consistent implementation across the entire project development lifecycle.
|
||||
|
||||
## On Complete
|
||||
|
||||
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||
|
||||
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||
|
|
@ -17,8 +17,8 @@ BMad Method,bmad-product-brief,Create Brief,CB,An expert guided experience to na
|
|||
BMad Method,bmad-prfaq,PRFAQ Challenge,WB,Working Backwards guided experience to forge and stress-test your product concept to ensure you have a great product that users will love and need through the PRFAQ gauntlet to determine feasibility and alignment with user needs. alternative to product brief.,,-H,1-analysis,,,false,planning_artifacts,prfaq document
|
||||
BMad Method,bmad-prd,Create Edit and Review PRD,PRD,"Facilitated PRD workflow — create a new PRD via coached discovery, update an existing one against a change signal, or validate a finished PRD against a checklist with an HTML findings report.",,,2-planning,bmad-product-brief,,true,planning_artifacts,prd
|
||||
BMad Method,bmad-ux,Create UX,CU,"Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project.",,,2-planning,bmad-prd,,false,planning_artifacts,ux design
|
||||
BMad Method,bmad-create-architecture,Create Architecture,CA,Guided workflow to document technical decisions.,,,3-solutioning,,,true,planning_artifacts,architecture
|
||||
BMad Method,bmad-create-epics-and-stories,Create Epics and Stories,CE,,,,3-solutioning,bmad-create-architecture,,true,planning_artifacts,epics and stories
|
||||
BMad Method,bmad-architecture,Architecture,CA,Offer once requirements exist (a PRD or spec; plus UX if present) and the user is ready to move from what to how. Also offer any time independently-built parts risk diverging. Produces the architecture spine: the invariants that keep features epics and stories consistent. Comes before epics and stories and scales from a quick spine to a full architecture (brownfield: ratifies the existing codebase).,,,3-solutioning,,,true,planning_artifacts,architecture
|
||||
BMad Method,bmad-create-epics-and-stories,Create Epics and Stories,CE,,,,3-solutioning,bmad-architecture,,true,planning_artifacts,epics and stories
|
||||
BMad Method,bmad-check-implementation-readiness,Check Implementation Readiness,IR,Ensure PRD UX Architecture and Epics Stories are aligned.,,,3-solutioning,bmad-create-epics-and-stories,,true,planning_artifacts,readiness report
|
||||
BMad Method,bmad-sprint-planning,Sprint Planning,SP,Kicks off implementation by producing a plan the implementation agents will follow in sequence for every story.,,,4-implementation,,,true,implementation_artifacts,sprint status
|
||||
BMad Method,bmad-sprint-status,Sprint Status,SS,Anytime: Summarize sprint status and route to next workflow.,,,4-implementation,bmad-sprint-planning,,false,,
|
||||
|
|
|
|||
|
|
|
@ -69,6 +69,8 @@ When the input is structured and pre-sorted (a PRD with an addendum, a GDD, a br
|
|||
|
||||
Distill the input into the five-field kernel using `{workflow.spec_template}` as the skeleton. When input is rich, extract directly — no elicitation. When input is sparse, choose: **express** (best-effort distill, every gap becomes an `open_questions[]` entry) or **guided** (walk the five fields with the user one at a time). Headless defaults to express and logs the choice. Interactive asks.
|
||||
|
||||
A recognized domain implication the input leaves unaddressed *is* such a gap — name it as an `open_questions[]` entry (healthcare input silent on PHI/HIPAA, payments silent on PCI, control systems silent on fail-safe) and move on. Flag it; never invent the answer or coach toward it. If these dominate, the input is too thin — suggest `bmad-prd`.
|
||||
|
||||
Write lean from the first pass: every sentence must earn its place. Decoration costs tokens and dilutes downstream readers.
|
||||
|
||||
Log each decision, capability, constraint, and accepted change to `.memlog.md` as it is made — that running record is what the render reads. Because the log is append-only, a later entry supersedes an earlier one on the same point while the history stays intact. When two currently-live sources or companions disagree on the same field, or an either/or never got resolved, surface it to the user rather than silently choosing — the resolution is itself a new memlog entry.
|
||||
|
|
|
|||
|
|
@ -94,53 +94,78 @@ export default defineConfig({
|
|||
sidebar: [
|
||||
{
|
||||
label: 'Welcome',
|
||||
translations: { 'vi-VN': 'Chào mừng', 'zh-CN': '欢迎', 'fr-FR': 'Bienvenue', 'cs-CZ': 'Vítejte' },
|
||||
translations: { 'ko-KR': '환영합니다', 'vi-VN': 'Chào mừng', 'zh-CN': '欢迎', 'fr-FR': 'Bienvenue', 'cs-CZ': 'Vítejte' },
|
||||
slug: 'index',
|
||||
},
|
||||
{
|
||||
label: 'Roadmap',
|
||||
translations: { 'vi-VN': 'Lộ trình', 'zh-CN': '路线图', 'fr-FR': 'Feuille de route', 'cs-CZ': 'Plán rozvoje' },
|
||||
translations: { 'ko-KR': '로드맵', 'vi-VN': 'Lộ trình', 'zh-CN': '路线图', 'fr-FR': 'Feuille de route', 'cs-CZ': 'Plán rozvoje' },
|
||||
slug: 'roadmap',
|
||||
},
|
||||
{
|
||||
label: 'Tutorials',
|
||||
translations: { 'vi-VN': 'Hướng dẫn nhập môn', 'zh-CN': '教程', 'fr-FR': 'Tutoriels', 'cs-CZ': 'Tutoriály' },
|
||||
translations: { 'ko-KR': '튜토리얼', 'vi-VN': 'Hướng dẫn nhập môn', 'zh-CN': '教程', 'fr-FR': 'Tutoriels', 'cs-CZ': 'Tutoriály' },
|
||||
collapsed: false,
|
||||
autogenerate: { directory: 'tutorials' },
|
||||
},
|
||||
{
|
||||
label: 'How-To Guides',
|
||||
translations: { 'vi-VN': 'Hướng dẫn tác vụ', 'zh-CN': '操作指南', 'fr-FR': 'Guides pratiques', 'cs-CZ': 'Praktické návody' },
|
||||
translations: {
|
||||
'ko-KR': '사용 가이드',
|
||||
'vi-VN': 'Hướng dẫn tác vụ',
|
||||
'zh-CN': '操作指南',
|
||||
'fr-FR': 'Guides pratiques',
|
||||
'cs-CZ': 'Praktické návody',
|
||||
},
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'how-to' },
|
||||
},
|
||||
{
|
||||
label: 'Explanation',
|
||||
translations: { 'vi-VN': 'Giải thích', 'zh-CN': '概念说明', 'fr-FR': 'Explications', 'cs-CZ': 'Vysvětlení' },
|
||||
translations: {
|
||||
'ko-KR': '개념 설명',
|
||||
'vi-VN': 'Giải thích',
|
||||
'zh-CN': '概念说明',
|
||||
'fr-FR': 'Explications',
|
||||
'cs-CZ': 'Vysvětlení',
|
||||
},
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'explanation' },
|
||||
},
|
||||
{
|
||||
label: 'Reference',
|
||||
translations: { 'vi-VN': 'Tham chiếu', 'zh-CN': '参考', 'fr-FR': 'Référence', 'cs-CZ': 'Reference' },
|
||||
translations: { 'ko-KR': '참조', 'vi-VN': 'Tham chiếu', 'zh-CN': '参考', 'fr-FR': 'Référence', 'cs-CZ': 'Reference' },
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'reference' },
|
||||
},
|
||||
// TEA docs moved to standalone module site; keep BMM sidebar focused.
|
||||
{
|
||||
label: 'BMad Ecosystem',
|
||||
translations: { 'vi-VN': 'Hệ sinh thái BMad', 'zh-CN': 'BMad 生态系统', 'fr-FR': 'Écosystème BMad', 'cs-CZ': 'Ekosystém BMad' },
|
||||
translations: {
|
||||
'ko-KR': 'BMad 생태계',
|
||||
'vi-VN': 'Hệ sinh thái BMad',
|
||||
'zh-CN': 'BMad 生态系统',
|
||||
'fr-FR': 'Écosystème BMad',
|
||||
'cs-CZ': 'Ekosystém BMad',
|
||||
},
|
||||
collapsed: false,
|
||||
items: [
|
||||
{
|
||||
label: 'BMad Builder',
|
||||
translations: { 'vi-VN': 'BMad Builder', 'zh-CN': 'BMad 构建器', 'fr-FR': 'BMad Builder', 'cs-CZ': 'BMad Builder' },
|
||||
translations: {
|
||||
'ko-KR': 'BMad Builder',
|
||||
'vi-VN': 'BMad Builder',
|
||||
'zh-CN': 'BMad 构建器',
|
||||
'fr-FR': 'BMad Builder',
|
||||
'cs-CZ': 'BMad Builder',
|
||||
},
|
||||
link: 'https://bmad-builder-docs.bmad-method.org/',
|
||||
attrs: { target: '_blank' },
|
||||
},
|
||||
{
|
||||
label: 'Creative Intelligence Suite',
|
||||
translations: {
|
||||
'ko-KR': '창의적 지능 제품군',
|
||||
'vi-VN': 'Bộ công cụ Trí tuệ Sáng tạo',
|
||||
'zh-CN': '创意智能套件',
|
||||
'fr-FR': "Suite d'Intelligence Créative",
|
||||
|
|
@ -152,6 +177,7 @@ export default defineConfig({
|
|||
{
|
||||
label: 'Game Dev Studio',
|
||||
translations: {
|
||||
'ko-KR': '게임 개발 스튜디오',
|
||||
'vi-VN': 'Xưởng phát triển Game',
|
||||
'zh-CN': '游戏开发工作室',
|
||||
'fr-FR': 'Studio de Développement de Jeux',
|
||||
|
|
@ -163,6 +189,7 @@ export default defineConfig({
|
|||
{
|
||||
label: 'Test Architect (TEA)',
|
||||
translations: {
|
||||
'ko-KR': '테스트 설계자(TEA)',
|
||||
'vi-VN': 'Kiến trúc sư Kiểm thử (TEA)',
|
||||
'zh-CN': '测试架构师 (TEA)',
|
||||
'fr-FR': 'Architecte de Tests (TEA)',
|
||||
|
|
|
|||
|
|
@ -0,0 +1,644 @@
|
|||
<!doctype html>
|
||||
<html lang="ko-KR">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>BMad Method 워크플로 맵</title>
|
||||
<style>
|
||||
:root {
|
||||
--analysis: #0ea5e9;
|
||||
--planning: #22c55e;
|
||||
--solutioning: #eab308;
|
||||
--implementation: #ef4444;
|
||||
--quickflow: #64748b;
|
||||
--bg: #0f172a;
|
||||
--card: #1e293b;
|
||||
--text: #f8fafc;
|
||||
--text-muted: #94a3b8;
|
||||
--border: #334155;
|
||||
--success: #10b981;
|
||||
--arrow: #f59e0b;
|
||||
}
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
body {
|
||||
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
||||
background: var(--bg);
|
||||
color: var(--text);
|
||||
line-height: 1.4;
|
||||
padding: 12px;
|
||||
}
|
||||
.header {
|
||||
text-align: center;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
.header-badge {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 6px;
|
||||
background: linear-gradient(135deg, var(--analysis), var(--planning));
|
||||
padding: 4px 12px;
|
||||
border-radius: 20px;
|
||||
font-size: 0.75rem;
|
||||
font-weight: 600;
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
h1 {
|
||||
font-size: 1.5rem;
|
||||
font-weight: 700;
|
||||
}
|
||||
.subtitle {
|
||||
color: var(--text-muted);
|
||||
font-size: 0.8rem;
|
||||
}
|
||||
|
||||
.flow-legend {
|
||||
background: rgba(245, 158, 11, 0.1);
|
||||
border: 1px solid rgba(245, 158, 11, 0.3);
|
||||
border-radius: 8px;
|
||||
padding: 8px 12px;
|
||||
margin-bottom: 16px;
|
||||
text-align: center;
|
||||
font-size: 0.7rem;
|
||||
color: var(--arrow);
|
||||
}
|
||||
|
||||
.flow-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
|
||||
gap: 8px;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
|
||||
.phase {
|
||||
background: var(--card);
|
||||
border-radius: 10px;
|
||||
border: 1px solid var(--border);
|
||||
border-top: 3px solid;
|
||||
}
|
||||
.phase.analysis {
|
||||
border-top-color: var(--analysis);
|
||||
}
|
||||
.phase.planning {
|
||||
border-top-color: var(--planning);
|
||||
}
|
||||
.phase.solutioning {
|
||||
border-top-color: var(--solutioning);
|
||||
}
|
||||
.phase.implementation {
|
||||
border-top-color: var(--implementation);
|
||||
}
|
||||
|
||||
.phase-header {
|
||||
padding: 10px 12px 8px;
|
||||
border-bottom: 1px solid var(--border);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 8px;
|
||||
}
|
||||
.phase-num {
|
||||
width: 22px;
|
||||
height: 22px;
|
||||
border-radius: 6px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
font-size: 0.75rem;
|
||||
font-weight: 700;
|
||||
}
|
||||
.analysis .phase-num {
|
||||
background: var(--analysis);
|
||||
}
|
||||
.planning .phase-num {
|
||||
background: var(--planning);
|
||||
}
|
||||
.solutioning .phase-num {
|
||||
background: var(--solutioning);
|
||||
color: #000;
|
||||
}
|
||||
.implementation .phase-num {
|
||||
background: var(--implementation);
|
||||
}
|
||||
.phase-title {
|
||||
font-size: 0.95rem;
|
||||
font-weight: 700;
|
||||
}
|
||||
.phase-opt {
|
||||
font-size: 0.6rem;
|
||||
padding: 2px 6px;
|
||||
border-radius: 4px;
|
||||
background: rgba(14, 165, 233, 0.2);
|
||||
color: #7dd3fc;
|
||||
}
|
||||
|
||||
.workflows {
|
||||
padding: 8px 10px;
|
||||
}
|
||||
|
||||
.workflow {
|
||||
background: rgba(255, 255, 255, 0.03);
|
||||
border-radius: 6px;
|
||||
padding: 8px;
|
||||
margin-bottom: 6px;
|
||||
font-size: 0.7rem;
|
||||
}
|
||||
.workflow-header {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
.workflow-name {
|
||||
font-family: monospace;
|
||||
color: var(--success);
|
||||
background: rgba(16, 185, 129, 0.1);
|
||||
padding: 2px 6px;
|
||||
border-radius: 3px;
|
||||
font-size: 0.65rem;
|
||||
}
|
||||
.workflow-meta {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
}
|
||||
.agent {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 4px;
|
||||
}
|
||||
.agent-icon {
|
||||
width: 14px;
|
||||
height: 14px;
|
||||
border-radius: 3px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
font-size: 0.55rem;
|
||||
font-weight: 700;
|
||||
}
|
||||
.agent-icon.mary {
|
||||
background: linear-gradient(135deg, #f472b6, #ec4899);
|
||||
}
|
||||
.agent-icon.john {
|
||||
background: linear-gradient(135deg, #60a5fa, #3b82f6);
|
||||
}
|
||||
.agent-icon.sally {
|
||||
background: linear-gradient(135deg, #fbbf24, #f59e0b);
|
||||
color: #000;
|
||||
}
|
||||
.agent-icon.winston {
|
||||
background: linear-gradient(135deg, #a78bfa, #8b5cf6);
|
||||
}
|
||||
.agent-icon.amelia {
|
||||
background: linear-gradient(135deg, #fb7185, #ef4444);
|
||||
}
|
||||
|
||||
.agent-name {
|
||||
font-size: 0.65rem;
|
||||
}
|
||||
.output {
|
||||
color: var(--success);
|
||||
font-family: monospace;
|
||||
font-size: 0.6rem;
|
||||
}
|
||||
.badge {
|
||||
font-size: 0.55rem;
|
||||
padding: 1px 4px;
|
||||
border-radius: 3px;
|
||||
}
|
||||
.badge.opt {
|
||||
background: rgba(251, 191, 36, 0.15);
|
||||
color: #fbbf24;
|
||||
}
|
||||
.badge.iffy {
|
||||
background: rgba(168, 85, 247, 0.15);
|
||||
color: #a855f7;
|
||||
}
|
||||
.badge.adhoc {
|
||||
background: rgba(59, 130, 246, 0.15);
|
||||
color: #3b82f6;
|
||||
}
|
||||
|
||||
.arrow {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
color: var(--arrow);
|
||||
font-size: 0.9rem;
|
||||
margin: 6px 0;
|
||||
}
|
||||
|
||||
.decision {
|
||||
background: linear-gradient(135deg, #a855f7, #9333ea);
|
||||
padding: 4px 8px;
|
||||
border-radius: 4px;
|
||||
text-align: center;
|
||||
font-size: 0.65rem;
|
||||
font-weight: 600;
|
||||
margin: 6px 0;
|
||||
}
|
||||
|
||||
.quickflow {
|
||||
background: rgba(100, 116, 139, 0.2);
|
||||
border: 2px dashed var(--quickflow);
|
||||
border-radius: 10px;
|
||||
padding: 12px;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
.quickflow-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 8px;
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
.quickflow-header h2 {
|
||||
font-size: 0.95rem;
|
||||
}
|
||||
.quickflow-header span {
|
||||
font-size: 0.7rem;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
.quickflow-body {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 12px;
|
||||
}
|
||||
.quickflow-item {
|
||||
flex: 1;
|
||||
background: rgba(255, 255, 255, 0.03);
|
||||
border-radius: 8px;
|
||||
padding: 10px;
|
||||
}
|
||||
.quickflow-item code {
|
||||
font-family: monospace;
|
||||
color: var(--success);
|
||||
background: rgba(16, 185, 129, 0.1);
|
||||
padding: 2px 6px;
|
||||
border-radius: 3px;
|
||||
font-size: 0.7rem;
|
||||
}
|
||||
|
||||
.context {
|
||||
background: rgba(14, 165, 233, 0.08);
|
||||
border-radius: 10px;
|
||||
padding: 12px;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
.context-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 8px;
|
||||
margin-bottom: 6px;
|
||||
font-weight: 600;
|
||||
}
|
||||
.context-items {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 6px;
|
||||
}
|
||||
.context-items code {
|
||||
font-family: monospace;
|
||||
color: var(--success);
|
||||
background: rgba(16, 185, 129, 0.1);
|
||||
padding: 2px 5px;
|
||||
border-radius: 3px;
|
||||
font-size: 0.65rem;
|
||||
}
|
||||
.context-items span {
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.legend {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
gap: 12px;
|
||||
flex-wrap: wrap;
|
||||
font-size: 0.7rem;
|
||||
margin-top: 12px;
|
||||
}
|
||||
.legend-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 4px;
|
||||
}
|
||||
.legend-dot {
|
||||
width: 12px;
|
||||
height: 3px;
|
||||
border-radius: 2px;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="header-badge">⚡ 워크플로 맵 V6</div>
|
||||
<h1>BMad Method</h1>
|
||||
<p class="subtitle">AI 기반 개발을 위한 컨텍스트 엔지니어링</p>
|
||||
</div>
|
||||
|
||||
<div class="flow-legend">→ 화살표는 워크플로 간 산출물 흐름을 나타냅니다</div>
|
||||
|
||||
<div class="flow-grid">
|
||||
<!-- Phase 1: Analysis -->
|
||||
<div class="phase analysis">
|
||||
<div class="phase-header">
|
||||
<div class="phase-num">1</div>
|
||||
<div class="phase-title">분석</div>
|
||||
<span class="phase-opt">선택 사항</span>
|
||||
</div>
|
||||
<div class="workflows">
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">brainstorm</span>
|
||||
<span class="badge opt">선택</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon mary">M</div>
|
||||
<span class="agent-name">Mary</span>
|
||||
</div>
|
||||
<span class="output">brainstorming-report.md</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">research</span>
|
||||
<span class="badge opt">선택</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon mary">M</div>
|
||||
<span class="agent-name">Mary</span>
|
||||
</div>
|
||||
<span class="output">리서치 결과</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">product-brief</span>
|
||||
<span class="badge opt">또는 ↓</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon mary">M</div>
|
||||
<span class="agent-name">Mary</span>
|
||||
</div>
|
||||
<span class="output">product-brief.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">prfaq</span>
|
||||
<span class="badge opt">또는 ↑</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon mary">M</div>
|
||||
<span class="agent-name">Mary</span>
|
||||
</div>
|
||||
<span class="output">prfaq.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="arrow">→</div>
|
||||
</div>
|
||||
|
||||
<!-- Phase 2: Planning -->
|
||||
<div class="phase planning">
|
||||
<div class="phase-header">
|
||||
<div class="phase-num">2</div>
|
||||
<div class="phase-title">계획</div>
|
||||
</div>
|
||||
<div class="workflows">
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">prd</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon john">J</div>
|
||||
<span class="agent-name">Any</span>
|
||||
</div>
|
||||
<span class="output">prd.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="decision">UI가 있나요?</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-ux-design</span>
|
||||
<span class="badge iffy">예</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon sally">S</div>
|
||||
<span class="agent-name">Sally</span>
|
||||
</div>
|
||||
<span class="output">ux-spec.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="arrow">→</div>
|
||||
</div>
|
||||
|
||||
<!-- Phase 3: Solutioning -->
|
||||
<div class="phase solutioning">
|
||||
<div class="phase-header">
|
||||
<div class="phase-num">3</div>
|
||||
<div class="phase-title">솔루션 설계</div>
|
||||
</div>
|
||||
<div class="workflows">
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-architecture</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon winston">W</div>
|
||||
<span class="agent-name">Winston</span>
|
||||
</div>
|
||||
<span class="output">architecture.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-epics-and-stories</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon john">J</div>
|
||||
<span class="agent-name">John</span>
|
||||
</div>
|
||||
<span class="output">epics.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">check-implementation-readiness</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon john">J</div>
|
||||
<span class="agent-name">John</span>
|
||||
</div>
|
||||
<span class="output">구현 착수 전 준비도 점검</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="arrow">→</div>
|
||||
</div>
|
||||
|
||||
<!-- Phase 4: Implementation -->
|
||||
<div class="phase implementation">
|
||||
<div class="phase-header">
|
||||
<div class="phase-num">4</div>
|
||||
<div class="phase-title">구현</div>
|
||||
</div>
|
||||
<div class="workflows">
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">sprint-planning</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon amelia">A</div>
|
||||
<span class="agent-name">Amelia</span>
|
||||
</div>
|
||||
<span class="output">sprint-status.yaml →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-story</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon amelia">A</div>
|
||||
<span class="agent-name">Amelia</span>
|
||||
</div>
|
||||
<span class="output">story-[slug].md →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">dev-story</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon amelia">A</div>
|
||||
<span class="agent-name">Amelia</span>
|
||||
</div>
|
||||
<span class="output">코드 →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">code-review</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon amelia">A</div>
|
||||
<span class="agent-name">Amelia</span>
|
||||
</div>
|
||||
<span class="output">승인</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">correct-course</span>
|
||||
<span class="badge adhoc">필요 시</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon john">J</div>
|
||||
<span class="agent-name">John</span>
|
||||
</div>
|
||||
<span class="output">계획 업데이트</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">retrospective</span>
|
||||
<span class="badge adhoc">에픽 별</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon amelia">A</div>
|
||||
<span class="agent-name">Amelia</span>
|
||||
</div>
|
||||
<span class="output">배운 점</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">investigate</span>
|
||||
<span class="badge adhoc">언제든지</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent">
|
||||
<div class="agent-icon amelia">A</div>
|
||||
<span class="agent-name">Amelia</span>
|
||||
</div>
|
||||
<span class="output">사례 파일</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="quickflow">
|
||||
<div class="quickflow-header">
|
||||
<span>⚡</span>
|
||||
<div>
|
||||
<h2>Quick Flow (병렬 트랙)</h2>
|
||||
<span>범위가 작고 명확한 변경에 사용됩니다 — 1~3단계를 건너뜁니다</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="quickflow-body">
|
||||
<div class="quickflow-item">
|
||||
<div class="agent">
|
||||
<div class="agent-icon amelia">A</div>
|
||||
<span class="agent-name">Amelia</span>
|
||||
</div>
|
||||
<code>quick-dev</code>
|
||||
<div style="font-size: 0.65rem; color: var(--text-muted); margin-top: 4px">의도 → 기술 명세 → 동작하는 코드</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="context">
|
||||
<div class="context-header">📚 컨텍스트 흐름</div>
|
||||
<p style="margin-bottom: 8px; color: var(--text-muted)">각 문서는 다음 단계의 컨텍스트가 됩니다.</p>
|
||||
<div class="context-items">
|
||||
<span><code>create-story</code> <span>에픽, PRD, 아키텍처, UX를 로드</span></span>
|
||||
<span><code>dev-story</code> <span>스토리 파일을 로드</span></span>
|
||||
<span><code>code-review</code> <span>아키텍처와 스토리를 로드</span></span>
|
||||
<span><code>quick-dev</code> <span>명확화, 계획, 구현, 리뷰</span></span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="legend">
|
||||
<div class="legend-item">
|
||||
<div class="legend-dot" style="background: var(--analysis)"></div>
|
||||
분석
|
||||
</div>
|
||||
<div class="legend-item">
|
||||
<div class="legend-dot" style="background: var(--planning)"></div>
|
||||
계획
|
||||
</div>
|
||||
<div class="legend-item">
|
||||
<div class="legend-dot" style="background: var(--solutioning)"></div>
|
||||
솔루션 설계
|
||||
</div>
|
||||
<div class="legend-item">
|
||||
<div class="legend-dot" style="background: var(--implementation)"></div>
|
||||
구현
|
||||
</div>
|
||||
<div class="legend-item">
|
||||
<div class="legend-dot" style="background: var(--quickflow)"></div>
|
||||
빠른 흐름
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -2,13 +2,102 @@
|
|||
import { getSiteUrl } from '../lib/site-url.mjs';
|
||||
|
||||
const llmsFullUrl = `${getSiteUrl()}/llms-full.txt`;
|
||||
const bannerCopy = {
|
||||
root: {
|
||||
aiLabel: 'AI documentation notice',
|
||||
aiPrefix: 'Consolidated, AI-optimized BMAD docs:',
|
||||
aiLinkGap: ' ',
|
||||
aiSuffix: 'Fetch this plain text file for complete context.',
|
||||
announceLabel: 'BMad Builder announcement',
|
||||
announcePrefix: 'Build your own BMad modules and share them with the community!',
|
||||
announceLinkGap: ' ',
|
||||
getStarted: 'Get started',
|
||||
connectorBefore: ' ',
|
||||
connector: 'or',
|
||||
connectorAfter: ' ',
|
||||
submit: 'submit to the marketplace',
|
||||
},
|
||||
'ko-kr': {
|
||||
aiLabel: 'AI 문서 안내',
|
||||
aiPrefix: 'AI에 최적화된 통합 BMAD 문서:',
|
||||
aiLinkGap: ' ',
|
||||
aiSuffix: '전체 컨텍스트가 필요하면 이 일반 텍스트 파일을 가져오세요.',
|
||||
announceLabel: 'BMad Builder 공지',
|
||||
announcePrefix: '나만의 BMad 모듈을 만들고 커뮤니티와 공유하세요!',
|
||||
announceLinkGap: ' ',
|
||||
getStarted: '시작하기',
|
||||
connectorBefore: ' ',
|
||||
connector: '또는',
|
||||
connectorAfter: ' ',
|
||||
submit: '마켓플레이스에 제출하기',
|
||||
},
|
||||
'vi-vn': {
|
||||
aiLabel: 'Thông báo tài liệu AI',
|
||||
aiPrefix: 'Tài liệu BMAD hợp nhất, tối ưu cho AI:',
|
||||
aiLinkGap: ' ',
|
||||
aiSuffix: 'Lấy tệp văn bản thuần này để có đầy đủ ngữ cảnh.',
|
||||
announceLabel: 'Thông báo BMad Builder',
|
||||
announcePrefix: 'Xây dựng các mô-đun BMad của riêng bạn và chia sẻ với cộng đồng!',
|
||||
announceLinkGap: ' ',
|
||||
getStarted: 'Bắt đầu',
|
||||
connectorBefore: ' ',
|
||||
connector: 'hoặc',
|
||||
connectorAfter: ' ',
|
||||
submit: 'gửi lên marketplace',
|
||||
},
|
||||
'zh-cn': {
|
||||
aiLabel: 'AI 文档提示',
|
||||
aiPrefix: '整合的 AI 优化 BMAD 文档：',
|
||||
aiLinkGap: '',
|
||||
aiSuffix: '获取此纯文本文件以获得完整上下文。',
|
||||
announceLabel: 'BMad Builder 公告',
|
||||
announcePrefix: '构建你自己的 BMad 模块并与社区分享！',
|
||||
announceLinkGap: '',
|
||||
getStarted: '开始使用',
|
||||
connectorBefore: '',
|
||||
connector: '或',
|
||||
connectorAfter: '',
|
||||
submit: '提交到 marketplace',
|
||||
},
|
||||
fr: {
|
||||
aiLabel: 'Avis sur la documentation IA',
|
||||
aiPrefix: 'Documentation BMAD consolidée et optimisée pour l’IA :',
|
||||
aiLinkGap: ' ',
|
||||
aiSuffix: 'Récupérez ce fichier texte brut pour obtenir le contexte complet.',
|
||||
announceLabel: 'Annonce BMad Builder',
|
||||
announcePrefix: 'Créez vos propres modules BMad et partagez-les avec la communauté !',
|
||||
announceLinkGap: ' ',
|
||||
getStarted: 'Commencer',
|
||||
connectorBefore: ' ',
|
||||
connector: 'ou',
|
||||
connectorAfter: ' ',
|
||||
submit: 'soumettre au marketplace',
|
||||
},
|
||||
cs: {
|
||||
aiLabel: 'Upozornění k dokumentaci pro AI',
|
||||
aiPrefix: 'Konsolidovaná dokumentace BMAD optimalizovaná pro AI:',
|
||||
aiLinkGap: ' ',
|
||||
aiSuffix: 'Stáhněte si tento prostý textový soubor pro úplný kontext.',
|
||||
announceLabel: 'Oznámení BMad Builder',
|
||||
announcePrefix: 'Vytvářejte vlastní moduly BMad a sdílejte je s komunitou!',
|
||||
announceLinkGap: ' ',
|
||||
getStarted: 'Začít',
|
||||
connectorBefore: ' ',
|
||||
connector: 'nebo',
|
||||
connectorAfter: ' ',
|
||||
submit: 'odeslat na marketplace',
|
||||
},
|
||||
};
|
||||
const pathSegments = Astro.url.pathname.split('/').filter(Boolean);
|
||||
const locale = pathSegments.find((segment) => segment in bannerCopy) ?? 'root';
|
||||
const copy = bannerCopy[locale] ?? bannerCopy.root;
|
||||
---
|
||||
|
||||
<div class="ai-banner" role="note" aria-label="AI documentation notice">
|
||||
<span>🤖 Consolidated, AI-optimized BMAD docs: <a href={llmsFullUrl}>llms-full.txt</a>. Fetch this plain text file for complete context.</span>
|
||||
<div class="ai-banner" role="note" aria-label={copy.aiLabel}>
|
||||
<span>🤖 {copy.aiPrefix}{copy.aiLinkGap}<a href={llmsFullUrl}>llms-full.txt</a>. {copy.aiSuffix}</span>
|
||||
</div>
|
||||
<div class="announce-banner" role="note" aria-label="BMad Builder announcement">
|
||||
<span>🚀 Build your own BMad modules and share them with the community! <a href="https://bmad-builder-docs.bmad-method.org/tutorials/build-your-first-module/">Get started</a> or <a href="https://bmad-builder-docs.bmad-method.org/how-to/distribute-your-module/">submit to the marketplace</a>.</span>
|
||||
<div class="announce-banner" role="note" aria-label={copy.announceLabel}>
|
||||
<span>🚀 {copy.announcePrefix}{copy.announceLinkGap}<a href="https://bmad-builder-docs.bmad-method.org/tutorials/build-your-first-module/">{copy.getStarted}</a>{copy.connectorBefore}{copy.connector}{copy.connectorAfter}<a href="https://bmad-builder-docs.bmad-method.org/how-to/distribute-your-module/">{copy.submit}</a>.</span>
|
||||
</div>
|
||||
|
||||
<style>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,28 @@
|
|||
{
|
||||
"skipLink.label": "본문으로 건너뛰기",
|
||||
"search.label": "검색",
|
||||
"search.ctrlKey": "Ctrl",
|
||||
"search.cancelLabel": "취소",
|
||||
"themeSelect.accessibleLabel": "테마 선택",
|
||||
"themeSelect.dark": "어둡게",
|
||||
"themeSelect.light": "밝게",
|
||||
"themeSelect.auto": "자동",
|
||||
"languageSelect.accessibleLabel": "언어 선택",
|
||||
"menuButton.accessibleLabel": "메뉴",
|
||||
"sidebarNav.accessibleLabel": "기본 탐색",
|
||||
"tableOfContents.onThisPage": "이 페이지에서",
|
||||
"tableOfContents.overview": "개요",
|
||||
"i18n.untranslatedContent": "이 콘텐츠는 아직 한국어로 제공되지 않습니다.",
|
||||
"page.editLink": "이 페이지 편집",
|
||||
"page.lastUpdated": "마지막 업데이트:",
|
||||
"page.previousLink": "이전 페이지",
|
||||
"page.nextLink": "다음 페이지",
|
||||
"page.draft": "이 콘텐츠는 초안 상태이며 공식 빌드에는 표시되지 않습니다.",
|
||||
"404.text": "페이지를 찾을 수 없습니다. 주소를 확인하거나 검색을 사용하세요.",
|
||||
"aside.note": "참고",
|
||||
"aside.tip": "팁",
|
||||
"aside.caution": "주의",
|
||||
"aside.danger": "경고",
|
||||
"fileTree.directory": "디렉터리",
|
||||
"builtWithStarlight.label": "Starlight로 제작"
|
||||
}
|
||||
|
|
@ -15,6 +15,10 @@ export const locales = {
|
|||
label: 'English',
|
||||
lang: 'en',
|
||||
},
|
||||
'ko-kr': {
|
||||
label: '한국어',
|
||||
lang: 'ko-KR',
|
||||
},
|
||||
'vi-vn': {
|
||||
label: 'Tiếng Việt',
|
||||
lang: 'vi-VN',
|
||||
|
|
|
|||
Loading…
Reference in New Issue