Commandgeneral

/tech-report Command

기술 이슈, 버그 수정, 기능 구현에 대한 상세 리포트를 생성합니다

View Source

Technical Report 생성

참고: AgentRule/REPORT_AGENT.md

실행 내용

  1. 문제/이슈 파악
  2. 관련 코드 분석
  3. 원인 진단
  4. 해결 방안 도출
  5. 구조화된 리포트 작성 및 저장

작업 지시

다음 절차를 따라 Technical Report를 생성하세요:

1. 리포트 주제 확인

사용자가 요청한 내용을 파악합니다:

  • 해결한 버그/이슈
  • 구현한 기능
  • 리팩토링 내역
  • 성능 최적화 등

2. 파일명 및 경로 설정

디렉토리: Documents/Planning/Report/ 파일명: YYYY-MM-DD_문서제목.md

예시:

  • 2025-11-09_로딩시스템_게스트플레이어_이슈리포트.md
  • 2025-11-09_AI_Navigation_최적화.md

중요:

  • 날짜는 YYYY-MM-DD 형식
  • 한글 파일명 사용 (가독성 우선)
  • 공백 대신 언더스코어 사용

3. 리포트 구조

다음 구조로 문서를 작성합니다:

# [문서 제목]

**작성일**: YYYY-MM-DD
**작성자**: [작성자명 또는 Claude AI Assistant]
**카테고리**: [Network / UI / Gameplay / System / Performance 등]
**심각도**: [Low / Medium / High / Critical]

---

## 📋 목차

1. [문제 개요](#1-문제-개요)
2. [시스템 아키텍처](#2-시스템-아키텍처)
3. [문제 원인 분석](#3-문제-원인-분석)
4. [해결 방안](#4-해결-방안)
5. [코드 수정 내역](#5-코드-수정-내역)
6. [테스트 가이드](#6-테스트-가이드)
7. [학습 포인트](#7-학습-포인트)

---

## 1. 문제 개요

### 1.1 증상
- **현상**: [무엇이 일어났는지]
- **재현**: [어떻게 재현하는지]
- **영향**: [어떤 영향이 있는지]

### 1.2 관련 시스템
- [관련된 클래스, 시스템 나열]

---

## 2. 시스템 아키텍처

### 2.1 [시스템명] 구조

\`\`\`
[아키텍처 다이어그램 - ASCII 또는 Mermaid]
\`\`\`

---

## 3. 문제 원인 분석

### 3.1 핵심 문제
[문제의 본질을 한 문장으로]

### 3.2 상세 분석
[단계별 상세 분석]

#### 3.2.1 [세부 원인 1]
[코드 예시와 함께 설명]

#### 3.2.2 [세부 원인 2]
[코드 예시와 함께 설명]

---

## 4. 해결 방안

### 4.1 해결 전략
[어떤 접근 방식을 선택했는지]

### 4.2 해결 로직
[구체적인 해결 방법]

\`\`\`cpp
// 코드 예시
\`\`\`

### 4.3 해결 후 플로우
[수정 후 동작 방식]

---

## 5. 코드 수정 내역

### 5.1 수정 파일
- \`경로/파일명.cpp\`

### 5.2 수정 위치
- 함수: \`FunctionName()\` (Line XXX)

### 5.3 수정 전 코드
\`\`\`cpp
// 문제가 있던 코드
\`\`\`

### 5.4 수정 후 코드
\`\`\`cpp
// 수정된 코드
\`\`\`

### 5.5 핵심 변경 사항
1. [변경 사항 1]
2. [변경 사항 2]

---

## 6. 테스트 가이드

### 6.1 테스트 시나리오
[각 시나리오별 테스트 방법]

### 6.2 디버깅 로그 체크리스트
[확인해야 할 로그]

### 6.3 Output Log 필터링
[유용한 로그 키워드]

---

## 7. 학습 포인트

### 7.1 [학습 주제 1]
[관련 개념 설명]

### 7.2 [학습 주제 2]
[관련 개념 설명]

---

## 8. 결론

### 8.1 요약
- **문제**: [한 줄 요약]
- **원인**: [한 줄 요약]
- **해결**: [한 줄 요약]
- **효과**: [한 줄 요약]

### 8.2 핵심 교훈
1. [교훈 1]
2. [교훈 2]

---

**문서 버전**: 1.0
**최종 수정일**: YYYY-MM-DD

**참조 파일**:
- \`경로/파일1.cpp\`
- \`경로/파일2.h\`

4. 디렉토리 생성

Documents/Planning/Report/ 디렉토리가 없으면 생성합니다:

mkdir -p Documents/Planning/Report

5. 리포트 작성

위 구조를 따라 마크다운 파일을 작성합니다.

필수 포함 요소:

  • ✅ 발생 이슈 (Issue)
  • ✅ 발생 원인 (Root Cause)
  • ✅ 수정 내역 (Solution)
  • ✅ 테스트 가이드 (Testing)

선택적 요소:

  • 플로우 다이어그램
  • 성능 측정
  • 학습 포인트 (교육 목적)

6. SUMMARY.md 업데이트 (선택)

Documents/SUMMARY.md에 리포트를 추가합니다:

## Planning & Reports

### Technical Reports
* [2025-11-09 [제목]](Planning/Report/2025-11-09_제목.md)

7. 사용자에게 완료 알림

리포트 작성 완료를 알립니다:

✅ Technical Report가 작성되었습니다.

파일: Documents/Planning/Report/YYYY-MM-DD_제목.md

---

**간소화 버전**:
간단한 이슈의 경우 다음과 같이 축약 가능합니다:
- 문제 → 원인 → 수정 → 테스트 (4개 섹션만)

중요:

  • 리포트는 객관적이고 기술적으로 작성
  • 코드 블록에 언어 지정 (cpp, python 등)
  • 명확하고 간결하게
  • 단계별로 논리적으로 전개