👷♂️ 안내서 작업 가이드
🚧🔨 안내서 작업 가이드입니다.
중제목_예시
👷♂️ 대제목이 2개 이상인 경우 위와 같이 작업 목차를 넣어 주세요. 대제목, 중제목, FAQ까지 목차에 넣어주세요.
1. 안내서 작업 전 사전 준비
확인 후 진행해 주세요.
2. 깃북 안내서의 고질적인 문제
🔨 깃북 작성 시 맨 마지막 글자가 사라지는 현상이 있어요. 깃북 작업을 할 때는 마지막 글자 입력 후 띄어쓰기 한 번 > 지우기 한 번을 하는 습관을 들여주세요. 🔨 두 명이 함께 작업하는 경우 충돌이 발생하므로 다른 사람과 동시에 작업하지 않도록 살펴주세요. 🔨 꽤 잦은 확률로 작업이 날아가요. 주기적으로 [Save > Murge] 해주세요.
2
3. 안내서 간단 작업 순서
안내서 작업은 아래와 같은 순서로 진행되고 있어요. 도표 활용 예시를 보여주기 위해 일부러 도표 양식으로 넣어보았어요.
[ 안내서에 도표 넣기 ] 안내서에 들어갈 과정이 복잡한 경우 피그마 도표 양식을 활용해 주세요. 한 눈에 순서를 인지하게 하기 위함이므로 최대한 축약하여 한 줄로 맞춰 주시면 좋아요. (최대 2줄) 통일성을 위하여 위치나 크기, 색상 등은 최대한 조정하지 말아주세요.
4. 작업 순서별 상세 설명
작업 시작 ~ 종료까지 진행 상황을 파악할 수 있도록 깃북 현황판을 작성해 주세요.
01. 새 페이지 생성 및 기본 폼 붙여 넣기
작업중 페이지 하단에 마우스를 올려 + 모양 아이콘을 클릭하여 새로운 페이지를 생성할 수 있어요. 안내서 작업 기본 폼 페이지의 체크리스트를 생성한 페이지에 복붙해 주세요.
[ 작업 전 체크리스트 부가 설명 ] '안내서 작업 기본 폼' 페이지의 체크리스트를 이용하여 안내서 과정에 누락이 없도록 활용해 주세요. 작성자, 제품 관리자 등 설명이 필요하지 않는 체크리스트 부가 설명은 제외했어요.
노출 위치 예시_상점 디자인하기 > 디자인 활용하기 > 이미지 다운로드하기 하단 또는 링크
하위 주소 안내서 업로드 전 하위 주소를 미리 정해 두어야 합니다. 예시_image-download, exclusive 구분선이 필요할 경우 image_download 가 아닌 image-download 형식으로 통일하기로 했어요.
업로드 전 서운팀 기능 공유 도메인 구매하기, 토스페이먼츠 등 안내서 만으로 바로 이해가 어려운 복잡한 기능이 출시되는 경우에는 원활한 CS를 위해 안내서 업로드 전 서운팀에 기능이나 유의 사항을 상세히 공유해 주세요.
02. 틀 작업 후 공유하기
이미 구성이 정해져 있는 안내서 수정에는 필요 없는 과정이에요. 완전히 새로운 안내서를 만들 때 혹은 구성을 완전히 바꿀 때 본 작업 전, 아래 네 가지 정도를 빠르게 정리하여 서운팀(동호님)에 공유해 주세요. 작업을 두 번 하지 않게 하기 위함이에요. 서운팀(동호님) 컨펌 이후 본격적인 이미지 작업, 글 다듬기 작업 등을 진행해 주세요.
안내서 노출 위치
안내서의 순서와 구성
들어가야 하는 내용
이미지 위치
👷♂️ 깃북 확인용 링크 접속하면 본인이 작업한 페이지 링크를 찾을 수 있어요.
[ 안내서의 순서와 구성 ] 일반적인 경우 기능 설명 > 사전 준비 사항 > 기능 이용 방법 > 추가, 연계 기능 > FAQ 순서로 노출하고 있어요. 특수한 목적이 있는 안내서라면 목적에 맞게 순서를 변경해 주셔도 돼요.
03. 본 작업
기존 안내서를 반드시 참고하여 작업하되, 좋은 방법이 있다면 언제든지 시도하고 제안해 주세요. 물론 더 예쁘거나, 더 간결하거나, 더 가독성이 좋은 방향으로 나아가야 해요.
[ 작업 규칙 모음 ] 아래 작업 시 필요한 규칙을 각각 클릭하여 확인해 주세요.
해주세요의 띄어쓰기는 'OO해 주세요.'로 통일하기로 했어요.
[식스샵 > 상점 설정 > 결제]와 같이 링크 걸기가 필요할 때는 대괄호까지 링크를 걸어주세요.
링크를 넣는 [식스샵 > 상점 설정 > 결제]는 양 옆에 띄어쓰기를 넣지 않아요.
버튼을 설명할 때는 대괄호를 넣어주세요. 양 옆에 띄어 쓰기는 없어요. 예시_[네, 취소합니다]
기타 설명을 넣을 때는 굵게, 양 옆에 띄어 쓰기를 넣어주세요. 예시_[ 이미지 사이즈 가이드 ]
:(쌍점)을 사용할 때는 좌측은 띄어 쓰기 없이, 우측은 띄어 쓰기를 넣어주세요. 예시_설명: 설명입니다.
/로 구분 시 양 옆에 띄어 쓰기를 넣어주세요. 예시_토스페이먼츠 / KG이니시스 / 나이스페이
예시는 예시_형식으로 작성하되, 예를 들어 같은 형태로 풀어 사용해도 좋아요.
기능명 등 공식 용어는 그대로 사용해 주세요. 예를 들어 '상점 관리자'라고 띄어 쓰고 싶어도 토스페이먼츠에서 '상점관리자'라고 지칭하기 때문에 그대로 '상점관리자'라고 쓰고 있어요.
단축키는
Ctrl(⌘) + Shift + M으로 통일해 주세요. (드래그 후 code 클릭)체크 박스는 아래로 통일해 주세요 무엇을 [✔︎] 체크해 주세요.
무엇을 [ ] 체크 해제해 주세요.
[버튼]을 클릭해 주세요.
👷♂️ 위 폴더 같이 노출되는 표는 'Tabs'입니다. 보시다시피 'Tabs'는 굉장히 깔끔하고 예뻐요. 하지만 고객이 첫 번째 Tab 외에는 클릭하지 않을 위험성이 있어요. 그렇기 때문에 확인하고 넘어가야 하는 내용이 포함되어 있는 경우에는 잘 사용하지 않아요.
[ 단어 통일하기 ] 아직 생각 나는 단어가 많지 않아서 함께 쭉쭉 채워나가 봅시다.
판매자, 고객 → 관리자
소비자, 회원, 고객 → 구매자
상점관리자, 가맹점 관리자 → PG사 상점관리자
[상점 설정 > 결제] → [식스샵 > 상점 설정 > 결제]
데스크톱 → 데스크탑
디자인 에디터, 디자인 편집 에디터 → 디자인 편집 페이지
사이트, 내 사이트, 상점 → 상점 웹사이트
(업데이트 뉴스 등 마케팅 목직이 있는 경우 상점)
[ 이모지 ] 👷♂️ 이모지 사용이 안 되는 이유? (고민 중)
시간이 흐르면 오히려 트렌드에 뒤떨어져 보여 대대적인 수정이 필요할 수 있다.
과도한 이모지 사용으로 간결성, 가독성이 떨어질 수 있다.
이모지 사용으로 안내서의 신뢰성이 떨어질 수 있다.
[ 링크 걸기 ] 깃북 안내서 외부 링크는 깃북 > dongho > test 에서 바로 걸어도 되지만, 깃북 안내서 내부 링크는 깃북 > 식스샵 > 식스샵 고객센터에 안내서를 옮긴 이후 걸어주셔야 해요.
때문에 test에서 작업 시 깃북 안내서 내부 링크를 걸어야 하는 부분은 별도 표시해 주세요.
안내서를 옮긴 후 링크를 걸어야 하는 부분을 잊지 않게 하기 위함이에요.
예시) 도메인 구매하기 안내서를 참고해 주세요.
링크 걸기 방법 깃북 > 식스샵 > 식스샵 고객센터에 안내서를 옮긴 후 > 링크를 걸 부분을 드래그 > Link 아이콘 클릭 > 안내서 제목 검색 검색되는 Heading 1,2,3 중 링크를 걸 부분을 선택하면 돼요.
[ Hint 사용하기 ] 강조해야 하는 안내 사항이 있다면 Hint를 유용하게 사용할 수 있어요.
무분별한 Hint 사용은 안내서를 지저분하게 만들어요.
Hint를 연달아 두 개 넣는 것은 지양해 주세요.
Hint는 상단에 노출하는 것을 권장하지만 내용 고려하여 적절한 위치를 찾아주세요.
Hint 색상별 활용법 (생성된 Hint의 ⓘ 아이콘을 클릭하면 색상을 변경할 수 있어요.)
파랑: 일반적인 모든 안내에 사용합니다.
주황: 확인하지 않을 경우 관리자가 다소 불이익을 받을 수 있는 경고성 안내에 사용합니다.
빨강: 확인하지 않을 경우 관리자가 큰 불이익을 받을 수 있는 강한 경고성 안내에 사용합니다.
초록: 대체로 사용하지 않습니다. 알고 있으면 좋은 팁에 사용하면 어떨까 싶어요.
[ 기존 안내서 개선 작업인 경우 ] 기존 안내서를 교체하는 개선 작업인 경우 기존 안내서를 깃북 > dongho > test > 과거 안내서에 꼭 저장해 두셔야 해요. 이미지도 잊지 않고 모두 옮겨 주세요.
[ 링크 순서 주의 사항 ] 안내서 내용 수정 및 추가 시 구성은 최대한 건드리지 않아야 해요. Heading 1,2,3 순서를 기준으로 모두 링크 주소가 부여되어 있고 해당 링크 주소가 식스샵 관리홈, 다른 안내서에 이용되고 있기 때문이에요.
때문에 FAQ에 질답을 추가할 때는 새로운 질답을 가장 하단으로 위치 시켜 주셔야 해요.
04. 컨펌 후 안내서 업로드
[ 스펠러 확인 ] 모든 작업 완료 후 반드시 스펠러 맞춤법 검사를 해주세요.
[ 안내서 업로드 방법 ]
① 깃북 > 식스샵 > 식스샵 고객센터로 이동해 주세요. ② 안내서 들어갈 위치에 마우스 오버 > + 아이콘 클릭하여 페이지를 생성해 주세요. ③ 식스샵 고객센터에 새로 생성된 페이지에 테스트 작업본을 복붙해 주세요. a. 이미지는 불러오지 못해서 별도 복붙해야해요. b. GIF파일은 복붙하지 않고 PC에 파일 저장 후 업로드해야 움직여요. ④ 생성된 페이지에 마우스 오버 > ... 버튼 클릭 > SLUG에 하위 주소를 넣어주세요.
⑤ [Save > Murge] 해주세요.
05. 안내서 공유하기
[ 업데이트 쓰레드 만들기 ] 업데이트 기능별 문서 클릭 > '상태 없음' 클릭 > '20210000복제용'을 복제 > 복제한 페이지를 '작성 중'으로 이동 시키기 > 복제 페이지 클릭하여 기능별 문서 작성해 주세요.
[ slack에 안내서 공유하기 ] 안내서 업로드, 업데이트 쓰레드가 완료되면, 서비스 운영 업무방에 아래 내용을 공유해 주세요. 👷♂️ 안내서 추가, 수정이 잦기 때문에 피로감이 생길 수 있어 어그로는 지양하고 있어요. (요약, 간결함 추구)
[ 안내서 추가 공유 ]
OOO 안내서가 추가되었습니다. 링크 @관련자 멘션(관련자가 있는 경우) 위치: 예시_상점 디자인하기 > 디자인 활용하기 > 이미지 다운로드하기 하단 주요 내용: 유의 사항: 업데이트 쓰레드 링크 👷♂️ 위 쓰레드 링크는 그대로 사용해 주시면 됩니다.
06. 체크리스트 완료하기
5. 🤔 안내서 작업 가이드 FAQ
궁금한 점 있으면 여기 작성해 주세요. (공유용)
Last updated
Was this helpful?
