프로젝트 관리 (Readme & 버전 관리)

리드미(Readme)란?

① 완성된 프로그램의 설명서: 프로그램 사용 방법, 레퍼런스

② 구현중인 프로젝트의 현황: 구현된 주요 기능, 구현 현황, 코드가 해결해야 하는 문제 등

     * 리드미 파일 => 확장자만 .m(ark)d(own) 인 파일일 뿐이다. 특별한 파일이 아님. 

 

markdown 이란? 

 

ex) 위키백과, 티스토리, 노션 .. 등에서 이미 많이 사용되고 있음 

 

• 일반 사용자들도 웹에서 쉽고 예쁘게 글을 쓸 수 있게 제공하고 있는 하나의 기술
• 가독성을 높여줌
• 즉, 텍스트를 웹 기술로 바꿔주는 하나의 도구 
• 주요 목적 => 읽기 쉽게, 쓰기 쉽게 
• 특수 기호들의 조합으로 원하는 구조를 만들 수 있게 제공해줌 
• 깃허브에서 사용하는 markdown을 알고 있어야 함 ( 디스코드와 동일한 문법 )

 

리드미(Readme) 작성법

 

_기울어진 글씨_  

**굵은 글씨** 

**_기울여 굵게_**

---

# 1단계 제목

## 2단계 제목

### 3단계 제목

#### 4단계 제목

##### 5단계 제목

###### 6단계 제목

---

개행은 역슬래쉬(\\)

---

```

// 프로그래밍 코드는 줄의 제일 앞에

// 공백 3칸 이상 띄워서 쓰면 된다.

function func() {

   let a=1;

   return a;

}

```

위와 같이 작성하면 이렇게 출력되는 것을 확인할 수 있다.

 

깃(Git)

 

1. 버전이란?

: 버전은 유의미한 수정을 말함 

: 메인 버전 뿐 아니라 서브 버전도 있음 

 

2. 버전 관리의 중요성

: 어떤 부분을 수정했는지 알 수 있음

: 코드는 수정이 계속됨, 처음부터 완벽한 코드를 짜는 것은 불가

: 백업 용도로도 사용 가능

: 업무에 안정성을 부여해줌

 

3. 버전 관리 시스템(Version Control System)의 종류 

=> 버전 관리, 백업 복구, (선택) 협업

① 로컬 VCS 

: 내 컴퓨터 안에서만, 협업 불가능 

 

② 중앙집중식 VCS

: 파일을 하나씩 가져옴

: 협업 가능, 대표적인 시스템으로 SYN,CVS 등이 있음

 

③ 분산 VCS 

: 파일이 아니라 폴더를 통째로 가져오기 때문에 안정성이 높음

: 대형 프로젝트에 적합

: 대표적인 시스템으로 Git, Mecurial, Bazaar

 

---

🌟배운 점

 

리드미란 무엇이고, 어떤 역할을 하고 왜 중요한지를 배울 수 있었다. 개발자는 개발만 잘해서 되는 것이 아니라, 문서 작성도 잘해야 한다는 걸 깨닫게 되었다. 그리고 그동안의 나는 깃허브를 기록하는 용도로만 사용했었는데, 내 생각보다 훨씬 유용한 협업 툴이자 버전 관리 도구라는 것을 알게 되었다. 오늘 교육을 받으면서 버전 관리의 필요성과 중요성을 절실히 깨달은 것 같다. 확실하게 배워서 잘 써먹어야지 !