brunch

You can make anything
by writing

C.S.Lewis

by 레오 Mar 26. 2023

서비스 가이드 문서 작성법 (with 레퍼런스&팁)

채널톡,와디즈,스티비 ,레몬베이스,Typed 등 레퍼런스와 팁

(제가 운영 중인 "위클리 UX/UI 분석 챌린지" 스터디 참여를 위해 작성한 글입니다)

(매주 UX/UI분석, 아티클공유, 북리뷰 등 활동을 바탕으로 멤버 분들이 함께 성장하고 있습니다)

https://holix.com/ch/bVaKQMNB (합류해보세요! 초대합니다)


아래의 순서대로 글이 전개됩니다. 

1) 레퍼런스 & 작성 팁 

- 다양한 서비스의 가이드 문서 레퍼런스 정리 - 설명 / 장점 / 아쉬운 점 / 팁 등을 담았습니다. 

2) 가이드문서 작성 팁 총정리

- 1번에서 다룬 서비스들에서 장점 / 작성 팁 이라고 생각한 점들을 모두 모아서 정리했습니다. 

3) 가이드문서 작성 업무 - 어떤 순서로 하면 좋을까? 

- 어떤 순서로 가이드문서 작성 업무를 하면 좋을지 적어보았습니다. 많은 분들에게 실제로 도움이 되어드리고 싶어서 최대한 적용 방법 / 업무 순서 등을 포함해서 글을 발행하려고 노력하고 있습니다.

*제가 좋아하는 업무 방식이니 정답이 아닐 수 있습니다 :) 


1. 채널톡 (추천)

개발자문서, 사용가이드 모두 친절하게 잘 정리해두었다. 또한 인터뷰 콘텐츠를 바탕으로 한 사례 / 마케팅 팁,레시피를 담은 콘텐츠까지 채널톡을 사용하려는 / 더 잘 활용하려는 사람들을 위한 콘텐츠를 정말 잘 만들어두었다. 유튜브에서도 양질의 인터뷰 콘텐츠를 생산해나가며 채널톡을 알리는 전략을 채택하고 있다. 


팁1) 첫 페이지에 가이드 문서 전체의 구조를 이해할 수 있도록 노션의 Gallery view 와 같은 것을 만들어 두면 사용자가 빠르게 원하는 곳으로 이동할 수 있다. 

팁2) usecase를 보다 구체적으로 제시해줄수록 사용자의 서비스에 대한 이해도를 높이고 행동을 유도할 수 있다. 

팁3) 인터뷰 기반으로 그 자체로 흥미로운 콘텐츠를 만들기. 그 자체로도 매력도가 높기 때문에 뷰수도 잘 나올 수 있고, 실제 사례에 대한 인터뷰는 좋은 가이드가 된다. 


채널톡의 다양한 가이드. 기술 가이드, 사용 가이드 부터 인터뷰 콘텐츠 등을 통해 실졔 활용/성공 사례까지 보여주고 있다.


1) 채널톡 - 사용가이드 

노션&우피의 Gallery view를 활용하여 원하는 곳으로 사용자가 편하게 찾아갈 수 있도록 가이드를 잘 구성해두었다. 각 문서 별로 필요한 영상이나 문서 링킹도 잘 지원한다. 

https://guide-kr.channel.io/


2) 채널톡 - 마케팅 레시피 

객단가 높이기, 주문과 결제 안내하기, 크리스마스 마케팅 등등 채널톡을 활용해서 마케팅은 이렇게 하면 됩니다! 이렇게 할 수 있습니다! 라고 usecase를 자세히 안내하고 있다. 

https://channel.io/ko/recipe


3) 채널톡 - 서비스 활용 사례

인터뷰 콘텐츠를 기반으로 다양한 섹터의 기업에서 어떻게 채널톡을 활용하고 있는가? 를 소개하고 있다.

별개로 영상 자체 퀄리티도 좋다. 

https://channel.io/ko/case




2. 와디즈 

펀딩하는 법, 펀딩 프로젝트 개설방법, 와디즈 스토어, 공간 와디즈, 멤버십 등 와디즈에서 벌어지는 다양한 활동을 usecase 별로 분류해서 사용 가이드를 제공하고 있다. 

펀딩 참여자 / 펀딩 프로젝트 개설자 / 공간와디즈(팝업) / 멤버십 구매자 / 와디즈에 광고를 올리고 싶은 사람.. 등등 다양한 usecase가 있기 때문에 usecase를 기반으로 쪼개둔 것 같다. 


팁1) 문서 하단에는 참고할만한 문서 / 이전 & 다음 문서로 가는 링크를 적절히 걸어두자. 

