샘플 개발 문서
이 개발 문서의 항목들은 요구사항 관리, 설계 및 개발, 테스트, 배포 및 회고 과정을 체계적으로 정리한 구조예요.
각 항목을 통해 프로젝트 진행 시 필수적으로 다루어야 할 내용을 한눈에 볼 수 있도록 구성되어 있어요.
요구사항 및 커뮤니케이션에서는 주요 링크, 작업 범위, 스크린샷, 개발 요구사항을 정리하여 커뮤니케이션의 원활함을 도모하고 있네요. AB 테스트, i18n, 로깅 등과 관련된 중요한 체크리스트도 포함되어 있어요.
설계 및 개발 항목에서는 API 설계와 UI 구성 요소 설계를 다루고, 코드 변경 사항과 엣지 케이스에 대한 고려 사항도 잘 정리되어 있어요. 특히 엔지니어링 테스트 주도를 강조하고, QA 전에 내부 테스트를 철저히 진행하는 것이 핵심으로 보이네요.
배포 및 운영 단계에서는 모니터링, 비즈니스 임팩트 분석, 그리고 회고를 통해 프로젝트 후속 작업에 필요한 개선 사항을 정리하고 있어요.
1. 요구사항, 커뮤니케이션
1.1 Links
- 티켓: Feature 구현, QA, 리뷰 관련 티켓
- 참조 문서: GPT API 문서, 블로그 CMS API 문서, 번역 및 로깅 관련 문서
- 커뮤니케이션 채널 및 일정: Slack, Jira, 팀 미팅 주기
1.2 Scope / Screenshot
- 작업 범위: 블로그 자동 생성 시스템 개발
- 사용자가 주제를 입력하면 GPT API를 호출해 포스트 작성
- 포스트를 작성 후 블로그에 자동으로 업로드
- 간단한 UI 제공
- 다국어 지원(i18n)
1.3 Specification (개발 요구사항 및 체크리스트)
- AB Test: 다국어 포스트 성능 비교(법무 검토 필요)
- i18n: 다국어 블로그 포스트 자동화 시스템 구현
- Logging: 로그 시스템을 통해 API 호출 및 블로그 포스트 업로드 성공 여부 기록
- Test Scope: Critical Level Function 확인, 유닛 테스트, E2E 테스트 필요 여부 결정
- PR Review: 코드 리뷰 진행
2. 설계, 개발, 미정의 스펙 검토 & 테스트
2.1 Design (설계)
- API 설계: GPT API를 호출해 주제를 기반으로 포스트 생성, 블로그 CMS API를 통해 포스트 자동 게시
- UI Component 설계: 사용자가 주제를 입력하고 결과를 확인할 수 있는 간단한 웹 UI (React/Next.js 기반)
2.2 Changes (코드 변경 사항 / 엔지니어링 테스트 스펙 및 결과 / PR History)
- Overview:
- GPT API 호출 모듈
- 블로그 CMS 업로드 모듈
- 번역 및 다국어 지원 모듈
- UI 인터페이스
2.3 Need To Consider (엣지 케이스 및 예외 사항 정리)
- GPT API 호출 실패 시 대체 시나리오
- 비정상적인 입력 값 처리
- 블로그 업로드 실패 시 재시도 로직
2.4 Engineering Testing (엔지니어링 주도 통합 테스트)
- TC Plan: 엔지니어가 주도하는 통합 테스트 계획, 각 모듈별 테스트 진행
- TC Result: 통합 테스트 결과 공유
2.5 Request QA (QA Scope 정의 및 검증)
- Functional Testing: 기능 테스트 - 주제 입력, 포스트 생성, 업로드
- Data Verification: GPT API 결과의 유효성 검증
- Experiment Verification: AB 테스트 결과 검증
- Regression Testing: 기존 기능 회귀 테스트
3. 배포 & 운영, 임팩트, 회고
3.1 RP & Monitoring
- Release Process Ticket: 배포 관련 티켓 작성 및 배포 계획 수립
- Monitoring: 포스트 업로드 상태, GPT API 호출 성공 여부, 시스템 경고 모니터링 (Log 시스템, Metrics 활용)
3.2 Metrics & Goals Result (비즈니스 임팩트 기록)
- 자동 생성된 포스트의 트래픽 변화 기록
- 다국어 포스트의 성과 분석
3.3 Retrospective (회고 및 개선사항)
- GPT 모델의 성능 향상 방안 논의
- 시스템 안정성 개선