1. 온보딩 가이드
- 입사 첫날 체크리스트: 필요한 서류, 사무실 출입 방법, 기본적인 IT 장비 설정 방법 등.
- 환경 설정 가이드: 개발 환경 세팅 방법 (IDE 설정, 필수 툴 설치, 로컬 서버 실행 등).
- 계정 및 접근 권한: 필요한 시스템(예: Git, Jira, Slack 등) 계정 생성 및 권한 요청 절차.
2. 개발 환경 및 워크플로우
- 프로젝트 구조 설명: 주요 레포지토리, 디렉토리 구조, 각 폴더의 역할 설명.
- 코드 컨벤션: 회사에서 사용하는 코드 스타일 가이드 (예: Python PEP8, Java의 Google Style Guide 등).
- 브랜치 전략: Git 브랜치 전략 (Git Flow, trunk-based development 등).
- 코드 리뷰 프로세스: PR 작성 시 주의사항, 리뷰 요청 및 승인 절차.
3. 배포 및 운영
- CI/CD 파이프라인 설명: 빌드, 테스트, 배포 과정 자동화 도구 사용법.
- 배포 프로세스: 배포 일정, 롤백 절차, 긴급 패치 방법 등.
- 서버 및 인프라 개요: 사용하는 클라우드 서비스(AWS, GCP 등), 서버 구조, 모니터링 툴 설명.
4. 시스템 아키텍처 및 기술 스택
- 전체 시스템 아키텍처 다이어그램: 마이크로서비스 구조, 데이터 흐름, API 게이트웨이 등 설명.
- 기술 스택 및 버전: 사용 중인 프로그래밍 언어, 프레임워크, 라이브러리, 데이터베이스 등.
- 의존성 관리: 패키지 매니저 사용법, 버전 관리 정책.
5. 테스트 및 디버깅
- 테스트 전략: 유닛 테스트, 통합 테스트, E2E 테스트 작성 가이드.
- 테스트 도구 및 프레임워크: 사용하는 테스트 도구(PyTest, JUnit 등) 및 설정 방법.
- 디버깅 팁: 자주 발생하는 이슈 및 해결 방법, 로그 분석 방법.
6. API 및 데이터베이스
- API 문서화: Swagger, Postman 등으로 문서화된 API 목록 및 사용법.
- DB 스키마 및 쿼리 가이드: 주요 테이블 설명, 자주 사용하는 쿼리, DB 접근 정책.
7. 보안 및 규정
- 보안 가이드라인: 코드 보안, 데이터 보호 정책, 인증 및 인가 처리 방법.
- 개인정보 처리 방침: 개인정보 취급 시 유의사항.
8. 협업 및 커뮤니케이션
- 팀 구조 및 연락처: 주요 팀원 소개, 각 팀의 역할 및 연락처.
- 회의 문화 및 일정: 정기 회의 일정, 회의록 작성 방법, 회의 툴 사용법(Zoom, Google Meet 등).
- 커뮤니케이션 채널: 슬랙, 이메일, 기타 협업 도구 사용법 및 에티켓.
9. 자주 묻는 질문 (FAQ)
- 초기 설정 시 자주 겪는 문제와 해결 방법.
- 개발 중 자주 발생하는 이슈 및 해결 방법.
- 회사 정책 및 절차 관련 자주 묻는 질문.
10. 추가 리소스 및 참고자료
- 내부 교육 자료: 사내 기술 세미나 자료, 개발 관련 참고 문서.
- 외부 리소스 링크: 관련 기술 블로그, 공식 문서 링크 등.