오늘은
깃헙 ReadMe 작성법 강의를 마지막으로 공부를 마무리했습니다!
강의를 들으면서 제 방식대로 정리한 ReadMe 작성법에 대해 정리해보겠습니다.
깃허브 리드미란 ?
리드미는 프로젝트나 소프트웨어에 대한 중요한 문서 중 하나로, 사용자들에게 프로젝트를 이해하고 활용할 수 있도록 도움을 주는 역할을 한다. 이 문서는 개발자들 간의 소통을 강화하고, 프로젝트의 성공적인 사용을 지원하는데 핵심적인 역할을 수행한다.
따라서, 리드미는 프로젝트의 핵심 기능, 설치 방법, 사용 예제, 문제 해결 방법 등을 담고 있어야한다.
또한, 프로젝트에 참여하거나 기여하고자 하는 사람들에게도 유용한 정보를 제공해야 한다.
리드미의 정의를 보면 알 수 있듯이, 리드미는 개발자들 간의 소통을 강화하는 역할도 있지만, 프로젝트를 이해하고 정확하게 사용할 수 있도록 설명해주는 설명서이기도 하다.
이게 중요한 이유는 채용담당자가 우리의 프로젝트를 보는 첫 인상이기 때문입니다!
이는 우리 프로젝트에 대한 개괄을 제공하고 흥미를 유발하기에 중요합니다.
그럼 리드미는 어디에 위치해야할까요 ??
일반적으로 프로젝트 루트 디렉토리에 위치합니다.
리드미가 좋은 이유는 MarkDown문법을 지원하기 때문입니다.
물론 이러한 마크다운 문법을 익혀야지 읽기 좋은 리드미를 만들 수 있습니다 !!
저도 사용하여 이쁜 리드미를 만들고 싶은데 검색해서 해봐도 어렵긴 하더라구요 ......... ㅠ^ㅠ
리드미를 잘 써야하는 이유는 다음과 같습니다.
첫째, 프로젝트에 대한 이해를 촉진한다.
둘째, 협업 능력을 강조할 수 있다.
셋째, 기술 스택 및 도구 사용을 설명할 수 있다. 이를 통해 지원하는 기업이 원하는 기술 요구사항과 부합하는지 확인 가능하다.
넷째, 문서화 및 소통 능력을 강조할 수 있다.
★다섯째 ★ , 포트폴리오를 강화할 수 있다. 프로젝트의 핵심을 간결하게 전달하는 역할을하므로, 면접관이 이를 통해 프로젝트에 대한 사전 이해를 할 수 있도록 도와준다. 그리고 이는 면접 성과에 긍정적인 영향을 미칠 수 있다.
주로 정리해야 할 것은 무엇일까 ?
1. 프로젝트의 주요 기능과 목적
2. 설치 실행 방법
- 만약 우리의 프로젝트가 외부 컴포넌트(redis, db) 등을 사용한다면 해당 컴포넌트의 이미지를 포함하여 docker compose 파일을 만들어둔다. -> 면접관의 컴퓨터는 우리의 local같이 모든 프로그램이 갖춰져 있는 환경이 아니기 때문이다.
3. 변경 로그의 링크
4. 사전 요구사항 (주차별 요구사항 문서를 베이스로 문서화 추천) -> 일정별로 어떤 요구사항이 있었고, 그 요구사항을 해결하기 위해 어떻게 했는지에 대해서 문서화
5. 인프라, 배포환경 관련이미지(draw.io로 그리기 좋음)
* 백엔드 readme : 프론트의 랜딩페이지를 보여줄 필요는 없다. API 명세서면 충분하지 않을까 ? .. 이부분은 좀 더 검색
도움될만한 사이트
draw.io(https://app.diagrams.net/)
리드미 템플릿
https://hanghae99.spartacodingclub.kr/reboot
IT 커리어 성장 코스 항해99, 개발자 취업부터 현직자 코스까지
항해99는 실무에 집중합니다. 최단기간에 개발자로 취업하고, 현직자 코스로 폭발 성장을 이어가세요. 실전 프로젝트, 포트폴리오 멘토링, 모의 면접까지.
hanghae99.spartacodingclub.kr
항해99 취업 리부트 코스를 수강하고 작성한 콘텐츠 입니다.