팁2) 가이드 페이지에 검색기능을 넣으면 바로 사용자가 원하는 것을 검색해서 찾도록 유도할 수 있다. 가이드 구조를 파악해서..타고들어가서..찾는 것은 너무 복잡하고 어렵다. 


와디즈의 가이드 & 검색 결과 &문서 하단의 링킹


와디즈 가이드 / 헬프센터 : https://help.wadiz.kr/ko/




3. 스티비 

스티비 역시 검색 기능을 전면에 배치하고, 그리드 방식을 통해 각 메뉴로 편하게 이동할 수있도록 했다. 

2번째 사진처럼, 각 문서의 세부 페이지 내에서 좌측에서는 목차를 확인하고, 우측에선 콘텐츠를 볼 수 있어서 좋았다. 문서간 링크도 잘 지원했다. 

세부 페이지 내에서는 직집 ui를 캡쳐해가며 가이드를 친절하게 적어두어서, 잘 모르는 사람도 쉽게 이용할 수 있을 것 같다. 


팁1) 가이드 내에 UI 스크린샷을 넣어두면 사용자가 더 쉽게 메뉴를 찾을 수 있다. 

아쉬웠던 점) 두 번째 사진처럼 세부페이지 상단에선 목차를 좌측에서 편하게 볼 수 있었는데, 스크롤해서 아래로 내려가니 목차가 같이 따라오지 않았다. 스크롤했을 때 목차가 같이 따라오면 좋겠다.

팁 & 아쉬웟던 점) 한 섹션의 마지막 글에선 자연스럽게 다음 섹션으로 이동할 수 있는 링크를 걸어두면 좋다. 

스티비의 이용가이드. 세부페이지에선 좌측에서 목차를 볼 수 있어서 좋았다. 스크롤했을 때 따라오지 않아서 아쉬웠지만..!

스티비 가이드 / 헬프센터 : https://help.stibee.com/hc/ko





4. 레몬베이스

성과관리, 목표관리, OKR, 1:1 미팅 운영을 도와주는 서비스 레몬베이스의 가이드. 채널톡 가이드등과 구조 자체는 유사하다. 상단에 한 번에 이해하기! 와 같은 영상을 두고, 하단에는 구조를 바탕으로 기능 가이드 등을 제공하고 있다.


특징) 사용가이드를 제공하면서 좋은 성과관리 / 미팅 가이드와 같은 정보성 콘텐츠까지 제공하고 있다. 

팁1) 단순히 기능 가이드 뿐 아니라, 관련된 지식을 설명해주는 것도 좋다. 가이드문서 자체에 대해 사용자가 느끼는 효용도 높아지고, 이해를 바탕으로 고객이 더 서비스를 잘 활용할 수 있도록 유도할 수 있다. 


레몬베이스의 가이드. 1:1 미팅 가이드 등 지식 콘텐츠까지 제공하고 있다.

레몬베이스 가이드 문서 : https://help.lemonbase.com/




5. Typed (추천) 

구성적으로 뭔가 완벽하다는 인상이 든 가이드 문서였다. 올인원 느낌? 

가이드 / 상담창구 / 활용예시 (인터뷰콘텐츠) / 건의게시판 / 피드백 제공창구 / Typed가 운영하는 채널로 가는 링크 등등이 준비되어 있다. 

단순히 가이드가 아니라 Typed라는 서비스와 대화할 수 있는 모든 것들이 담긴 페이지 같았다. 


팁1) 두 번째 사진처럼 '다 봤는데도 아직 모르겠다면?' 섹션을 구성하는 것도 좋은 전략. Typed의 경우 1:1 줌 온보딩 채팅상담으로 이동할 수 있는 경로를 가이드문서 내에서 잘 보이는 곳에 배치해두었다. 가이드문서를 읽기 어려워하는 사람.. 바로 궁금한거 직통으로 물어보고 싶은사람.. 등등에게 잘 먹힐 것 같다. 

팁2) 바로 지원을 받을 수 있는 경로 ( 줌 상담, 채팅상담) 를 가이드에 포함시켜두는 것도 좋다. 

팁3) 기능 건의, 피드백 제공 창구 등등을 열어두면 트래픽을 활용해 고객의 목소리까지 수집할 수 있다. 

팁4) SNS 링크 등을 걸어두기 등등 전략을 통해 가이드 문서로 들어온 트래픽을 잘 활용할 수 있다. 


Typed의 가이드문서. 가이드 & 줌/채팅상담 창구 & 피드백 게시판 & Typed SNS 링크 등등까지 볼 수 있다. 구성적으로 올인원 같은 느낌을 만들어 낼 수 있다.


