BEHWANG

[기획 단계]
(기획서 / 요구사항정의서)
   ↓
[설계 단계]
(시스템 설계서 / DB 설계서 / API 명세서)
   ↓
[개발 단계]
(코드 / 단위테스트 / 개발가이드 / 형상관리문서)
   ↓
[테스트 단계]
(QA 시나리오 / 테스트 결과보고서)
   ↓
[운영 단계]
(운영 매뉴얼 / 배포 문서 / 유지보수 기록)

📄 예시 1 — 유지보수 이력서

# 유지보수 이력서 (Maintenance Log)
프로젝트: 직원 근태 관리 시스템

| 날짜 | 수정 내용 | 담당자 | 비고 |
|------|------------|--------|------|
| 2025-12-05 | 로그인 세션 만료 시간 수정 (24h → 48h) | 이개발 | 정상 작동 확인 |
| 2025-12-10 | 리포트 PDF 생성 속도 개선 | 이개발 | 2초 → 0.8초 |
| 2025-12-15 | 보안 패치 적용 (FastAPI 0.110 → 0.111) | 이개발 | 안정화 완료 |

📄 예시 2 — 오류 보고서

# 오류 보고서 (Error Report)
오류 발생일: 2025.12.08
오류 내용: 출근 버튼 클릭 시 500 서버 에러 발생
원인 분석: check_in 필드 NULL 값 처리 누락
조치 내용: DB 모델에서 default 값 추가
결과: 정상 작동 확인

📄 예시 3 — 릴리스 노트

# Release Note v1.3.0 (2025-12-20)
### 추가
- 관리자용 월별 통계 페이지 추가
- Slack 알림 기능 개선

### 수정
- 로그인 오류 메시지 개선
- 리포트 다운로드 버그 수정

### 성능
- API 응답속도 평균 0.6초 → 0.4초로 개선

.

① 배포 가이드 (OPS_GUIDE.md)

“내가 다음에 똑같이 배포하려면 뭘 해야 하지?”를 정리한 문서

# 배포 가이드 (OPS_GUIDE.md)

서버: AWS EC2 (Ubuntu 24.04)
배포 방식: Docker Compose

## 1. 코드 업데이트
$ git pull origin main

## 2. Docker 빌드
$ docker build -t myapp:v1.0.0 .

## 3. 실행
$ docker compose up -d

## 4. 상태 확인
$ curl http://localhost:8000/healthcheck

## 5. 롤백 방법
$ docker image ls
$ docker run myapp:v0.9.9

② 배포 로그 / 결과 기록 (DEPLOY_LOG.md)

“언제, 어떤 버전이, 어떤 서버에 올라갔는지” 기록

# 배포 로그
2025-10-27 | v1.0.0 | AWS EC2 | ✅ 성공
2025-11-10 | v1.1.0 | AWS EC2 | ✅ 성공 (PDF 리포트 기능 추가)
2025-11-20 | v1.1.1 | AWS EC2 | ⚠️ 실패 (DB 연결 오류) → 롤백
2025-11-21 | v1.1.2 | AWS EC2 | ✅ 성공 (DB 설정 수정)