GREEN나무 2025. 3. 17. 22:51
728x90

🔵 자료 정리: 효과적인 프로젝트 정리 및 문서 작성 가이드


🛠 1. 자료 분류하기

📌 "일단 다 쓰기"


🔍 2. 재료 분류하기

📌 "간단한 구현 vs. 트러블슈팅"

간단한 구현

  • CRUD 또는 일반적인 라이브러리 활용
  • 예: 댓글(대댓글), 좋아요, 회원가입, 카테고리 분류

트러블슈팅

  • 직접 문제를 정의하고 해결한 사례
  • 예: 이미지 리사이징 최적화, 렌더링 개선, 대용량 데이터 응답 처리

✂️ 3. 재료 다듬기

📌 “Why - How - What 확인하기”

Why (목적): "왜 이 기능이 필요했는가?"
How (과정): "어떤 방법을 사용했는가?"
What (결과): "구현 또는 개선 후 어떤 변화가 있었는가?"

💡 핵심: 문제 정의 → 해결 방법 → 성과를 논리적으로 연결


📌 4. 프로젝트에서 내가 한 것 vs. 팀에서 한 것 정리 방법

1) 핵심 기능 (공통적인 기능)

📌 우리 팀 프로젝트에서 가장 중요한 기능
📌 내가 직접 구현하지 않았더라도, 프로젝트 이해도를 보여주기 위해 포함
📌 예:

  • 실시간 채팅
  • 지도 API 연동
  • AI 추천 알고리즘

2) 담당 기능 (내가 한 것)

📌 내가 직접 구현/개선한 기능
📌 서비스의 목적과 내 기술적 기여도를 명확히 표현
📌 예:
"어떤 서비스인지 알리는 목적"

  • "이 서비스는 [서비스 설명]을 제공하는 프로젝트입니다."

"내가 실제로 구현/개선한 기능"

  • "소셜 로그인 구현 (Google, Kakao, Naver OAuth 적용)"
  • "Redis 캐싱을 활용한 검색 최적화 (쿼리 속도 70% 개선)"
  • "WebSocket을 활용한 실시간 채팅 기능 구현"

"나의 기술적 수준을 알리는 목적"

  • "NestJS + TypeORM을 활용한 API 설계"
  • "JWT 기반 인증 및 보안 강화 (XSS 방어 적용)"
  • "ElasticSearch 도입하여 검색 성능 개선"

🏆 5. 골든 서클 이론 적용

✅ 1) 올바른 정리 방법 (Do)

📌 Why: "중고 거래를 위해 유저 간 실시간 소통이 필요했어요."
📌 How: "WebSocket을 활용해 채팅 시스템을 구축했습니다."
📌 What: "트래픽 관리 최적화와 함께 실시간 메시지 전송이 가능해졌습니다."

💡 정리하면:

  • "유저 간 실시간 채팅 기능 구현"
  • "양방향 통신을 위해 WebSocket 적용"

2) 잘못된 정리 방법 (Don’t)

📌 What: "중고 거래 서비스에서 채팅을 구현했습니다."
📌 How: "WebSocket을 사용했습니다."
📌 Why: "유저 간 소통을 위해 필요했으니까요."

💡 문제점:

  • 결과부터 말하면 논리적 흐름이 어색해짐
  • 기술적 의사결정 과정이 보이지 않음

📌 6. 최종 정리 가이드

팀 프로젝트의 핵심 기능과 내가 한 일을 구분해서 정리
기능을 설명할 때 "Why → How → What" 순으로 정리
내 기술적 기여도를 강조할 때는 기술 스택과 개선 효과를 포함
검색 최적화, 보안 개선, 성능 개선 등 중요한 트러블슈팅 경험을 강조

📌 이제 정리된 내용을 활용하면 문서 작성이 훨씬 효과적일 거예요! 🚀