Typed 가이드 문서 링크

https://businesscanvas.notion.site/Typed-aa28b00ce2e9437aa39c372e3a3d2b4d




6. 라이브클래스 운영 가이드 (추천) 

라이브클래스가 어떤 서비스인지에 대한 소개 / 세부 가이드 / 구체적인 usecase를 바탕으로한 가이드 / 꿀팁 등이 담겨있다. usecase를 바탕으로 한 가이드까지 잘 제공하고 있다. 줌에서 수업 녹화하기 등등 실제로 고객이 겪을만한 문제에 대한 꿀팁도 제공하고 있다. FAQ는 덤! 


특징 & 팁2) 상단에서 서비스를 소개하는 섹션을 구성하는 것도 좋은 전략
우리 서비스에 대한 이해도가 낮은 고객도 가이드 문서를 읽을 수 있다 (주로 이해도가 낮은 고객이 읽을 것이다)는 것도 고려해야 한다. 

특징 & 팁1) 세부 가이드의 전체적인 구성을 보여줄 때, 하위항목들을 노션의 Gallery view와 같은 방식 (title,이미지가 강조되어 보이는 방식)도 좋지만 라이브클래스의 예시처럼 하위항목들의 내용도 모두 확인할 수 있게 만드는 것도 좋은 것 같다. 

전반적으로 정보의 양이 많아 읽기 힘들 순 있지만, 한 번의 클릭으로 바로 세부페이지로 이동할 수 있다는 장점이 있으며, 내용이 많으니 은근 읽게 되는 것 같다. 

라이브클래스의 가이드. 서비스 소개 / 세부 가이드 (텍스트로 모든 구조 확인 가능) / 사례 소개 / 꿀팁 등이 담겨있다.


라이브클래스 운영 가이드 문서 링크 : https://guide-kr.liveklass.com/


[가이드문서 작성 팁 총정리]

(위 레퍼런스들에서 팁 / 장점을 모아서 정리했습니다. 


가이드문서 메인페이지에 가이드 문서 전체의 구조를 이해할 수 있도록 노션의 Gallery view 와 같은 것을 만들어 두면 사용자가 빠르게 원하는 곳으로 이동할 수 있다. 

이렇게 쓰세요, 이런 사용자라면? 등등과 같이 usecase를 보다 구체적으로 제시해줄 수록 사용자의 서비스에 대한 이해도를 높이고 행동을 유도할 수 있다. 

인터뷰 콘텐츠 등 그 자체로도 흥미로운 콘텐츠를 포함하는 것도 좋은 전략이다. 성공사례 / 활용사례를 보는 것 만으로 나는 어떻게 활동할 수 있을까? 나도 가능할까? 등의 생각을 유도하여 전환으로 이어질 수 있다. 

각 세부 페이지 하단에는 참고할만한 문서 / 이전 & 다음 문서로 가는 링크를 적절히 걸어두자. 

가이드 페이지에 검색기능을 넣으면 바로 사용자가 원하는 것을 검색해서 찾도록 유도할 수 있다. 가이드 구조를 파악해서..타고들어가서..찾는 것은 너무 복잡하고 어렵다. 

가이드 내에 설명 뿐 아니라 UI 스크린샷을 넣어두면 사용자가 더 쉽게 메뉴를 찾을 수 있다. 

단순히 기능 가이드 뿐 아니라, 관련된 지식/개념을 설명해주는 것도 좋다. 가이드문서 자체에 대해 사용자가 느끼는 효용도 높아지고, 이해를 바탕으로 고객이 더 서비스를 잘 활용할 수 있도록 유도할 수 있다. (ex- 마케팅 툴 가이드 문서 내에서 리텐션이란? 과 같은 개념을 설명해주기) 

바로 고객지원을 받을 수 있는 경로 ( 줌 상담, 채팅상담) 를 가이드에 포함시켜두는 것도 좋다. 몰라서/어려워서 등의 이탈하는 경우를 줄일 수 있다. 

기능 건의, 피드백 제공 창구 등등을 열어두면 고객의 목소리까지 수집할 수 있다. 

SNS 링크 등을 걸어두는 것도 전략. 가이드 문서로 들어온 트래픽을 잘 활용하자. 

상단에서 서비스를 소개하는 섹션을 구성하는 것도 좋은 전략.우리 서비스에 대한 이해도가 낮은 고객도 가이드 문서를 읽을 수 있기 때문이다.(주로 이해도가 낮은 고객이 읽을 것이다)는 것도 고려해야 한다. 


가이드문서 작성 업무 - 어떤 순서로 하면 좋을까? 

아래 순서대로 한 번 시도해보세요! 


1. 우선 다른 서비스들은 어떻게 하고 있는가? 이 서비스는 어떤 내용을 소개하고 있는가? 메인페이지는 어떻게 구성되어있는가? 탐색을 돕는 장치는? 세부페이지는 어떻게 구성되어있고 어떻게 NAVIGATION을 돕는가? 를 한 번 살펴보세요. 위의 레퍼런스들을 보시면 좋을 것 같습니다. 

2. 이제 잠시 마우스 / 키보드에서 손을 떼고 우리 서비스에 대해서 상상해보세요! 우리 서비스는 어떤 서비스인가.. 어떤 점을 안내해주면 좋을까.. 누가 우리 고객일까..? 누가 이 문서를 볼까..? 어떤 점이 궁금해서 이 문서에 찾아왔을까..? 서비스 내에서 어떤 버튼을 눌러서..어떤 사용 맥락에서 이 가이드문서를 찾아서 왔을까...? 혹은 웹에서 찾았다면 어떻게 찾았을까..? 이 문서 내에서 어떤 정보를 찾아볼까..? 어떤 흐름으로 문서를 탐색할까? 등등.. 다양한 상상을 한 번 해보세요! 바로 뭔가 적어나가고 싶겠지만 초반에는 최대한 큰 틀에서 생각하고 구조를 잡는게 문서를 엎는 등의 참사를 막을 수 있다고 생각합니다 ㅎㅎ

3. 위의 '가이드문서 작성 팁 총정리' 부분을 살펴보세요. 다양한 팁들 중 어떤 팁들을 사용할 것인지 / 혹은 저기에는 없지만 이런 장치를 두면 좋겠다! 처럼 나의 가이드문서의 장점과 특징을 정리해보세요. EX) 메인페이지에는 검색 넣고.. GALLERY VIEW로 우선 구조를 알려주고, 세부페이지 하단에는 이전/다음으로 문서간 네비게이션을 지원해야겠다! 오케이! 

