[Github] 조직(Organization) Readme 작성하기

 

저는 평소에 다양한 팀프로젝트를 진행하면서 Github 조직을 생성하고 운영하곤 합니다. 이번 블로그에서는 Github Organization에서 README 파일을 만드는 방법에 대해 알아보겠습니다.

 

---

 

GitHub Organization(조직)이란?

GitHub Oraganization(조직)은 여러 사용자들이 협업할 수 있는 공간을 제공합니다. 기업이나 팀 단위로 프로젝트를 관리하고, 다양한 권한을 설정하여 협업을 효율적으로 진행할 수 있도록 합니다. GitHub Organization을 사용하면 개인 계정의 Repository를 사용하는 것보다 프로젝트 관리나  협업이 용이합니다.

 

저 같은 경우에도 하나의 프로젝트에서 Front-end, Back-end, AI 등등 다양한 Repository가 필요할 경우 혹은 다양한 사람들과 협업할 경우 Github 조직을 자주 활용하곤 합니다. 

 

README 파일의 중요성

README 파일은 GitHub Organization에서 가장 먼저 보이는 화면이기 때문에 프로젝트의 입구와 같은 역할을 합니다. 이 파일에는 프로젝트의 개요, 설치 방법, 사용법, 팀원 등을 기술하여 다른 개발자들이 쉽게 이해하고 사용할 수 있도록 해야 합니다.

 

조직 README 파일 생성 과정

1. Organization에. github Repository 생성

먼저 Organization에 .github라는 이름의 새 Repository를 생성해줍니다.

이때 중요한 것은 공개 범위를 꼭 public으로 생성해줘야 합니다. 

.github repository 생성

 

 

2. .github 레포지토리 내 profile 폴더 생성

이렇게 Repository를 생성하고 나면 profile 폴더 내에 README.md라는 파일을 만들어서 업로드해 주게 되면, readme.md에 있는 내용이 조직의 첫 화면에서 보이게 됩니다. 

profile 폴더 생성

 

3. profile 폴더 내에 README.md 파일 생성

README.md 파일 생성

 

이렇게 쉬운 방법으로 Repository 내의 readme 파일을 생성할 수 있습니다. 

 

이렇게 생성된 파일은 organization으로 이동했을 때 바로 첫 화면에서 확인하실 수 있습니다!

 

 

---

실제 사례

저희 프로젝트에서 사용했던 README.md 파일에 대해서 예시를 들려고 합니다!

 

아래 링크로 들어가시면 더욱 자세한 내용을 확인하실 수 있습니다 ㅎㅎ

https://github.com/SSAFY-Sembot

SSAFY-Sembot

 

 

저희 프로젝트의 README.md 파일은 크게, 

1. 프로젝트 개요

2. 프로젝트 소개

3. 프로젝트 목표

4. 주요 기능

5. 팀원 소개

6. 기술 스택

7. 문서 자료

와 같은 구조로 이루어져 있습니다!

 

저는 다양한 이미지와 gif, 링크 등을 활용하여 README.md를 꾸며보았습니다.

 

간단한 코드로 예시를 들자면 다음과 같은 코드들을 활용하였습니다!

### SEMBOT - 사내 규정 챗봇 서비스

<div align="center">
  <h1>SEMBOT - 사내 규정 챗봇 서비스</h1>
  <p>🔍 LLM 기반 사내 규정 챗봇 서비스 🔍</p>
</div>

<br/>

<div align="center">
  <img src="./assets/Main.png" alt="Main" style="border-radius: 10px;"/>
</div>

<br/>

<div align="center">
  <a href="">홈페이지</a>
  &nbsp; | &nbsp;
  <a href="">Swagger</a>
</div>

---

## ✍️ 프로젝트 개요

- **프로젝트명:** SEMBOT
- **프로젝트 기간:** 2024.10 ~ 2024.11.19
- **프로젝트 형태:** 기업 연계 프로젝트
- **목표:** 기존 키워드 기반 챗봇의 한계를 극복하고, 사내 업무 규정 및 절차에 대한 정확하고 유연한 정보를 제공하는 LLM 기반 챗봇 서비스 개발
- **주요 타겟 사용자:** 사내 직원 

---

## ✍️ 프로젝트 소개

### 프로젝트 배경

사내에서 업무 절차 및 규정을 확인하는 기존 프로세스는 다음과 같은 문제점이 있었습니다:

1. **비효율적인 정보 탐색** 

2. **기존 챗봇의 한계** 

3. **규정 관리의 비효율성** 

**SEMBOT**은 위 문제를 해결하기 위해 LLM(Large Language Model)과 RAG(Retrieval-Augmented Generation) 기술을 활용하여 자연어를 이해하고, 최신 규정 정보를 기반으로 신뢰도 높은 답변을 제공하는 서비스입니다.

---

## 🚀 프로젝트 목표

1. **업무 효율성 향상** 

2. **사용자 경험 강화** 

3. **확장 가능성 확보** 

---

## 📌 주요 기능

### **0. 회원가입 | 로그인**

#### **회원가입**

<div align="center">
<img src="./assets/회원가입.gif" alt="회원가입" style="border-radius: 10px; width: 700px;"/>
</div>

---

## 🧑‍💻 팀원 소개

| **이름**    | **역할**        | 
|:-----------:|:---------------:|
| 이서빈      | BE/FE           | 

---

## ⚙️ 기술 스택

<table>
  <thead>
    <tr>
      <th>분류</th>
      <th>기술 스택</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>프론트엔드</td>
      <td>
        <img src="https://img.shields.io/badge/React-61DAFB?style=flat&logo=react&logoColor=white"/>
        <img src="https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white"/>
      </td>
    </tr>
  </tbody>
</table>


---

## 📂 문서 자료

- [포팅 메뉴얼](https://github.com/SSAFY-Sembot/Sembot/blob/develop/exec/%ED%8F%AC%ED%8C%85%EB%A7%A4%EB%89%B4%EC%96%BC.md)

---

 

---

마무리

다양한 이미지, gif, github에서 제공해 주는 태그 등을 활용하면 더욱 풍성한 README.md를 만들 수 있으니 참고하셔서 예쁜 프로젝트의 포트폴리오를 만들어주시길 추천드립니다.