Skip to content

luke0408/TIL

Repository files navigation

Today I Learned

  • 매일은 아니더라도 꾸준히 공부한 기록을 남기기 위해 시작했습니다.

해당 TIL은 아래의 자료들의 영향을 받았습니다.


작성 규칙

  • 폴더와 파일명은 영문으로 작성한다.
    • 책의 이름의 경우 예외로 한글로 작성한다.
  • 고민이나 질문이 생기면 issue를 통해 과정을 기록으로 남긴다.
    • issue를 열었을 경우 관련 글에 표기한다.
    • issue는 가능한 닫지 않으며 tag를 통해 issue가 끝났음을 표기한다.
  • 더 많은 공유를 원하는 기록은 블로그를 통해 다룬다.
    • 블로그에 포스팅한 경우 주소를 명시한다.
    • 스터디 진행 내용을 정리한 경우 스터디가 끝난 후 블로그에 포스팅한다.
    • 블로그를 통해 다루는 내용의 기준
      1. 단순히 정리를 넘어 내 생각을 다루고 싶을때
      2. 한 번 정리 하는게 아니라 두고두고 봐야하는 주제일때
      3. 정리한 것만으로 이해했다고 확신이 들지 않을 때
  • 잔디를 채우는 것에 집착하지 않는다.
  • reference는 다음의 분류를 따른다.
    • issue: 해당 repo의 관련 issue를 의미한다.
    • link: 외부에서 참고한 reference를 의미한다.
  • 이전에 작성한 개념을 언급할 경우, 본문에서 해당 노트로 인라인 링크를 건다.
    • 예: TypeScript(줄여서 TS)는 [JavaScript](../JavaScript/JavaScript.md)에서 파생된 ...
  • 문서는 인용구(원문 인용)를 제외하고 한글로 작성한다.
  • 노트 제목은 설명하려는 개념만 드러나도록 짧고 명확하게 작성한다.
  • 문서는 Explicit_Type_Casting.md처럼 줄글 중심으로 작성한다.
    • 리스트는 보조 용도로만 최소 사용한다.
  • 카테고리 디렉토리(docs/<category>/, docs/<category>/<sub-category>/)는 개요 문서를 반드시 포함한다.
    • Docusaurus 공식 규약을 따라 카테고리 인덱스 파일은 README.md를 기본으로 사용한다.
    • (index.md도 동작하지만, 이 저장소 표준은 README.md)
    • 모든 README.md에는 해당 카테고리(개념)의 소개 문장이 반드시 포함되어야 한다.
  • 카테고리 내 정렬은 필수이며, sidebar_position으로 관리한다.
    • 정렬 기준은 쉬운 개념 → 어려운 개념 순서로 한다.
    • 난이도는 해당 노트를 이해하기 위해 필요한 선행 개념(관련 노트) 수가 많을수록 높은 것으로 본다.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors