시작하기(위키)

안녕하세요 위키팀의 치즈입니다.

마인크래프트 서버의 위키를 3월 중순부터 관리하면서 위키를 작성하는법, 전체적인 내용을 구성하는법, 제가 위키를 작성하면서 신경쓴 부분 등을 빠짐없이 작성해보려합니다. 6월 즈음에 급하게 인수인계 파일을 만들어봤을때 형식을 지켜 핵심만 전하려고 하다보니 위키작성을 직접 하기에는 어려울 수도 있겠다는 생각을 했기 때문에 최대한 세세하게 제 의도와 이야기를 서술해보려 합니다.

시작하기

베어위키는 베어타운의 여러 정보를 정리하여 제작한 페이지로 Gitbook 플렛폼을 이용하고 있습니다. 위키 관리자는 베어위키를 관리하며 변경된 정보를 수정하고 새로 패치된 내용을 추가하는 작업을 진행합니다. 이를 위해서 항상 패치노트를 숙지하고 현재 위키에 대해서 숙지하고 있어야 합니다.

Gitbook 계정 공유받기

위키를 작성하기 위해서는 Gitbook 수정 권한이 있는 계정으로 로그인하여야 합니다. Gitbook 같은 경우 특성상 계정당 과금이 이루어지고 있고 위키 관리자가 여러번 변하고 잠깐씩 수정에 참여하는 인원이 많은 관계로 현재 공유계정을 통해 관리하고 있습니다.

다른 위키 관리자 또는 어드민에게 아이디와 비밀번호를 공유받을 수 있으며 인증이 필요할 수 있습니다.

위키 작성 규칙

위키 특성상 여러 사람이 작업에 참여하게 됩니다. 문서 작성에는 개인적인 취향이나 방식이 있을 수 있지만 통일된 방식으로 작업해야 읽는 사람이 더 이해하기 편하고 가독성이 높습니다. 가급적 지켜주셨으면 하는 규칙과 위키 관리자 치즈가 작업하는 방식을 나눠서 정리하였습니다.

전자를 먼저 서술하겠습니다.

1 ~요 와 ~다 규칙

위키를 읽는 독자에게 말하는 것과 같은 문장에는 ~요 체를 사용합니다.
무언가 하도록 제시하고 조금 더 부드럽게 표현할 수 있습니다. 
ex) 제작 직업으로 여러가지 기본재를 만들어 보세요.
ex) 다른 사람에게 욕설을 하면 안돼요.

정보성 문구는 ~다 체를 사용합니다. 베어타운의 컨텐츠가 방대한만큼 정보성 문구로 작성하게 되는 경우가 많습니다. 
ex) /옵션 으로 여러 옵션을 지정 할 수 있는 gui 를 열 수 있습니다.
ex) /판매 를 통해 손에 들고 있는 아이템을 판매 할 수 있습니다.

함께 작성하면 다음과 같습니다.

ex) 커스텀 인챈트 부여 : 바닐라 경험치를 소모하여 커스텀 인챈트를 구매하고, 부여할 수 있습니다. 더 높은 등급과 장비에 적절한 커스텀 인챈트를 부여해보세요.

1.2 Header 사용

