많은 기술 SaaS 기업들이 제품 문서(사용자 매뉴얼, 사용자 가이드, 튜토리얼)를 개발하고 배포하는 과정에서 어려움을 겪고 있습니다.
이는 주로 매뉴얼 제작과 관리에 대한 지식이나 프로세스 부족, 또는 누가 이를 담당해야 하는지에 대한 불명확함 때문에 발생합니다.
도구와 소프트웨어가 존재하는 한, 제품의 사용법, 개발 방식, 기능, 아키텍처를 효과적으로 전달할 수 있는 효율적인 커뮤니케이션이 필요합니다. 왜 그럴까요? 그 이유는 간단합니다. 기술 커뮤니케이션 능력이 정보를 수집하고 사용자가 제품이나 기술을 더 효과적으로 이해하도록 돕는 데 필수적이기 때문입니다.
현실 세계에서의 의사소통이 말, 몸짓, 감정 표현으로 이루어진다면, 디지털 세계에서는 기술 커뮤니케이션이 기술 제품 문서를 통해 이루어집니다!
기술 제품 문서의 유일한 목적은 사용자가 제품과 기술의 작동 방식과 구조를 이해하도록 돕는 것입니다. 이는 신입 직원, 사용자/고객, 그리고 제품의 작동 방식과 세부 사항을 알아야 하는 모든 사람을 위한 "사용 설명서"와 같습니다!
제품 관리자는 팀을 구성하여 완성도 높은 제품 문서를 만들고, 관리하고, 출판하고, 유지하는 책임을 맡아야 합니다.
모든 제품 관리자는 부서에서 다음과 같은 말을 했거나 들어본 적이 있을 것입니다: "제품 문서는 제품 책임자의 의무입니다", "각 개발팀이 자신의 앱을 문서화해야 합니다", "기능이 배포되었는데, 매뉴얼이 업데이트되었나요?" 또는 더 나쁜 경우 "기술 문서에 오류가 있습니다."
분명히, 기술 제품 문서는 보기보다 복잡할 수 있습니다! 사람들이 위 문장들에 대해 논쟁하는 동안, 매뉴얼과 튜토리얼은 악화되고 이는 "제품/회사" 이미지에 해롭습니다.
비슷한 문제를 겪고 있는 분들을 위해, 제품 문서를 최적화하는 데 도움이 될 몇 가지 절차를 소개합니다.
제품 문서의 목적은 무엇인가요?¶
기술 제품이나 서비스에 대한 제품 문서를 이야기할 때, 제품을 설명하고 관련 데이터를 제공하는 정보를 말합니다.
기술 문서 또는 제품 문서는 사용자와 고객이 제품을 활용하고, 읽고, 이해하고, 사용할 수 있도록 돕는 것입니다. 대부분의 제품 문서는 엔지니어링, 의료, 정보 기술, 마케팅 등 다양한 분야에서 생성됩니다.
훌륭한 기술 제품 문서는 사용자가 제품을 탐색하고 복잡함 없이 활용할 수 있게 도와줍니다.
또한 기술 문서는 고객 지원에 중요하며 회사의 브랜딩과 신뢰 구축에 크게 기여합니다. 사용자는 가장 필요할 때 기술 문서를 찾습니다. 사용자는 프로세스를 배우고 문제를 해결하기 위해 제품 문서를 활용합니다.
이는 검색 기능이 있는 포괄적이고 동적인 제품 문서가 매우 중요하다는 것을 의미합니다.
다양한 제품 문서 유형¶
이 섹션에서는 고객이나 클라이언트에게 필요한 제품 문서 유형을 살펴볼 수 있습니다.
다양한 사용 사례와 사용자 요구를 충족시키는 여러 유형의 제품 문서가 있습니다:
제품 사용자 문서: 사용자 매뉴얼, 사용 가이드, 튜토리얼, FAQ, 릴리스 노트, 교육 매뉴얼, 운영 절차 등이 포함됩니다.
기업 문서: 조사에 따르면 1,000개 기업 중 10개 기업 중 8개 이상이 공식적인 정책 및 절차 매뉴얼을 사용합니다.
기업 문서에는 연구에서 언급된 회사 정책 및 절차에 관한 문서, 지침 매뉴얼, 기술 관행, 행동 및 윤리 문서가 포함됩니다. 비밀번호로 보호된 법적 문서도 있습니다. 또한 회사 구조, 모범 사례, 절차, 유지 관리 매뉴얼 등이 있습니다.
개발자 문서: 이 유형의 문서는 소프트웨어 제품 개발, 기능 명세서, 기술 명세서, 문서화 및 개발자 워크플로우를 지원하는 도구에 대한 지침을 제공합니다.
이제 다양한 유형의 기술 및 제품 문서를 더 잘 이해했으니, 탄탄한 제품 문서 개발 프로세스 관리가 어디서부터 시작되는지 논의해 보겠습니다.
제품 문서 개발 책임자 지정하기¶
가장 일반적인 문제는 제품 문서를 단순히 업데이트하는 사람이 아니라, 제품의 품질과 성공에 책임이 있는 사람을 누구로 지정할 것인가 하는 것입니다.
일부 기업에서는 각 제품 소유자 및/또는 제품 관리자가 제품 문서를 담당한다고 생각하며, 개발 및 지원 문서와 같은 다른 부서도 사용자 매뉴얼, 사용자 가이드 및 모든 제품 문서를 최신 상태로 유지하고 효과적으로 만드는 책임을 맡을 수 있습니다.
제품 문서 개발에는 많은 요소가 있지만, 여기서는 두 가지를 강조하겠습니다:
-
모든 수준에서 제품이 어떻게 작동하는지 이해하는 사람 (제품 개발 및 사양 팀 포함)
-
제품 문서를 검토하고 이해에 어려움이 있는 부분에 대해 피드백과 우려 사항을 제공하는 고객의 의견을 수집하는 사람
첫 번째 부분은 기존 지식으로 제품 문서를 만드는 데 도움이 되며, 이것이 고객에게 전달되면 고객은 피드백을 제공하고 두 번째 프로세스를 시작하여 문서를 최적화하는 데 도움을 줍니다.
때로는 이 두 가지 요소가 완벽하게 갖춰지지 않아 제품 문서가 필요한 관심을 받지 못하는 상황이 발생합니다.
한 가지 방법은 제품 문서, 제품 매뉴얼, 사용자 가이드의 "성과"에 책임이 있는 사람을 지정하는 것입니다. "제품 문서"가 제품인 구매 주문서를 생각해보세요. 이 담당자는 회사의 모든 팀을 살펴보고, 각 제품이 가이드를 생성하는 방법을 스케치하고, 그 프로세스와 관련된 문제를 파악합니다.
이 제품 소유자와 제품 관리자가 매뉴얼을 생성하고 수정하는 전체 책임을 지는 것이 아니라, 문서 관리에 있어 각 팀의 구성원을 지원하는 것이 목적입니다.
이 담당자는 사용자가 문서와 어떻게 상호 작용하는지 연구하고, 업데이트를 더 원활하게 만드는 방법을 제안하며, 피드백을 수집하여 각 제품 문서와 설명을 대상 사용자에게 어떻게 개선할지 결정해야 합니다.
제품 문서의 모든 측면, 워크플로우, 그리고 이 문서를 완성하는 데 필요한 여러 부서를 담당하는 사람이 있으면 회사 내 생산성이 향상되고, 지식 포털을 통해 고객의 인식을 높이고 교육할 수 있으며, 전반적으로 제품 이해도가 향상됩니다.
제품 문서를 제품 자체로 보기¶
제품은 고객의 기대를 충족하거나 초과하는 가치를 제공하기 위해 존재합니다. D2WorldWide의 통계에 따르면, 구매를 고려 중인 제품에 대한 정보를 찾을 때 73.7%의 사람들이 동영상, 패키징 또는 판매원보다 문서가 더 도움이 된다고 평가합니다.
제품의 매력에 기여하는 요소를 고려해보세요. 제품의 매력에 영향을 미치는 요소는 많지만, 이 글에서는 세 가지에 집중하겠습니다. 기대 이상의 가치를 제공하고, 사용이 만족감을 주며, 경쟁력이 있어야 합니다.
이와 동일한 개념이 좋은 온라인 제품 문서에도 적용됩니다. "기대 이상의 가치"를 제공하는 제품 문서는 지정된 항목의 사용법뿐만 아니라 고객이 모르거나 가능하다고 생각하지 않는 솔루션도 제공합니다. 다른 회사의 제품 문서 작성 방식을 살펴보고 그들의 성공과 실패로부터 배우는 것이 항상 필요합니다.
개발자와 고객이 기술 제품 문서를 이해할 수 없다면, 경쟁사보다 앞선 독특하고 고품질의 소프트웨어를 개발하는 회사가 있다는 것은 의미가 없습니다.
제품 문서를 읽는 사람이 제품이 제공하는 가능한 솔루션 범위나 시장에 익숙하지 않을 수 있다는 점(기술 SaaS 제품의 경우 흔히 그렇습니다)을 고려하면, 그들에게 이러한 솔루션과 제품 관련 다양한 옵션에 대해 "교육"해야 합니다.
"사용성이 만족감을 생성하는" 제품 문서는 대상 사용자에게 적합한 논리적 읽기 패턴을 따릅니다. 500페이지짜리 PDF이거나 코드 예제가 포함되어 있지 않고 검색 기능이나 다른 기능이 있는 동적 문서가 아니라면, 세계에서 가장 철저한 매뉴얼도 소용이 없습니다. 제품 문서 사용자와 지원 인력으로부터 피드백을 수집하세요. 그들은 보고된 데이터와 관련된 주요 스트레스 영역을 파악할 것입니다.
경쟁력 있는 제품 문서는 가장 효과적인 정보 교환 기술을 사용하여 지속적으로 업데이트됩니다. 이들은 내장된 검색 기능, 번역, 다양한 버전, 내장된 이미지, 비디오 등과 같은 놀라운 기능을 갖추고 있습니다!
귀사의 통합 가이드가 모든 기술 기업 중에서 가장 잘 작성되었더라도, 기술에 정통한 고객이 쉽게 복사하여 붙여넣을 수 있는 비디오, 이미지, 코드가 추가되지 않으면 매력이 부족할 것입니다.
다른 회사들이 어떻게 문서를 시작하는지 보고 그들의 성공과 실패로부터 배우는 것이 항상 필요합니다.
개발자와 고객이 문서를 완전히 이해할 수 없다면, 경쟁사보다 앞선 독특하고 고품질의 소프트웨어를 개발하는 회사가 있다는 것은 의미가 없습니다.
제품 문서 피드백
효과적인 기술 제품 문서는 제품을 이해하고 즉시 사용 가능한 해결책으로 문제를 진단하는 프로세스를 개선하여 최종 사용자 경험을 향상시킵니다. 고객이 제품 사용법을 신뢰하고 이해하면, 필요할 때 다시 찾아올 가능성이 높아집니다.
SDL의 새로운 연구에 따르면 글로벌 시장에서 문서의 역할이 증가하고 있습니다. 이 연구는 구매자의 약 53%가 제품을 직접 사용해보기 전에 기술 문헌을 사용하여 구매한다는 것을 보여줍니다. 또한 이 연구의 통계에 따르면 구매자의 94%가 한 곳에서 제품 정보를 얻는 것이 도움이 되고 유용하다고 느낍니다. 이 때문에 오늘날 각 회사는 제품 개발이나 테스트와 마찬가지로 제품 문서에도 동등한 중요성을 부여합니다.
문서를 관리하는 지정된 담당자가 있고, 개선된 사용성을 위해 수정되고 평가된 제품 문서를 만들었으며, 적절하게 업데이트했음에도 불구하고, 사용자와 소비자가 기술 제품을 이해하도록 돕는 데 계속 어려움을 겪을 수 있습니다. 이는 사용자/독자가 문서를 어떻게 읽고 있는지 또는 그들이 실제로 어떤 질문을 하고 있는지 이해하지 못하기 때문일 수 있습니다. 이로 인해 문서 작성의 가장 어려운 측면 중 하나는 독자의 입장에서 생각하는 것입니다. 결국, 제품 문서를 작성하는 사람은 제품에 대한 확실한 이해를 가지고 있어야 합니다.
이러한 전문 지식으로 인해 작성자는 일반 사용자에게는 명확하지 않은 것들을 간과할 수 있습니다. 일반적으로 이는 제품을 만드는 사람들에게는 자명한 것이 제품을 구매하고 사용하는 사람들에게는 전혀 명확하지 않을 때 발생합니다.
이는 다양한 방식으로 발생할 수 있습니다:
글쓰기 구조나 형식: 이것은 주관적인 표현처럼 보일 수 있지만, 핸드북이 작성된 방식조차 혼란을 초래할 수 있습니다. 문서를 읽는 독자 유형을 파악하는 것이 중요합니다. 그렇지 않으면 "개발자는 설명 텍스트보다 예제를 선호합니다" 또는 "예제와 시각 자료가 있음에도 우리 문서는 명확하지 않습니다"와 같은 상황이 발생할 수 있습니다.
매뉴얼의 주제 구성: 때로는 같은 시장에서 운영되는 기업들이 표준화된 문서 형식을 개발합니다. 귀사의 가이드가 이를 따르지 않으면, 독자는 낯선 느낌을 받을 수 있습니다.
암시적 용어의 과도한 사용: 약어가 아니더라도 핸드북에 적용하면 의미가 없을 수 있습니다. 인식하기 어렵지만, "상태", "ID", "자격 증명"과 같은 일부 단어는 명시적으로 보이지만 암시적 의미를 포함합니다. "UID" 대신 "UserID"와 같은 특정 명칭을 사용하세요.
올바른 번역: 번역은 글로벌 도달 범위의 큰 부분입니다. 많은 경우 기업들은 특정 국가의 문화에 맞지 않거나 단어가 영어에서 해당 국가로 동일하게 번역되지 않는 사용자 매뉴얼과 제품 문서를 잘못 번역합니다. 이러한 미묘한 차이를 이해하면 제품 문서가 읽을 수 없는 정보에서 완전히 이해할 수 있고 번역된 제품 문서로 크게 발전할 수 있습니다.
이러한 상황을 피하기 위해 목표는 사용자 피드백과 탐색 패턴을 수집하고 분석하는 솔루션을 개발하는 것입니다.
Docsie의 기능인 Vocally와 같은 피드백 도구는 탐색 패턴을 수신하고 평가하며 고객이 제품 문서를 어떻게 보는지 조사하는 좋은 방법입니다. 여기에서 피드백 수집의 7가지 황금 규칙을 알아보세요.
이 정보는 고객이 제품에 대해 더 원활하게 학습할 수 있도록 사용자 가이드, 사용자 매뉴얼, 제품 문서를 업데이트하고 최적화하는 데 중요합니다. 새 제품을 출시하고 잘못된 매뉴얼 지침으로 인해 지원 요청이 증가하는 것을 발견하는 것보다 더 좌절스러운 일은 없습니다.
포괄적인 제품 문서 작성 방법¶
품질 좋은 제품 문서는 매력적이고 유용하며 강력합니다. 저는 능숙한 문서화가 좋은 제품 관리의 필수 구성 요소라고 주장합니다. 제품 관리자가 제품 개발에 큰 역할을 하는 만큼, 성공의 중요한 부분은 고객이 이해하고 사용할 수 있는 훌륭한 제품 문서를 만드는 것입니다.
대부분의 제품 문서에 무슨 일이 일어나고 있나요?¶
많은 제품 관리자들이 제품 문서 작성을 꺼립니다. 그들이 익숙한 제품 문서는 매력적이고 읽기 쉽고 관련성이 있게 만들기 위해 더 많은 주의를 기울이지 않는 한 고객들에게 호응을 얻지 못할 수 있습니다.
그러나 많은 경우 기업들은 훌륭한 제품 문서를 만들고 제작하는 데 필요한 관심을 기울이지 않습니다. 좋지 않은 제품 문서는 작성을 위해 작성됩니다. 이는 독자들이 내용과 상호작용하는 것을 막기 위해 모호하게 받아들일 수 있는 생각과 좋지 않은 레이아웃으로 가득 찬 광범위한 문구를 사용합니다. 좋지 않은 제품 문서는 작성자를 비판으로부터 보호하기 위해 만들어지며 모든 사람의 시간을 완전히 낭비합니다. 고객들도 이런 이유로 읽기를 꺼립니다.
이를 어떻게 해결하고 고객이 즐겁게 읽을 수 있는 더 나은 제품 문서를 작성할 수 있을까요?¶
훌륭한 제품 문서는 읽혀지기 위해 작성됩니다. 간결합니다. 좋은 제품 문서는 잘 구성되어 있고 회사나 고객 누구나 3분 안에 읽고 이해할 수 있습니다. 전문 용어를 피하고 비즈니스 수준의 관점을 제공하거나 참조합니다. 훌륭한 제품 문서는 고객이 이해하고 제품을 더 잘 활용할 수 있는 특정 사용 사례를 설명하는 데 시간을 할애합니다. 독자의 관심을 끌고 잘 만들어진 해결책으로 근본적인 문제에 주의를 환기시킵니다.
잘 작성된 제품 문서의 효과¶
소규모, 중규모 또는 대규모 기업이 있는 곳에서는 잘 구성된 기술 제품 문서가 많은 시간을 절약하고 직원들이 더 생산적으로 일할 수 있게 도울 수 있습니다. 이는 기술 작가를 고용하고 기술 제품 문서를 작성하는 데 예산의 상당 부분을 할애하는 대부분의 제품 기반 기업에 일반적으로 해당됩니다.
귀사가 제품 문서를 작성하기 위해 두 명 이상의 직원을 고용한다면, 좋은 문서화 문화를 확립하는 것은 완전히 가치가 있습니다. 팀이 잘 만들어진 제품 문서를 작성, 관리, 게시하기를 원하는 많은 이유가 있지만, 아래 섹션에서는 효과적인 제품 문서가 고객 경험을 개선하는 저비용 접근법인 이유를 다룰 것입니다.
효과적인 제품 문서는 고객 경험을 개선하는 저비용 접근법입니다¶
견고한 고객 경험은 충성 고객을 유지하는 최전선입니다. 대부분의 프로젝트 관리자는 낙관주의자입니다 - 개념을 얻고, 열정을 갖고, 실행합니다. 열정은 칭찬할 만하고 실행은 생산적으로 보이지만, 적절한 제품 문서를 실행하기 전에 계획을 세우는 것이 중요합니다.
브레인스토밍 후 첫 단계는 디자인 사이클을 시작하고 고객이 쉽게 읽을 수 있도록 제품 문서 내용을 구성하는 것입니다.
또한, 현재 문서에 대한 고객의 피드백을 얻는 것은 문서를 고객의 요구에 맞게 재구성하기 위해 필요한 중요한 단계입니다. 이렇게 하면 프로젝트 관리자는 인식과 자동화로 문서를 작성, 관리, 유지, 게시, 최적화할 수 있습니다. 이는 간단하고 사소한 작업이 아니며, Docsie와 같은 훌륭한 도구는 제품 문서를 효과적으로 만드는 많은 프로세스를 자동화하여 성공에 필수적입니다.
매력적이고 흥미롭고 탐색하기 쉬운 기술 문서는 소비자가 더 짧은 시간 내에 제품을 배울 수 있게 도와주어, 제품을 올바르게 설정하고 사용할 가능성을 높입니다.
잘 다듬어진 제품 문서를 만드는 이러한 전략들은 본질적으로 더 높은 평가의 제품, 더 호의적인 리뷰, 더 많은 판매로 이어집니다. 이 모든 것은 서로 연결되어 있습니다.
잘 만들어진 제품 문서를 만드는 방법¶
효과적인 문서를 제작하고 이것이 표준인 문화를 조성하는 방법은 무엇일까요? 효과적인 문서 작성은 어렵지만, Docsie에는 잘 만들어지고 동적인 제품 문서 포털을 만드는 이 과정을 가속화하는 데 도움이 되는 많은 기능이 있습니다. 다음은 우리가 이 문제에 접근하는 방법에 대한 고수준 요약입니다.
이제 시작해봅시다:¶
페이지 제한은 가독성을 보장합니다. 좋은 문서는 읽고 정신적으로 처리하기 어려워서는 안 됩니다. 길고 산만한 문장은 종종 명확성 부족의 징후입니다. 만약 의사소통을 한 페이지에 제대로 요약할 수 없다면, 제품 관리자가 상황을 더 세분화해야 한다는 신호입니다.
서식은 품질을 향상시킵니다. 구조가 잘못된 제품 문서는 작성자가 즉흥적으로 작성할 가능성을 높입니다. 잘 구성된 섹션, 표, 문서 헤더가 있는 템플릿을 만드세요. 이는 높은 배당 가능성이 있는 일회성 투자입니다.
템플릿은 시간을 절약합니다. 템플릿에서 섹션을 삭제하는 것이 섹션을 추가하는 것을 기억하는 것보다 훨씬 쉽습니다. 이는 거만한 것이 아니라 효과적이고 시간을 절약합니다. 작성자에게 광범위한 배경으로 시작하고 측정이나 위험한 가정에 대해 구체적으로 언급하도록 상기시키는 간단한 섹션은 더 정확한 글쓰기와 결정 계층을 가능하게 합니다.
댓글 작성 및 작업 할당 직원들이 고품질 문서를 작성하는 것을 의욕 저하시키는 확실한 방법은 그들에게 댓글을 달지 않는 것입니다. 댓글이 매우 똑똑할 필요는 없으며, 오히려 참여를 나타내고 모델 역할을 해야 합니다. 회사의 다른 사람들이 대화로부터 비동기적으로 혜택을 받을 수 있도록 디지털로 피드백을 제공하는 것이 이상적이지만, Docsie의 간단한 기능은 팀과 댓글을 달고 협업할 수 있게 해주어 제품 문서 팀에게 큰 도움이 됩니다!
제품 문서 협업에 Docsie가 어떻게 도움이 되는지 자세히 알아보려면 이 블로그를 확인하세요:
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
문서 유형은 회사의 요구에 맞게 확장 가능해야 합니다. 제품 개발 프로세스에 더 많은 이해관계자가 참여함에 따라, 의사소통은 여러 문서로 나뉘어야 합니다(특히 한 페이지 '간결함' 기준을 충족해야 하는 경우). Docsie는 성장하는 제품 문서 팀을 위한 유용하고 지속 가능한 솔루션을 제공합니다.
Docsie를 활용하여 멋진 제품 문서 제작 속도 높이기¶
Docsie는 제품 문서 및 지식 포털 제작의 모든 측면을 도와주는 매우 유용한 플랫폼입니다. 제품 문서 제작 프로젝트를 정말 간단하고 재미있게 만들어주는 많은 내장 기능이 있습니다! 다음은 이러한 목표를 달성하는 데 도움이 되는 Docsie의 몇 가지 기능입니다:
편집 기능: Docsie는 모든 사용자가 활성화될 때까지 공개되지 않는 대체 버전을 만들어 게시 후 제품 문서를 편집할 수 있게 합니다. 이는 제품 관리 팀이 HTML, CSS 후프를 거치지 않고도 제품 문서를 편집하고 변경한 다음 준비가 되면 공개할 수 있어 좋습니다. 준비가 되면 노브를 전환하여 제품 문서를 자동으로 렌더링합니다.
검색 기능: 제품 문서가 많거나 기능이 많은 경우, Docsie의 검색 플러그인은 고객이 필요한 정보를 빠르고 쉽게 찾을 수 있도록 도와 제품 문서를 미리 보고 정보를 흡수하는 과정을 가속화하는 유용한 보너스를 추가합니다.
링크 기능: Docsie는 제품 문서를 SEO 친화적으로 만듭니다. 회사 웹사이트의 특정 페이지로 백링크를 만들거나 온라인에서 검색 가능하고 같은 제품을 찾는 새로운 고객을 유치하는 제품 기반 키워드를 작성할 수 있습니다.
다양한 번역 기능: Docsie의 최첨단 고스트 번역기는 사용자가 제품 문서를 다양한 언어로 번역할 수 있게 합니다. 또한, Docsie의 언어 선택기 기능을 통해 고객은 자신에게 가장 적합한 언어를 선택할 수 있습니다. 이는 글로벌 도달 범위와 회사의 고객층을 확장하는 데 매우 유용하며, 해외의 새로운 고객과 신뢰를 구축하는 데 도움이 됩니다.
원활한 협업을 위한 작업 할당 및 댓글 기능: Docsie는 제품 문서 팀과 협업하기 위한 놀라운 도구를 제공합니다. 댓글을 할당하고, 작업을 설정하고, 역할을 지정하여 Docsie로 제품 문서 프로젝트에서 작업하는 사용자가 어떤 작업을 완료했는지 더 잘 관리할 수 있습니다. 자세히 알아보려면 여기에서 이 블로그를 확인하세요.
피드백 생성: 고객이 문서에 대해 어떻게 생각하는지 알 수 있는 유일한 방법은 고객이 제품 문서와 지식 포털을 더 즐겁게 이해할 수 있도록 제품 문서를 최적화하는 방법을 아는 것입니다. 제품 문서 피드백의 중요성에 대해 자세히 알아보려면 여기에서 제 블로그를 확인하세요.
Docsie는 또한 귀하와 제품 관리 팀이 훌륭한 제품 문서를 만들기 위해 사용할 수 있는 많은 다른 기능과 기능을 제공합니다. 이 글에서는 각 Docsie 지식 포털과 제품 문서가 문서를 강화하고 전반적인 사용성을 개선하기 위해 추가할 수 있는 플러그인에 대해 알아보겠습니다.
문서 포털을 동적으로 만들어주는 Docsie 플러그인!¶
Docsie에는 문서를 더 매력적으로 만들 수 있는 다양한 플러그인이 있습니다. 이 블로그에서는 3부분으로 나누어 설명하겠습니다.
이 섹션에서는 지식 포털 플러그인 설명을 세 부분으로 나누겠습니다.
1부: 첫 번째 부분에서는 '버전 선택기 표시', '언어 선택기 표시', '섹션 앵커 표시', '푸터 내비게이션 표시'에 대해 설명합니다.
2부: 이 부분에서는 '코드 강조 표시', '검색', '소셜 네트워크에 공유' 플러그인을 보여드립니다.
3부: 세 번째 부분에서는 '이미지 미리보기', '문서 메타데이터', '자동 섹션 강조 표시' 플러그인을 보여드립니다.
플러그인으로 넘어가기 전에 Docsie 플랫폼 내에서 이러한 플러그인에 어떻게 접근할 수 있는지 알아보겠습니다.
먼저, 워크스페이스 내에서 오른쪽 상단 모서리에 있는 세 개의 점을 클릭하고 계정을 엽니다:
그런 다음 배포 내에서 '새 배포 구성+'을 통해 새 배포를 생성하면 플러그인에 접근할 수 있습니다.
그 다음 '더 많은 옵션'을 클릭하면 임베디드 스크립트나 Docsie 포털을 통해 배포된 문서에 이러한 플러그인을 추가할 수 있습니다.
다른 방법은 이미 게시된 문서 아래에 있는 '배포 구성 업데이트' 버튼을 통해 Docsie의 지식 포털 플러그인에 접근하는 것입니다.
이 대시보드가 열리면 필요에 따라 플러그인을 추가하거나 제거한 다음 배포를 업데이트할 수 있습니다.
1부:¶
이제 Docsie 플러그인에 어떻게 접근하는지 알았으니 1부로 넘어가겠습니다.
1부 비디오 튜토리얼을 보려면 여기에서 확인하세요:
'버전 선택기 표시'와 '언어 선택기 표시'부터 시작해보겠습니다.
이 두 가지가 활성화되면 지식 포털의 왼쪽 하단에 부동 탭으로 나타납니다. 이를 통해 고객과 제품 문서를 읽는 사람들이 다양한 언어와 버전으로 제품 문서를 볼 수 있습니다.
사용자가 언어 선택기 내에서 언어를 누르면 읽고 있는 전체 문서가 해당 언어로 변경됩니다.
섹션 앵커 표시가 활성화되면 고객이 각 헤더 옆에 링크를 가질 수 있어 문서의 특정 섹션으로 연결됩니다.
이 링크가 눌릴 때마다 헤더의 일부가 변경되고, 고객이 이 html을 복사하여 붙여넣으면 그들이 보내는 사람이 문서의 특정 섹션으로 직접 이동하게 됩니다.
다음은 '푸터 내비게이션 표시'입니다.
이 플러그인은 문서 북의 오른쪽 하단에 탐색 버튼을 추가합니다. 다음과 같이 보입니다.
이를 통해 고객이 더 편안하게 문서를 탐색할 수 있습니다.
2부:¶
2부 비디오 튜토리얼을 보려면 여기에서 확인하세요:
이 부분에서는 '코드 강조 표시', '검색', '소셜 네트워크에 공유' 플러그인을 보여드립니다.
먼저 '코드 강조 표시' 플러그인부터 시작해보겠습니다.
이 플러그인은 고객에게 다양한 코드를 표현해야 하는 기술 제품에 좋습니다. 이 플러그인은 고객이 할당된 코드를 복사하여 붙여넣을 수 있도록 하여 "복사" 버튼을 추가함으로써 편집기에서 쉽게 사용할 수 있게 합니다.
이제 검색 플러그인에 대해 알아보겠습니다.
Docsie의 지식 포털에서 활성화되면 고객은 지식 포털의 오른쪽 상단 모서리에 있는 검색 네비게이션을 통해 문서를 검색할 수 있습니다.
검색을 클릭하면 고객이 선반과 책 내에서 특정 정보를 정확히 어디서 찾을 수 있는지 파악할 수 있는 정교한 대시보드가 표시됩니다.
이는 고객이 제품에 관한 필요한 정보를 찾고 검색하는 과정을 크게 가속화합니다.
다음은 소셜 네트워크에 공유 플러그인입니다.
이 플러그인을 통해 고객은 작성된 제품 문서의 강조된 섹션을 가져와 소셜 미디어에서 공유할 수 있습니다.
이는 트래픽 증가, 잠재 고객 유치, 브랜드 신뢰도 향상에 좋습니다.
3부:
3부 비디오 튜토리얼을 보려면 여기에서 확인하세요:
세 번째 부분에서는 '이미지 미리보기', '문서 메타데이터', '자동 섹션 강조 표시' 플러그인을 보여드립니다.
이미지 미리보기 플러그인부터 시작해보겠습니다.
이미지 미리보기를 통해 고객은 제품 문서의 이미지를 더 잘 보기 위해 확대하거나 축소할 수 있습니다.
다음은 '문서 메타데이터'입니다.
이를 통해 고객은 제품 문서나 지식 포털의 측면이 업데이트된 시간을 확인할 수 있습니다. 작성된 문서의 상단과 하단에 위치합니다.
이제 '자동 섹션 강조 표시' 플러그인을 살펴보겠습니다.
이 간단한 플러그인은 고객이 지식 포털 내의 주어진 문서에서 자신의 위치를 추적할 수 있게 합니다.
지식 포털 내에서 각 위치를 강조 표시하여 고객이 현재 어느 섹션에 있는지 더 잘 추적하고 다른 섹션으로 더 쉽게 이동할 수 있습니다.
이 모든 도구와 더 많은 기능이 Docsie 플랫폼에서 제공됩니다. 아직 시도해보지 않았다면, 추천해 드립니다. 여기를 클릭하세요
질문이 있으시면 hello@docsie.io로 언제든지 문의해 주세요.