[챗GPT로 코딩 공부] Github README 보기 쉽게 작성하기

내일배움캠프 수료생들은 챗GPT를 어떻게 개발 공부에 활용할까요?

Jun 28, 2024

Contents

1. 항목 구성하기 2. 구체적인 항목 구성 및 작성 방법 3. 보기 쉬운 README 작성 예시 내일배움캠프가 여러분의 러닝메이트가 되어드리겠습니다

✍🏼

챗GPT, 개발 공부에 있어서 든든한 친구 같은 존재이죠. 내일배움캠프의 수강생들도 혼자 공부할 때에는 챗GPT의 도움을 받고 있는데요. 오늘은 내일배움캠프 수료생들의 챗GPT 경험담을 보고, 여러분의 개발 공부에 적용해봅시다.

Github에 README를 작성하며, 프로젝트의 전체적인 개요를 깔끔하게 정리해서 작성하고 싶었습니다. 중요한 정보를 포함하면서 한 눈에 보기 쉬운 README를 작성하는 것을 목표로 하였습니다.

1. 항목 구성하기

우선 "팀 프로젝트 README 파일에 xx 항목들을 포함하고 싶습니다. 어떤 항목을 추가로 구성하는 것이 좋을까요?" 라고 물어보았습니다.

첫 번째 질문에 대해 팀 소개 항목을 추가하는 것이 좋을 것 같다하며, 이 항목을 추가하면 프로젝트에 참여하는 팀원들을 소개하고 팀의 목표 및 역할을 설명할 수 있을 것 같다는 답변을 받았습니다.

2. 구체적인 항목 구성 및 작성 방법

두 번째 질문은 "각 항목은 어떻게 구성하고 작성해야 하나요?" 였습니다.

이에 대해 각 항목 순서와, 어떤 내용이 들어가면 좋을 것 같은지 설명해주었습니다.

팀 소개: 프로젝트에 참여하는 팀원들을 소개하고, 각 팀원의 역할과 전문성을 간략하게 설명합니다.

프로젝트 소개: 프로젝트의 목적과 목표를 설명하고, 주요 기능 또는 특징을 간략히 소개합니다.

Demo Video: 프로젝트의 동작을 시연하는 데 사용된 데모 비디오 링크를 제공합니다.

아키텍처: 프로젝트의 아키텍처를 설명하고, 시스템의 구조 및 구성 요소에 대해 자세히 설명합니다.

API 명세서: 프로젝트에서 사용되는 API의 명세서를 제공하고, 각 엔드포인트의 사용법과 응답 형식을 설명합니다.

Commit Convention: 프로젝트에서 사용되는 커밋 규칙을 설명하고, 커밋 메시지의 형식과 의미를 정의합니다.

File Structure: 프로젝트의 파일 구조를 설명하고, 각 디렉토리 및 파일의 역할을 설명합니다.

기능 구현에 대한 기술: 프로젝트에서 구현된 기능들에 대해 기술하고, 해당 기능들이 어떻게 작동하는지 설명합니다.

3. 보기 쉬운 README 작성 예시

마지막 질문은 예시였습니다. "좋은 예시를 보여줄 수 있나요?" 라고 질문했습니다.

README 작성의 예시를 답변해줬습니다. 그 중에 가장 도움이 됐던 것은 파일구조 작성에 관련한 것이었습니다.


## File Structure

ProjectName/
├── src/
│ ├── main/
│ │ ├── java/
│ │ │ ├── com/
│ │ │ │ ├── example/
│ │ │ │ │ ├── projectname/
│ │ │ │ │ │ ├── controller/
│ │ │ │ │ │ ├── service/
│ │ │ │ │ │ └── repository/
│ │ └── resources/
│ └── test/
├── build/
├── docs/
└── README.md

챗GPT가 알려준 파일 구조입니다.

다시 물어본다면 제가 작성한 README를 좀 더 보완할 수 있는 방법이 있는지 물어볼 것 같습니다. 또 xx 내용을 추가하고 싶은데 어떤 부분에 어떤 식으로 작성해서 넣으면 좋을지 물어볼 것 같습니다.

내일배움캠프가 여러분의 러닝메이트가 되어드리겠습니다

내일배움캠프의 많은 수강생들이 부트캠프 생활을 수료하고 현업에서 개발자로 활약하고 있습니다. 내일배움캠프는 모든 운영진이 교육, 특강, 12시간 밀착 케어, 찐한 관리, 인재 채용까지 열과 성을 다해 수강생들의 꿈을 지원하고 있습니다. 수많은 장애물을 넘을 수 있도록 내일배움캠프가 든든한 러닝메이트가 되어드리겠습니다. 내일배움캠프과 함께 여러분의 개발자 여정을 시작하세요.

CREDIT

글 | 이지선 내일배움캠프 수료생 편집 | 정효재 팀스파르타 에디터