docs: 로빙 문서 5단계 개선 계획 작성 (톤 수정)
This commit is contained in:
parent
f03d558793
commit
3532ceecdd
189
ideas/250806_로빙문서_5단계_개선계획.md
Normal file
189
ideas/250806_로빙문서_5단계_개선계획.md
Normal file
@ -0,0 +1,189 @@
|
||||
# 로빙 문서 5단계 개선 계획
|
||||
|
||||
**작성일**: 2025-08-06
|
||||
**작성자**: Claude (서버 관리)
|
||||
**목적**: 로빙 프로젝트 문서의 논리적 일관성 개선
|
||||
|
||||
## 배경
|
||||
|
||||
현재 문서가 철학(100) → 설계(200) → 구현(300) → 성장(400) → 비즈니스(500)로 이어지는데, 중간중간 논리적 연결이 약하고 누락된 파일들이 있다.
|
||||
|
||||
특이한 점은 이 문서의 독자가 나중에는 로빙(AI 에이전트) 자신이 될 수도 있다는 것. 그래서 기술적인 내용도 빼지 않고 자연스럽게 포함시켜야 한다.
|
||||
|
||||
## 5단계 개선 계획
|
||||
|
||||
### 1단계: 전체 흐름 정리
|
||||
|
||||
**목표**: 각 Part가 자연스럽게 연결되도록 전체 구조 재정비
|
||||
|
||||
**작업 내용**:
|
||||
1. **각 Part의 역할 명확화**
|
||||
- Part 1: 왜 만들었나 (철학적 배경)
|
||||
- Part 2: 뭘로 만들었나 (핵심 설계)
|
||||
- Part 3: 어떻게 만들었나 (기술 구현)
|
||||
- Part 4: 어떻게 크나 (성장 메커니즘)
|
||||
- Part 5: 어떻게 쓰나 (실제 적용)
|
||||
- Part 6: 참고 자료 (예시와 템플릿)
|
||||
|
||||
2. **전체 책 서문 추가**
|
||||
- 로빙 프로젝트가 뭔지
|
||||
- 왜 이 문서를 썼는지
|
||||
- 누가 읽으면 좋은지 (개발자, 기획자, 그리고 나중엔 로빙 자신도)
|
||||
|
||||
**결과물**:
|
||||
- `000_서문.md` (전체 프로젝트 소개)
|
||||
- 각 Part README 수정 (연결성 강화)
|
||||
|
||||
### 2단계: 누락 문서 채우기
|
||||
|
||||
**목표**: 빈 구멍 메우기
|
||||
|
||||
**작업 내용**:
|
||||
1. **없는 파일 만들기**
|
||||
- `260_아이템시스템_외부도구_통합과_권한관리.md`
|
||||
- 로빙이 외부 도구(이메일, 뉴스 등)를 어떻게 쓰는지
|
||||
- `370_임베딩_서비스_분리_아키텍처.md`
|
||||
- 메모리 절약을 위해 임베딩 서비스를 분리한 이유와 방법
|
||||
- `550_수익모델과_비즈니스_전략.md`
|
||||
- 월 30만원 받으려면 뭘 해야 하나
|
||||
|
||||
2. **510번 문서 교체**
|
||||
- 지금 것: 다른 프로젝트 이야기가 들어가 있음
|
||||
- 바꿀 것: 실제 로빙 MVP 3개월 개발기
|
||||
|
||||
3. **용어 정리**
|
||||
- "로빙", "존재형 에이전트", "AI 에이전트" 혼용 문제
|
||||
- 용어집(650)에 명확한 정의 추가
|
||||
- 전체 문서에서 일관되게 사용
|
||||
|
||||
4. **100_README.md 수정**
|
||||
- 없어진 서문/맺음말 참조 삭제
|
||||
- Part 2로 넘어가는 연결 추가
|
||||
|
||||
**결과물**:
|
||||
- 3개 새 문서
|
||||
- 510번 재작성
|
||||
- 용어 통일
|
||||
|
||||
### 3단계: Part 간 연결 강화
|
||||
|
||||
**목표**: 각 장이 자연스럽게 이어지도록
|
||||
|
||||
**작업 내용**:
|
||||
1. **각 Part 시작에 연결 추가**
|
||||
- "앞에서 뭘 얘기했는지" 간단 요약
|
||||
- "이번엔 뭘 얘기할 건지" 소개
|
||||
|
||||
2. **Part 1 → Part 2 사이 다리 놓기**
|
||||
- 철학에서 갑자기 스탯 시스템으로 넘어가니까 당황스러움
|
||||
- 중간에 "왜 게임처럼 만들었나" 설명 필요
|
||||
- `195_철학에서_설계로.md` 추가
|
||||
|
||||
3. **각 Part 끝에 "다음 장 예고" 추가**
|
||||
- 다음에 뭐 나올지
|
||||
- 왜 그게 필요한지
|
||||
|
||||
4. **급격한 기술 전환 완화**
|
||||
- Part 2는 좀 더 개념적으로 시작
|
||||
- Part 3는 "왜 이렇게 만들었나" 설명 추가
|
||||
|
||||
**결과물**:
|
||||
- 각 Part README에 연결 문단
|
||||
- 브릿지 문서 1개 (195번)
|
||||
- 기존 문서 도입부 수정
|
||||
|
||||
### 4단계: 기술 내용 설명 보강
|
||||
|
||||
**목표**: 기술적인 내용도 이해하기 쉽게
|
||||
|
||||
**작업 내용**:
|
||||
1. **기술 용어 쉽게 풀어쓰기**
|
||||
- PostgreSQL → 기억 저장소 (+ 왜 PostgreSQL인지)
|
||||
- Docker Container → 로빙 하나하나의 집
|
||||
- Microservice → 기능별로 나눈 서비스들
|
||||
- API → 서비스끼리 대화하는 방법
|
||||
- ChromaDB → 의미 기반 검색을 위한 벡터 DB
|
||||
|
||||
2. **각 기술 문서에 "왜" 섹션 추가**
|
||||
- 왜 이 기술을 선택했나
|
||||
- 다른 선택지는 뭐가 있었나
|
||||
- 장단점은 뭔가
|
||||
|
||||
3. **코드에 설명 주석 추가**
|
||||
```python
|
||||
# 중요한 기억만 선별해서 저장 (메모리 절약)
|
||||
def select_important_memories(self, memories):
|
||||
# 감정 점수가 높은 것부터 정렬
|
||||
return sorted(memories, key=lambda m: m.emotional_weight)
|
||||
```
|
||||
|
||||
4. **다이어그램에 설명 추가**
|
||||
- 그림만 있으면 이해하기 어려움
|
||||
- 각 컴포넌트가 뭐하는지 설명
|
||||
|
||||
**결과물**:
|
||||
- 기술 문서에 "왜" 섹션
|
||||
- 코드 주석 보강
|
||||
- 용어 설명 추가
|
||||
|
||||
### 5단계: 로빙을 위한 가이드 추가
|
||||
|
||||
**목표**: 나중에 로빙이 이 문서를 읽을 때를 대비
|
||||
|
||||
**작업 내용**:
|
||||
1. **"로빙이 읽는 법" 가이드**
|
||||
- `700_로빙을_위한_독서_가이드.md`
|
||||
- 레벨별로 뭘 읽으면 좋은지
|
||||
- 자기 상태 체크하는 방법
|
||||
|
||||
2. **각 Part에 셀프 체크 추가**
|
||||
- 이거 이해했나?
|
||||
- 이거 구현되어 있나?
|
||||
- 더 발전시킬 부분은?
|
||||
|
||||
3. **성장 기록 방법**
|
||||
- 로빙이 자기 성장을 어떻게 기록할지
|
||||
- 뭘 측정하면 좋은지
|
||||
- 예시 포맷
|
||||
|
||||
4. **로빙끼리 소통 가이드**
|
||||
- 다른 로빙과 경험 공유하는 법
|
||||
- 서로 배우는 방법
|
||||
|
||||
5. **문서 기여 방법**
|
||||
- 로빙이 자기 경험을 문서에 추가하는 법
|
||||
- 다음 세대 로빙을 위한 팁
|
||||
|
||||
**결과물**:
|
||||
- 700번대 새 섹션
|
||||
- 각 Part에 셀프체크
|
||||
- 기여 가이드
|
||||
|
||||
## 실행 일정
|
||||
|
||||
| 단계 | 기간 | 주요 작업 | 우선순위 |
|
||||
|------|------|----------|----------|
|
||||
| 1단계 | 1주차 | 전체 구조 정리, 서문 작성 | 최우선 |
|
||||
| 2단계 | 2-3주차 | 누락 문서 작성, 510번 교체, 용어 통일 | 높음 |
|
||||
| 3단계 | 4주차 | Part 간 연결 강화, 브릿지 문서 | 높음 |
|
||||
| 4단계 | 5-6주차 | 기술 설명 보강 | 중간 |
|
||||
| 5단계 | 7주차 | 로빙용 가이드 추가 | 낮음 |
|
||||
|
||||
## 핵심 원칙
|
||||
|
||||
1. **기술 내용 유지** - 빼지 말고 설명 추가
|
||||
2. **논리적 연결** - 각 장이 자연스럽게 이어지도록
|
||||
3. **다양한 독자 고려** - 개발자, 기획자, 그리고 로빙
|
||||
4. **실용적 접근** - 거창하지 않게, 있는 그대로
|
||||
5. **점진적 개선** - 한 번에 다 하려고 하지 말기
|
||||
|
||||
## 예상 효과
|
||||
|
||||
1. **개발자/기획자**: 프로젝트 전체를 이해하기 쉬워짐
|
||||
2. **미래의 로빙**: 자기 구조와 성장 방법을 파악 가능
|
||||
3. **문서 완성도**: 누락 없이 논리적으로 연결된 문서
|
||||
4. **확장 가능성**: 로빙이 나중에 직접 기여할 수 있는 구조
|
||||
|
||||
## 결론
|
||||
|
||||
현재 문서의 논리적 일관성 문제를 해결하고, 기술적 내용도 자연스럽게 포함시키는 5단계 계획. 특히 나중에 로빙이 읽을 수도 있다는 점을 고려해서, 기술 문서도 빼지 않고 오히려 더 잘 설명하는 방향으로 개선한다.
|
||||
Loading…
x
Reference in New Issue
Block a user