테코블 팀 근로 가이드 - woowacourse/Branding GitHub Wiki

테코블 팀 근로 가이드

카드 뉴스 - 테코블

테코톡 카드 뉴스는 미리캔버스의 테코블 카드뉴스 템플릿 초안을 이용한다. 이미 테코톡 템플릿으로 제작된 카드뉴스가 있으므로 참고하여 제작한다.

과정: 파일 -> 사본 만들기

테코블의 글을 읽고 핵심 내용을 정리하여 10장 이내로 제작한다.(인스타에 한번에 업로드 가능한 사진은 최대 10장이기 때문이다.)

각 장표마다 중요한 내용을 별도의 글자색으로 강조해야 한다. 강조 글자색은 #18A8F1(파랑색)으로 통일한다. 마지막 페이지의 표지는 테코블 게시글 티저와 통일한다.

예시

카드뉴스 - 구글 드라이브

브랜딩 근로 소셜 컨텐츠 파트 구글 드라이브에 카드뉴스를 업로드한다.

테코블 카드 뉴스 폴더 아래에 테코블 포스트별 폴더를 제작하고 사진을 업로드한다. 폴더 이름은 테코블_카드뉴스_n조_포스트제목 형식으로 통일한다.

폴더 생성 후, 사진을 업로드한다. 사진을 폴더내에 순서대로 업로드한다.

테코블 - PR

테코블은 초안 작성자가 초안을 작성한 후, 담당 브랜딩 근로 크루가 검수를 하는 방식으로 이루어진다.

PR은 초안 작성자가 해도 상관은 없으나, 웬만하면 브랜딩 근로 크루가 하는 것을 추천한다.

초안은 마크다운 형식으로 작성하며, 글 내용에 첨부되는 이미지와 코드는 마크다운 문법을 이용하여 작성하도록 한다

테코블 Repo 기준 초안은 /src/content/post폴더 밑에 작성한다.

이후 src/content/avatars에 작성자의 프로필 사진을 추가한다.

프로필 사진의 경우 반드시 출입증 사진을 필요는 없으며 자유롭게 하면 된다.

예시

image

작성자의 프로필 사진을 추가하였다면 작성자의 배경 사진을 추가해야 한다.

배경 사진의 경로는 src/content/profile이다. 배경 사진 역시 정해진 형식 없이 자유롭게 설정하면 된다.

예시

image

프로필 사진, 배경사진 추가하였다면 글의 썸네일 사진을 등록해야 한다.

썸네일 사진의 경로는 src/content/teaser이다. 썸네일의 경우는 글의 내용과 연관된 사진을 첨부하는 것을 추천한다.

예시

image

썸네일 사진까지 등록이 완료되면 작성자의 정보를 src/content/author.yaml파일에 등록해야 한다.

만일, 이미 작성한 이력이 있는 작성자라면 해당 단계를 건너뛰어도 된다.

예시

image

avatar에는 프로필 사진이 저장된 경로를 적어줘야 한다. 마찬가지로 profile_image의 경우도 배경 사진이 저장된 경로를 적어줘야 한다. github에는 github 아이디만 적어주면 된다.

website는 작성자의 블로그나, 깃헙 Repo와 같이 본인을 대표할 수 있는 사이트를 기재하면 된다.

여기까지 진행한 이후 바로 PR을 제출하지 말고 반드시 로컬에서 빌드하여 제대로 초안이 잘 나오는지, 프로필 사진이나 배경사진은 잘 나오는지의 확인과정을 반드시 거쳐야 한다.

별다른 설정은 하지 않아도 되나, 혹시나 nodeJS가 없는 경우는 nodeJS를 설치하고 nodeJS의 버전이 14여야 함에 주의한다.

빌드에 필요한 명령어는 package.json의 scripts라는 부분에 있으며, build를 실행시키고 dev를 실행하면 된다

성공적으로 run이 된 경우라면, 콘솔에 localhost:8000이 보이게 된다.

예시

image image

성공적으로 빌드 시킨 이후, 작성된 글이 마크다운 문법을 정확히 준수하였는지, 글 내부의 이미지나 코드블럭은 정상적으로 보이는지, 작성자의 프로필 사진과 배경 사진은 제대로 보이는지, 글의 썸네일도 제대로 보이는지 모두 확인한다.

예시

image image

모든 것이 정상적으로 동작한다면, 테코블 Repo에 PR을 제출하고 브랜딩 근로에도 PR을 제출한다.

이때 브랜딩 근로의 PR내용에는 테코블 Repo의 PR 링크를 첨부한다.

만약 Push를 할 때 src 이하 폴더가 아닌데 변동이 된 파일은 Push할 때 반드시 제외하도록 한다. (ex. package.json, yarn.lock 등)

근로 회의 진행

근로 회의 진행일에는 미리 회의실을 예약하는 것을 원활한 진행을 위하여 강력히 권고한다.

모든 크루들은 한번씩 돌아가면서 진행자와 서기를 맡게된다. 자신이 이번 진행자였다면, 다음주에는 자신이 서기가 된다. 반대로 자신이 이번에 서기였다면 다음주에는 자신이 진행자가 된다.

처음으로 진행자 역할을 한 크루는 마지막 진행자의 차례에 서기가 됨에 주의한다.

서기 역할을 맡게 된 크루는 브랜딩 Repo에 Wiki에 마크다운 형식으로 회의록을 작성한다.

주로 각자 초안이나 최종본에 대한 피드백 내용과 다음주에 각자 할당된 부분을 작성한다.

자세한 내용은 브랜딩 근로의 위키를 참조한다.

진행자의 경우 카드뉴스 초안, 카드뉴스 최종본, 테코블 PR 순으로 진행하며 테코블 PR까지 모두 확인한 이후에는 사다리타기를 통해 카드뉴스와 테코블을 분배한다.

각자에게 다음주의 할당이 주어지면, 프로젝트의 To-Do에 등록해야 한다.

To-Do에 등록하는 방법은 To-Do 옆의 +버튼을 통해 자신에게 할당된 작업의 제목을 작성한 후 Add 버튼을 누르고 이후 점 세개 버튼을 누른 이후 "Convert To Issue"를 누르고  Assignees를 할당하면 된다

여기까지 전원이 완료하면 근로회의가 끝나게 된다.

마지막으로 근로를 진행함에 있어 잘 모르는 부분은 다른 크루에게 물어보거나, 다른 크루도 모르거나 애매한 부분은 반드시 코치님에게 상황을 공유한 후 작업을 진행하도록 한다