브랜딩 근로 가이드 - woowacourse/Branding GitHub Wiki

브랜딩 근로 가이드

카드 뉴스 - 테코블

테코블 카드 뉴스는 미리캔버스의 테코블 카드뉴스 템플릿 초안을 이용한다.

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

카드뉴스에는 테코블을 읽고 중요한 내용을 요약하여 정리한다. 글자가 너무 많으면 가독성이 떨어지므로 주의하자.

각 장표마다 중요한 내용을 별도의 글자색으로 강조해야 한다. 글자색은 #18A8F1(파랑색)으로 통일한다.

주의점

카드뉴스의 특성 상 전체 분량은 10페이지 이내로 한다.(인스타에 한번에 업로드 가능한 사진은 최대 10장이기 때문이다.)

첫 페이지에는 테코블 포스트의 태그, 포스트, 작성자를 담는다. 이 때, 작성자의 프로필 이미지는 테코블 프로필 이미지와 통일한다.

마지막 표지에는 테코블 포스트의 티저 사진을 첨부한다.

예시

카드뉴스 - 구글 드라이브 업로드

브랜딩 근로 소셜컨텐츠파트 드라이브에 카드뉴스를 업로드한다. 테코블 카드 뉴스 폴더 아래에 포스트별 폴더를 생성한 뒤 이미지를 업로드한다. 이 때, 폴더 네이밍은 테코블_카드뉴스_n조_작성자_제목 으로 통일한다.

예시

테코블 - PR

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

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

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

PR을 올리기까지 작업 순서는 다음과 같다.

글 초안 등록 -> 글의 썸네일 사진 등록 -> 작성자의 프로필 사진 등록 -> 작성자의 배경 사진 등록 -> 작성자 정보 등록 -> PR 제출

글 초안 등록

글의 초안은 /src/content/post폴더에 작성한다.

layout - post로 고정한다. (마크다운 글이 /src/templates/post.tsx 컴포넌트로 변환되기 때문이다)
title - 제목을 적는다.
author - [n기_크루이름]을 적는다. 여러명도 가능하다. ex) [5기_코난, 5기_에이든]
tags - [넣고, 싶은, 태그]를 적는다.
date - YYYY-MM-DDTHH:mm:ss.sssZ(ISO-8601) 형태로 적는다. (자바스크립트 Date 객체를 생성할 때의 인수이다.)
draft - false로 고정한다. (~~true로 하면 글이 안보일 것이다..~~)
image - ../teaser/your-thumbnail.jpg(글의 썸네일 경로)를 적는다.

글 초안 예시

---
layout: post
title: 선착순 티켓 예매의 동시성 문제: 잠금으로 안전하게 처리하기
author: [5기_애쉬]
tags: [concurrency, lock]
date: 2023-09-18T12:00:00.000Z
draft: false
image: ../teaser/ash-concurrency.png
---

글 내용은 여기서부터 작성하면 됩니다.

글의 썸네일 사진 등록

썸네일 사진의 경로는 src/content/teaser이다.

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

썸네일 사진을 넣으면서 글 초안의 image 부분에 썸네일 경로(../teaser/your-thumbnail.jpg)를 정확하게 작성했는지 다시 한 번 확인하자.

글의 썸네일 예시

작성자의 프로필 사진 등록

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

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

작성자의 프로필 사진 예시

작성자의 배경 사진 등록

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

src/content/profile에 작성자의 배경 사진을 추가한다.

배경 사진 역시 정해진 형식 없이 자유롭게 설정하면 된다.

참고로 배경 사진은 작성자를 클릭했을 때 상세 정보에 나오는 사진이다. ex) https://tecoble.techcourse.co.kr/author/5-기-애쉬/

작성자의 배경 사진 예시

작성자 정보 등록

src/content/author.yaml파일에 작성자의 정보를 등록해야 한다.

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

name - 글 초안을 작성했을 때 author 필드와 같이 n기_크루이름을 작성하면 된다.
avatar - 작성자의 프로필 사진의 경로를 작성한다. ex) avatars/scent.jpeg
bio - 자기 소개를 간단하게 적는다.
github - github id를 적는다.
website - 작성자의 블로그와 같이 본인을 대표할 수 있는 사이트를 기재한다.
location - 거주지를 작성한다.
profile_image - 작성자의 배경 사진 경로를 작성한다. ex) profile/scent.jpg

작성자 정보 예시

- name: 5기_센트
  avatar: avatars/scent.jpeg
  bio: 우아한테크코스 5기 센트(김영우)입니다 :)
  github: kyw0716
  website: https://velog.io/@kyw0716
  location: Seoul
  profile_image: profile/scent.jpg

PR 제출 전 확인사항

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

테코블을 실행하려면 Node.js 18 이상의 버전이 설치되어 있어야 한다.

# 패키지 설치
npm ci

# 개발환경 실행
npm start

npm ci로 패키지를 먼저 설치하고, npm start를 통해 개발환경을 성공적으로 실행하면, 콘솔에 localhost:8000이 보이게 된다.

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

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

모든 것이 정상적으로 동작한다면, (맞춤법 검사기도 돌려보고..) 테코블 레포지토리에 PR을 제출한다.

테코블 싸이클

테코블은 '파이프라이닝'식 싸이클을 돌린다. (일명 풍차돌리기)

해당 싸이클을 적용함으로써 한 조에서 1주일에 1개의 포스트가 올라가도록 한다.

테코블 외부인원 기고

테코블 브랜딩 크루들이 한 번씩 글을 작성하는 경험을 한 후, 본인의 테코블 작성 차례에 외부 인원의 기고를 받을 수 있다.

모집 양식은 5기 구글폼을 참고한다.

주제 선정 기준은 아래와 같다.

기존 테코블 포스트들과 중복되지 않는 주제
(레벨 3,4의 경우) 우테코 프로젝트 경험이 담긴 주제

근로 회의 진행

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

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

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

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

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

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

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

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

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

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

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