Air-Intl-Search 옵시디언 문서화 계획
프로젝트 개요
air-intl-search 레포지토리의 모든 함수와 객체를 빠짐없이 분석하여 옵시디언 마크다운으로 정리하는 프로젝트
목표
- 국제 항공 검색 서비스의 전체 함수/객체 문서화 (누락 없음)
- Caller-Callee 관계 명시 (어떤 함수가 어떤 함수를 호출하는지)
- 요청-응답 관계 발췌 기록
- 함수/객체 간의 관계를 옵시디언 링크로 연결
- 코드베이스 완전한 이해를 위한 참조 문서 구축
문서화 범위
- 모든 클래스: 서비스, 컨트롤러, 리포지토리, 도메인, DTO 등
- 모든 함수: public, private, internal 모두 포함
- 모든 객체: data class, enum, sealed class 등
- Caller-Callee 관계: 각 함수가 호출하는/호출받는 함수 목록
- 요청-응답 관계: API 엔드포인트의 Request/Response 매핑
작업 흐름
Phase 1: 준비 단계
- obsidian/nol 폴더 생성
- 계획문서(PLAN.md) 작성
- 작성상황 문서(STATUS.md) 생성
- 최초 푸시 후 템플릿 파일 수신 대기
Phase 2: 전체 분석 단계
- air-intl-search 전체 파일 목록 수집
- 모든 클래스/함수/객체 인벤토리 작성
- Caller-Callee 관계 매핑
- 요청-응답 흐름 추적
Phase 3: 문서화 단계
- 템플릿 적용하여 각 항목 문서화
- 모든 함수에 대해:
- 함수 시그니처
- 파라미터 설명
- 반환값 설명
- Caller 목록 (이 함수를 호출하는 곳)
- Callee 목록 (이 함수가 호출하는 함수들)
- 요청/응답 객체 (해당되는 경우)
- 옵시디언 링크로 관계 연결
- 문서 검토 및 누락 항목 보완
예상 산출물 구조
obsidian/nol/
├── PLAN.md # 계획문서
├── STATUS.md # 작성상황 추적
├── templates/ # 템플릿 파일 (사용자 제공 예정)
├── air-intl-search/ # 분석 문서
│ ├── _index.md # 전체 함수/객체 인덱스
│ ├── controllers/ # 컨트롤러 클래스
│ ├── services/ # 서비스 클래스
│ ├── domain/ # 도메인 객체
│ ├── dto/ # DTO 객체
│ ├── repository/ # 리포지토리 클래스
│ ├── infrastructure/ # 인프라 계층
│ ├── configuration/ # 설정 클래스
│ └── flows/ # 전체 플로우 문서
└── ...
각 문서에 포함될 내용
함수 문서 필수 항목
## 함수명
### 시그니처
### 설명
### 파라미터
### 반환값
### Caller (이 함수를 호출하는 곳)
- [[파일명#함수명|함수명]]
### Callee (이 함수가 호출하는 함수)
- [[파일명#함수명|함수명]]
### 요청 객체 (해당 시)
### 응답 객체 (해당 시)클래스 문서 필수 항목
## 클래스명
### 패키지
### 상속/구현 관계
### 프로퍼티
### 메서드 목록
### 의존성 (DI)작업 규칙
- 모든 함수/객체를 빠짐없이 문서화
- 각 함수/객체별 개별 md 파일 생성
[[링크]]형식으로 관련 항목 연결- Caller-Callee 관계 반드시 명시
- 요청-응답 객체 매핑 명시
- 코드 예시 포함 시 언어 지정
- 커밋은 논리적 단위로 수행
마지막 업데이트: 2024-12-17