페이지 제목: Header 1 ( # 한개 )
페이지 제목의 대분류 카테고리: Header 2 ( ## 두개 )
카테고리의 세부 카테고리 : Header 3 ( ### 세개 )

가급적 세부 ### 세부 카테고리 이하로는 내려가지 않도록 합니다. 그 이상 세부적인 구조가 필요할 
경우 페이지를 나누는 것을 권장합니다. 

1.3 색 사용 가이드라인

적절한 하이라이트와 표시를 하면 가독성을 높입니다. 원하는 구역을 드래그 한 후 버튼을 눌러서 마크다운을 적용할 수 있습니다. ( 마크 다운 단축키를 입력하여 적용할 수도 있습니다. )

1 : Bold 2 : 하이라이트 3 : 색 변경

• 빨강색 : 완전 알아야될 단어 (ex. 제한, 경고)

• 주황색 : 하이퍼링크

• 노란색 (Bold) : 키워드

• 초록색 (Bold & 하이라이트) : 명령어

• 파란색 : 시간

• 보라색 : 쿨타임

등급을 기재할 경우가 있다면 이미지 파일보다는 다음 형식을 사용합니다.

• COMMON : Bold, 하이라이트

• UNCOMMON : Bold, 하이라이트, 초록색

• RARE : Bold, 하이라이트, 파란색

• EPIC : Bold, 하이라이트, 보라색

• LEGENDARY : Bold, 하이라이트, 노란색

컨텐츠에 접근할때 명령어 외에 특정 버튼이나 GUI를 눌러야 할때는 검은 글씨에 회색 배경 하이라이트를 사용하면 좋아요.

ex) Tab ex) /설정 - 채팅 채널을 통해서 지역챗 <-> 전챗 <-> 마을챗 변경이 가능합니다

작업 과정

위키에 한 내용을 업데이트 하기까지의 일반적인 과정에 대해서 서술하겠습니다.

1. 자료 수집

필요한 자료를 수집합니다. 인게임에서 직접 얻을 수 있는 정보나 패치노트에 기재되어 있는 내용은 적절히 정리하여 작성하면 됩니다. 헷갈리거나 잘 모르겠는 정보, 유저가 쉽게 접근할 수 없는 데이터 등은 위키 쓰레드에 올려주시면 됩니다.

쓰레드 접근하는 방법

상단에 해당 아이콘을 찾아주세요. 클릭하여 위키라고 되어있는 쓰레드를 누르면 됩니다.

2. 구글 문서에 정리하기

깃북은 한글 호환이 잘 되지 않기 때문에 깃북에 직접 작성하면 띄어쓰기가 밀리고 받침이 분리되는 현상을 겪을 수도 있습니다. 따라서 미리 구글 문서에 모두 작성한 후에 붙여넣기를 하는 형식을 추천드립니다. (글의 중간에 작성할 때 이런 현상이 심해집니다. 그럴때는 엔터 한번 누르고 마저 입력한 후 줄바꿈을 지워주세요.)

위키 작업에 주로 사용되는, 위키 관리자끼리 공유된 구글 문서가 있으며 위키 작업자나 어드민님께 요청드리면 공유해드립니다.

3. 로그인 보고 및 작업

로그인 전 위키 쓰레드에 로그인 할 예정임을 알려주셔야 합니다. 동시에 여러명이 작업하게 된다면 서로 충돌이 일어나기 때문에 한번에 한명만 수정합니다.

쓰레드에 알렸다면 작업을 진행하시면 됩니다. 수정본 생성 및 머지 신청은 깃북 기능에 작성했습니다.

4. 머지 신청 및 수정 사항 보고

머지 신청을 한 이후 시그니션님이 머지를 눌러줘야 수정본이 반영됩니다. 따라서 시그니션님께 작업이 완료되었음을 알려야합니다. 다음과 같은 형식으로 쓰레드에 작성하시면 됩니다.

머지 신청했습니다.
#000 변경사항
- ㅡㅡㅡ
- ㅡㅡㅡ

5. PR

Gitbook 은 Git의 일종이기 때문에 결정권자에게 자신이 만든 변경점을 리뷰해 달라고 요청하고 리뷰가
받아들여지면 실제 위키에 업데이트하는 형식을 취하고 있어요.

이 과정을 PR 이라고 해요. PR 을 할 때 여러개의 계정에서 하나의 페이지를 함께 수정하여 서로 
충돌이 발생하지 않도록 주의해 주세요! 그럴 경우 해당 충돌을 해결하기 위해(conflict resolve)
하나의 페이지를 일단 병합하고 다른쪽을 버려야 하는 경우가 생겨요. 그때 작업을 잃지 않도록
협업하기를 통해 소중한 시간을 아껴요.