TIL 2024-04-08

💻 Today I Learned

• 간단 요약
• 💻 Today I Learned
  • 1. 프로젝트
  • 2. 버전관리
    • 3. README (리드미)

1. 프로젝트

• 프로젝트 란?

  • 하나의 프로그램 및 시스템을 만들기 위한 일련의 프로세스
  • 개발쪽에서는 위와 같이 ‘제작’과 같은 성격의 공동활동에 프로젝트의 의미를 부여하지만, 개인적인 경험으로는 동료들과 무엇인가를 진행하는 그 자체에 프로젝트라는 의미를 부여 하고 있다.

• 프로젝트 진행 시 중요사항

  • 문서공유!
  • 코드공유!
  • 팀원 과의 소통
  • 코드리뷰 (개인적으로 중요하다고 생각)
  • 진행률 공유(개인적으로 중요하다고 생각)
  • 공유라는 활동 자체가 프로젝트 전반에 제일 중요한 작업중 하나라고 생각 된다.

• 코드리뷰를 중요하게 생각하는 이유

  • 전 직장에 있었을 때, 웹은 아니었지만, 서로의 코드를 보지 못하고 개발을
    완료한 상태에서 운영자에게 간단히 인수인계만 한 뒤 소스를 넘겨주는 식의
    운영을 진행한 적이 있는데,
    워낙에 리뷰없이 서로 신뢰로 진행하던 개발이다 보니까, 개발 당사자만 알게되는
    디테일한 부분들을 공유할 수 없었던 것 같다.
    그래서, 코드 리뷰를 통해 이 사람은 이부분을 이렇게 해결했고, 이 정보를 통해
    더 나은 코드를 발굴할수도, 또는 리뷰어가 깨달음을 얻을 수도 있다는 것을 깨달았다.

2. 버전관리

버전 관리(영어: version control, revision control) 또는 소스 관리(영어: source control)혹은 소스 코드 관리(영어: source code management)는 동일한 정보에 대한 여러 버전을 관리하는 것을 말하는데 공학과 소프트웨어 개발에서 팀 단위로 개발 중인 소스 코드나, 청사진 같은 설계도 등의 디지털 문서를 관리하는데 사용된다. (출처 : 위키피디아)

• 버전 관리는 위의 설명과 같이 소스코드 또는 문서의 버전을 관리하는 것을 말한다.

• 버전 관리 시스템(VCS)의 장점

  • 버전 관리 자체에 이점이 있다.
  • 원하는 버전으로 Roll Back이 가능하다 (복구)

  • 협업하기에 용이하다.

  • 개인적으로 Github를 통해서 협업을 해본 경험은 없으나, 혼자 다른 물리장치에서 나의 코드를 최신화하여 사용해야 할 때, 협업의 용이함을 느껴본것 같다.

• 버전 관리 시스템의 종류

  • 로컬형
    • 한대의 물리적 장치 (본인만 사용하는) 에서 버전을 관리
    • 자체 PC
  • 중앙집중형
    • 서버에 최종본만을 남겨두는 방식을 택함, 사용자는 필요한 파일만 로컬에 다운로드 후 수정 하는 방식. 관리자의 관점에서는 히스토리 추적이 용이하다.
    • 중앙서버 의존적인 면이 상당히 강하다.
    • SVN
    • CVS
  • 분산형
    • 수정을 위해 프로젝트 전체를 로컬에 다운로드 해야한다.
    • 중앙서버 다운 -> 사용자는 로컬에서 작업 가능
    • 수정시, 타 사용자와의 충돌 걱정없음
    • 수정파일 업로드 시, Merge 과정에서만 충돌을 예방해주면 된다.
    • Git
    • Mercurial,
    • Bazaar

3. README (리드미)

• 나는 직장에서 공통 프레임워크를 제작할 때, README.md를 작성한 경험이 존재한다.

• 다만 이번 시간에서 리드미가 정확히 어떤 역할을 할 수 있는지를 좀 더 알게되었다.

• README의 역할

  • 설명서
  • 기능 구현서
  • 현황 설명서
  • 기술서
  • 사용 설명서
  • 이슈 및 리포트
  • 레퍼런스 및 참고사항 안내

• 리드미 작성법

  • 리드미는 Markdown 으로 작성되는 것이 제일 보기 좋다(동의함)

  • Markdown 문법은 생각보다 쓰기 편하다.

  • 마크다운 문법 참조 : 마크다운 사용법

  • 마크다운은 실질적으로 Text To HTML 이다.
    편하게 HTML 식 표현을 하기위한 문자 표현법과 같다고 생각한다.

  • 마크다운 문법을 지원하는 플랫폼 마다 세부 문법은 다를 수 있다.

# 제목 1 = h1
## 제목 2 = h2
### 제목 3 = h3
#### 제목 4 = h4
##### 제목 5 = h5
###### 제목 6 = h6

- UnOrdered List = <ul>
1. Order List = <ol>

> 인용문 작성

# 코드 블록
'```javascript'
const title = '프로그래머스 풀스택';
console.log(title);

'```'

--- = <hr> (수평선)
[링크](URL)

*Test* // 기울여 쓰기
_Test_ // 기울여 쓰기
**Test** // Bold 체
__Test__ // Bold 체
~~Tent~~ // 

• Test
• Test
• Test
• Test

• Test

• 줄바꿈은 문장 마지막에 3칸이상 띄어쓰기!