이 문서의 목적은 프로젝트 구조를 정의하는 것이 아니다.
선택된 기술 스택을 일관되게 사용하는 방법을 정의하는 것이다.
Purpose
다음 질문에 답한다.
이 기술 스택은 어떻게 사용해야 하는가?
파일은 어디에 위치해야 하는가?
어떤 구현 규칙을 따라야 하는가?
무엇을 허용하고 무엇을 금지하는가?
FRAMEWORK.md는 기술 스택에 대한 구현 가이드다.
Inputs
일반적으로 다음 정보를 기반으로 작성한다.
- ARCHITECTURE.md
- 선택된 기술 스택
- 프로젝트 구조
- 조직의 개발 규칙
- 운영 경험
Outputs
다음 내용을 정의한다.
- 프로젝트 구조 규칙
- 파일 배치 규칙
- 라우팅 규칙
- 컴포넌트 규칙
- 데이터 규칙
- 스타일링 규칙
- 성능 규칙
- 생성 규칙
- 네이밍 규칙
Lifecycle
프로젝트 초기 단계에 생성한다.
일반적으로 기술 스택이 변경되지 않는 한 자주 수정되지 않는다.
기술 스택 변경 또는 운영 경험 축적 시 업데이트할 수 있다.
Relationship
PRODUCT_SPEC.md
↓
ARCHITECTURE.md
↓
FRAMEWORK.md
↓
TASKS.md
↓
AGENTS.md
ARCHITECTURE.md는 프로젝트 구조를 정의한다.
FRAMEWORK.md는 해당 구조를 구현하는 규칙을 정의한다.
TASKS.md는 이 규칙을 기반으로 작업을 수행한다.
AI Usage
Execution AI가 반드시 읽어야 하는 문서다.
Discussion AI는 필요 시 참고할 수 있다.
구현 규칙에 대한 최종 기준은 FRAMEWORK.md다.
Examples
REPL Works는 기술 스택별 FRAMEWORK.md를 사용할 수 있다.
예시:
ASTRO.md
NEXTJS.md
GO.md
FASTAPI.md
REACT.md
각 문서는 해당 기술 스택의 권장 구조와 구현 규칙을 정의한다.
Generate With
FRAMEWORK.md는 ReplWorks에서 제공하며, 제공하는 프레임워크는 다음과 같다.
프로젝트마다 새로 만드는 것이 아니라,
검증된 기술 스택 규칙을 재사용하는 경우가 많다.
조직 또는 개인은 자체 FRAMEWORK.md 라이브러리를 구축할 수 있다.
Key Principle
좋은 FRAMEWORK.md는 기능을 설명하지 않는다.
좋은 FRAMEWORK.md는 구현 규칙을 설명한다.
Why It Matters
프로젝트는 바뀔 수 있다.
기능도 바뀔 수 있다.
하지만 기술 스택 사용 규칙은 일관되어야 한다.
FRAMEWORK.md는 AI가 기술 스택을 예측하지 않도록 만든다.
프로젝트 구조는 ARCHITECTURE.md에 저장된다.
구현 규칙은 FRAMEWORK.md에 저장된다.
둘은 서로를 대체하지 않는다.