Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AI_MEMORY.md → ai-memory.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AI_MEMORY.md
# ai-memory.md

# ReplWorks Memory

Expand Down
165 changes: 165 additions & 0 deletions docs/ideas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
# ideas.md

# ReplWorks Documents

AI 에이전트 기반 개발을 위한 문서 템플릿 저장소

---

## 배경

최근 AI 코딩 도구들은 코드 생성 능력 자체는 충분히 발전했다.

하지만 실제 프로젝트에서는 다음과 같은 문제들이 반복적으로 발생한다.

- 잘못된 위치에 파일 생성
- 새로운 폴더 구조 생성
- 프로젝트 규칙을 무시한 코드 작성
- 예상하지 못한 라이브러리 추가
- 중복 기능 구현
- 기존 아키텍처와 충돌하는 코드 생성

이러한 문제는 AI가 개발 기술을 몰라서 발생하는 것이 아니다.

대부분 프로젝트별 규칙과 제약조건을 충분히 전달받지 못해서 발생한다.

---

## 목표

이 저장소의 목적은 사람을 위한 문서가 아니다.

AI가 프로젝트를 이해하고 일관된 방식으로 개발할 수 있도록 하는 문서 템플릿을 제공하는 것이다.

프로젝트를 시작할 때 필요한 문서를 복사하여 사용함으로써 AI에게 동일한 품질의 컨텍스트를 제공할 수 있다.

---

## 핵심 아이디어

AI는 일반적인 개발 지식보다 현재 프로젝트의 규칙을 더 필요로 한다.

예를 들어 AI는 React를 알고 있다.

하지만 다음과 같은 정보는 알지 못한다.

- 이 프로젝트가 Zustand를 사용하는지
- Redux를 금지하는지
- 컴포넌트를 어디에 생성해야 하는지
- 어떤 Import 규칙을 사용하는지
- 어떤 폴더 구조를 유지해야 하는지

이 저장소는 이러한 규칙을 템플릿 형태로 제공한다.

---

## 설계 원칙

### 1. AI First

문서는 사람이 아니라 AI를 위해 작성한다.

가독성보다 명확성을 우선한다.

필요한 규칙은 중복되더라도 명시적으로 작성한다.

---

### 2. Framework First

프로젝트마다 사용하는 기술 스택은 다르다.

따라서 프레임워크별 규칙을 별도 문서로 관리한다.

예시:

```text
frameworks/
├─ REACT_VITE.md
├─ NEXTJS.md
├─ LARAVEL.md
├─ FASTAPI.md
└─ DJANGO.md
```

각 문서는 다음 내용을 포함한다.

- 기술 스택
- 폴더 구조
- 네이밍 규칙
- Import 규칙
- 금지 사항
- 개발 제약 조건

---

### 3. Template Based

새 프로젝트 생성 시 필요한 문서를 복사하여 사용한다.

프로젝트 특성에 맞게 수정할 수 있으며 원본 템플릿은 독립적으로 유지한다.

---

### 4. 추측보다 규칙

AI는 추측하지 않는다.

문서에 정의된 규칙을 따른다.

규칙이 없는 경우에는 새로운 구조를 만들어내기보다 질문하거나 TODO를 남기는 것을 우선한다.

---

## 기본 문서 구성

프로젝트에는 다음 문서 구성을 권장한다.

```text
AGENTS.md
architecture.md
tasks.md
AI_MEMORY.md

framework.md
```

### AGENTS.md

AI 에이전트의 행동 규칙

### architecture.md

시스템 구조 및 설계

### tasks.md

현재 작업 목록

### AI_MEMORY.md

제품 비전 및 장기 컨텍스트

### framework.md

현재 프로젝트의 기술 스택 및 개발 규칙

---

## 기대 효과

이 저장소를 통해 다음을 기대한다.

- AI의 파일 생성 오류 감소
- 프로젝트 구조 일관성 유지
- 불필요한 라이브러리 추가 방지
- 아키텍처 위반 감소
- 여러 AI 도구 간 동일한 개발 경험 제공

---

## 장기 비전

프로젝트마다 AI 사용 방식이 달라지는 것이 아니라,

어떤 AI를 사용하더라도 동일한 문서 구조와 규칙을 통해 안정적으로 개발할 수 있는 표준 문서 체계를 만드는 것을 목표로 한다.
Loading
Loading