스케쥴/스터디

[항해99 취업 리부트 TIL] 1주차 3일

hyeseong-dev 2024. 5. 24. 21:28

1. 항해99 취업 리부트 코스 - 프로젝트 경험 구조화 세션

핵심 내용:

  • 체계적인 프로젝트 경험 정리 및 이력서/면접 준비를 위한 템플릿 제공
  • 템플릿 질문 기반 프로젝트 진행 시 만족도 향상

개인적 성찰:

  • 전문가의 도움을 통해 체계적인 프로젝트 경험 정리 방법 습득
  • 향후 템플릿 활용을 통한 프로젝트 진행 및 결과 정리

활용 방안:

  • 향후 프로젝트 진행 시 템플릿 질문 활용하여 계획 및 진행
  • 프로젝트 경험 정리 및 이력서/면접 준비에 템플릿 활용

2. GITHUB README 작성법 세션

새롭게 알게 된 점:

  • 효과적인 프로젝트 소개를 위한 리드미 활용 방법
  • 단순 소개가 아닌 프로젝트 매력을 드러내는 풍부한 내용 작성 필요

개인적 성찰:

  • 기존 간단한 리드미 작성 방식 개선 필요
  • 하이퍼링크 활용, 실제 코드/이미지 삽입, 트러블 슈팅 포스트 등을 통한 풍부한 내용 작성

활용 방안:

  • Infograb-좋은 Readme 작성법, 오픈소스 라이브러리 Readme(쿠버네티스 등) 참고
  • 주요 컴포넌트, 실행 이미지, 호스팅 주소, as-is/to-be 문서 등 삽입
  • draw.io, best-readme-template, docs(gitbook) 등 활용
  • 상세 설명은 docs 첨부, 핵심 내용 강조

3. README 작성법 가이드

핵심 요소:

  • 명확하고 간결한 프로젝트 소개
  • 매력적인 시각 자료 활용
  • 간편한 설치 및 사용 방법
  • 문제 해결 및 커뮤니티 지원
  • 활발한 개발 및 업데이트

구체적인 작성 가이드:

프로젝트 소개:

  • 명확하고 간결한 제목
  • 명확하고 간결한 설명
  • 핵심 키워드 목록

시각 자료 활용:

  • 스크린샷
  • 그림 및 다이어그램
  • GIF 이미지

설치 및 사용 방법:

  • 명확하고 간단한 설치 가이드
  • 단계별 사용 가이드
  • 예시 코드 제공

문제 해결 및 커뮤니티 지원:

  • 일반적인 문제 해결 방법 제공
  • FAQ 제공
  • 커뮤니티 링크 제공

개발 및 업데이트 정보:

  • 최신 버전 정보 명시
  • 주요 변경 사항 기록
  • 향후 개발 계획 제시