4. 이제 본인 서비스 가이드문서를 쓰기 시작해봅시다! 우선 글을 두서없이 써내려가기 보다는 키워드나 한 문장 정도로 담을 내용을 쭉 리스트업 해보세요. EX) 우리서비스 소개 / 시작하기 / 커뮤니티 생성하기 / 초기 모객 방법 등.. 처럼 말이에요

5. 리스트업 한 내용들을 묶고 구조화 해보세요. 마치 노션 GALLERY VIEW처럼 내용들을 분류해서 정리한다는 생각으로요! 

6. 이제 각 문서 별 내용을 한 번 써내려가보세요! 완벽한 글일 필요는 없습니다. 써내려가면서 내가 뺴먹은 키워드나 중요내용이 없을 지, 추가할 페이지가 없을 지 / 구조는 어떻게 짜는게 좋을 지 구체화 하기 위함입니다.

7. 전체 구조, 포함되어야 할 내용, 문서 간 연결관게, 내 가이드문서가 사용할 네비게이션 방법 / 팁 등이 나왔다면 우선 메인페이지 / 구조를 완성해보세요. 

8. 5번에서 작성해둔 세부 페이지 별 내용을 고도화 해서 내용 작성을 마무리합니다. 

9. 이제 전반적으로 돌아보면서 검토해보세요! 빼먹은건 없을 지.. 처음 본 사용자가 없을 지.. 우리 서비스를 찾는 사람은 누구일지 / 이 사람이 보면 어떨지.. 등을 상상해보세요! 몰입해서 적는 과정에서 놓치는게 있었을 수도 있기 때문이에요! 이 때 최대한 우리 서비스를 모르는 사람.. 어려워하는 사람.의 관점에서 생각해보는 것도 좋습니다 :) 핵심고객의 입장에서 살펴보는건 꼭 뺴먹지 마세요! 



UX/UI/기획에 대해 같이 공부하고 성장하고 싶으신가요? 초대합니다! 

이 글도 제가 운영중인 스터디 참여를 위해 작성한 글인데요, 스터디에서는 매주 UX/UI분석, 아티클공유, 북리뷰 등 활동을 바탕으로 멤버 분들이 함께 성장하고 있습니다 :) 

https://holix.com/ch/bVaKQMNB (언제든 합류하실 수 있습니다)


작가의 이전글 신뢰감을 주는 리뷰 UX의 구성요소

작품 선택

키워드 선택 0 / 3 0

댓글여부

afliean
브런치는 최신 브라우저에 최적화 되어있습니다. IE chrome safari