수많은 기술 SaaS 기업이 제품 설명서(사용자 설명서, 사용자 가이드 및/또는 튜토리얼)를 개발하여 소비자에게 배포하는 과정에서 어려움을 겪고 있습니다.
이는 매뉴얼의 적절한 취급 및 제작에 대한 지식이나 프로세스가 부족하거나 심지어 매뉴얼에 대한 책임이 누구에게 있는지에 대한 지식이 부족하기 때문에 발생하는 경우가 많습니다.
이 세상에 도구와 소프트웨어가 존재하는 한, 우리는 이러한 상품의 사용, 개발, 기능 및 구조를 다른 사람들에게 효과적으로 전달하기 위해 효과적인 커뮤니케이션을 필요로 할 것입니다. 그 이유가 궁금하다면 답은 간단합니다. 정보를 수집하고 청중이 제품이나 기술을 보다 효과적으로 이해할 수 있도록 하기 위해서는 기술 커뮤니케이션 기술이 필수적이기 때문입니다.
현실 세계에서의 커뮤니케이션은 말, 몸짓, 감정 표현을 통해 이루어지지만 가상 세계에서는 기술 제품 문서를 통해 기술 커뮤니케이션이 이루어집니다!
기술 제품 문서의 유일한 목적은 제품 및 기술의 작동 역학 및 아키텍처에 대한 사용자의 이해를 돕는 것입니다. 기술 제품 문서는 신입 직원, 사용자/고객, 그 외 작업 방법을 알아야 하는 모든 사람을 위한 '사용 방법' 핸드북에 가깝고, 제품의 너트와 볼트에 대한 철저한 설명이 담겨 있습니다!
제품 관리자는 세련된 제품 문서를 작성, 관리, 게시 및 유지 관리하기 위해 팀을 개발할 책임을 져야 합니다.
모든 제품 관리자가 소속 부서에서 다음과 같은 말을 했거나 들어본 적이 있을 것입니다: "제품 문서는 제품 소유자의 의무 중 하나다", "각 개발팀은 자체 앱을 문서화해야 한다", "기능이 배포되었는데 매뉴얼은 업데이트되었나?", "기술 문서에 오류가 있다"와 같은 말입니다.
분명 기술 제품 문서는 생각만큼 간단하지 않을 수 있습니다! 개인이 앞 단락의 내용을 해결하거나 논쟁을 벌이는 동안 매뉴얼과 튜토리얼의 품질은 저하되고 이는 '제품/회사' 이미지에 악영향을 미칩니다.
비슷한 문제를 겪고 있는 분들을 돕기 위해 제품 문서를 최적화하기 위해 구현할 수 있는 몇 가지 절차를 소개합니다.
제품 문서의 목적은 무엇인가요?
기술 제품이나 서비스에 대한 제품 문서란 이를 설명하는 정보 및 이와 관련된 데이터를 말합니다.
기술 문서 또는 제품 문서는 잠재 고객과 고객이 제품을 활용하고, 읽고, 이해하고, 활용할 수 있도록 돕는 것입니다. 물론 대부분의 제품 문서는 엔지니어링, 의료, 정보 기술, 마케팅 등 다양한 분야에서 제작됩니다.
훌륭한 기술 제품 문서는 잠재 고객이 제품을 탐색하고 복잡한 문제 없이 제품을 활용할 수 있도록 도와줍니다.
또 한 가지 고려해야 할 사항은 기술 문서는 고객 지원에 매우 중요하며 회사의 브랜드와 신뢰도에 크게 기여한다는 것입니다. 사용자는 가장 도움이 필요할 때 기술 문서를 검색합니다. 사용자는 제품을 사용하여 프로세스에 대해 배우고 문제를 해결합니다.
따라서 검색 기능을 통해 동적으로 업데이트되는 철저하고 포괄적인 제품 설명서를 보유하는 것이 매우 중요합니다.
다양한 제품 문서란 무엇인가요?
이 섹션에서는 고객이나 클라이언트를 위해 어떤 종류의 제품 문서가 필요한지 확인할 수 있습니다.
다양한 유형의 사용 사례와 사용자 요구 사항을 충족하는 다양한 제품 문서 유형이 있습니다:
**제품 사용자 문서: 사용자 설명서, 사용 방법 가이드, 튜토리얼, 자주 묻는 질문, 릴리즈 노트, 교육 매뉴얼, 운영 절차로 구성됩니다.
기업 문서: 설문조사 결과에 따르면 조사에 참여한 1,000개 기업 중 10개 중 8개 이상의 기업이 공식 정책과 절차 매뉴얼을 사용하고 있는 것으로 나타났습니다.
위의 조사에서 언급된 기업 정책 및 절차에 관한 문서, 지침 매뉴얼, 기술 관행, 행동 및 윤리 문서로 구성된 다른 많은 기업 문서가 있습니다. 비밀번호로 보호할 수 있는 법률 문서도 있습니다. 또한 회사 구조, 모범 사례 및 절차, 유지 관리 매뉴얼도 포함됩니다.
개발자 문서: 이 유형의 문서는 소프트웨어 제품 개발 지침, 기능 사양, 기술 사양, 문서, 개발자 워크플로우를 지원하는 도구를 제공합니다.
이제 기술 및 제품 문서의 다양한 유형을 더 잘 이해했으니 이제 제품 문서 개발 프로세스의 견고한 관리를 위한 첫 번째 단계가 무엇부터 시작되는지 논의해 보겠습니다.
제품 문서 개발 책임자 찾기
매우 일반적인 문제는 제품 문서를 단순히 업데이트하는 사람이 아니라 제품의 품질과 성공에 대한 책임이 있는 사람으로서 누가 제품 문서를 담당해야 하는지를 결정하는 것입니다.
일부 기업에서는 각 제품 소유자 및/또는 제품 관리자가 제품 문서에 대한 책임이 있다고 생각하지만, 개발 및 지원 문서와 같은 다른 부서에서도 사용자 설명서, 사용자 가이드 및 모든 측면의 제품 문서를 최신 상태로 효과적으로 유지할 책임을 맡을 수 있습니다.
제품 문서 개발에는 여러 가지 중요한 부분이 있지만 여기서는 그 중 두 가지를 짚어보겠습니다:
-
모든 수준에서 제품의 작동 방식을 이해하는 사람(여기에는 제품 개발 및 사양 팀도 포함됨).
-
제품 설명서를 검토하는 고객의 의견을 수렴하고 제품 설명서를 이해하는 데 있어 고객의 어려움, 피드백 및 우려 사항을 경청하는 사람.
첫 번째 파트는 현재 지식을 바탕으로 할당된 제품 문서를 작성하는 데 도움을 주며, 이는 고객에게 전달되어 피드백을 주고 문서를 최적화하는 데 도움이 되는 두 번째 프로세스를 시작합니다.
때때로 이 두 가지가 완벽하게 이루어지지 않아서 제품 문서가 필요한 주의를 받지 못하는 상황이 발생하기도 합니다.
한 가지 접근 방식은 제품 문서, 제품 설명서 및 사용자 가이드 "성능"을 책임질 담당자를 지정하는 것입니다. "제품 문서"가 제품인 구매 주문서를 예로 들어 보겠습니다. 이 담당자는 회사의 모든 팀을 검토하여 각 제품이 가이드를 생성하는 방법을 스케치하고 해당 프로세스와 관련된 문제를 파악할 책임이 있습니다.
이 제품 소유자이자 제품 관리자가 매뉴얼을 생성하고 수정하는 데 전적으로 책임을 지는 것이 아니라 각 팀 내의 개인이 문서 관리를 할 수 있도록 지원하는 것이 목적입니다.
이 사람은 사용자가 문서와 상호 작용하는 방식을 연구하고, 보다 유동적으로 업데이트할 수 있는 방법을 제시하며, 피드백을 수집하여 각 제품 문서와 설명서를 대상 고객에 맞게 개선하는 방법을 결정해야 합니다.
제품 문서의 모든 측면을 담당하고, 워크플로우를 관리하며, 이 문서를 작성하는 데 필요한 여러 부서를 관리하는 사람이 있으면 회사 내 생산성이 향상되고, 제품에 대한 지식 포털을 통해 고객에게 인지도를 높이고 교육할 수 있으며, 무엇보다도 제품 이해도를 간소화할 수 있습니다.
제품 문서를 제품 그 자체로 바라보세요.
제품은 고객의 기대를 충족하거나 그 이상의 가치를 제공하기 위해 존재합니다. D2WorldWide에서 생성한 통계](https://www.d2worldwide.com/product-documentation-why-do-customers-still-want-it-and-retailers-still-need-it/)에 따르면 구매를 고려 중인 제품에 대한 정보를 찾을 때 동영상, 포장, 영업사원보다 문서가 더 도움이 된다고 평가하는 비율이 73.7%에 달합니다.
제품의 매력에 기여하는 요소를 고려하세요. 제품의 매력에 영향을 줄 수 있는 요소는 여러 가지가 있지만, 이 글에서는 세 가지에 집중하겠습니다. 가치 측면에서 기대치를 뛰어넘는 제품, 사용 시 만족감을 주는 제품, 그리고 경쟁력이 있는 제품입니다.
또한 좋은 온라인 제품 문서에도 동일한 개념이 적용됩니다. "예상 가치를 뛰어넘는" 제품 문서는 지정된 품목의 사용 방법뿐만 아니라 고객이 알지 못하거나 가능하다고 생각하지 않는 솔루션도 제공합니다. 성공과 실수로부터 배우기 위해서는 다른 회사가 제품 문서를 어떻게 시작하는지 항상 살펴볼 필요가 있습니다.
기술 제품 문서를 통합하는 개발자와 고객이 이해하지 못한다면 경쟁사보다 앞서가는 독창적이고 고품질의 소프트웨어를 개발하는 회사가 있다는 것은 의미가 없습니다.
제품 문서를 읽는 사람은 제품에서 제공하는 가능한 솔루션의 범위나 시장에 대해 잘 모를 수 있으므로(기술 SaaS 제품의 경우 일반적으로 그렇듯이) 해당 솔루션과 제품과 관련된 다양한 옵션에 대해 '교육'을 받아야 한다는 점을 고려해야 합니다.
'사용성이 만족을 창출하는' 제품 문서는 대상 고객에게 적합한 논리적 읽기 패턴을 따릅니다. 500페이지 분량의 PDF로 되어 있거나 코드 예제가 포함되어 있지 않고 검색 기능 및 기타 기능이 동적으로 생성되지 않는다면 세계에서 가장 철저한 매뉴얼을 가지고 있어도 아무 소용이 없습니다. 제품 문서 사용자와 지원 담당자로부터 피드백을 수집하세요. 이들은 보고된 데이터와 관련된 주요 스트레스 영역을 확인할 것입니다.
경쟁력 있는 제품 문서는 가장 효과적인 정보 교환 기술을 사용하여 지속적으로 업데이트되는 문서입니다. 이러한 문서에는 내장 검색 기능, 번역, 다양한 버전, 임베디드 이미지, 동영상 등과 같은 놀라운 기능이 있습니다!
통합 가이드가 모든 기술 비즈니스 중에서 가장 잘 작성되어 있더라도 기술 SaaS 제품을 구매하는 기술에 정통한 고객이 쉽게 사용할 수 있도록 동영상과 복사하여 붙여넣을 수 있는 이미지 및 코드가 추가되지 않으면 매력이 부족할 것입니다.
성공과 실수로부터 배우기 위해 다른 회사가 어떻게 문서를 시작하는지 항상 살펴볼 필요가 있습니다.
문서를 통합하는 개발자와 고객이 문서를 전체적으로 파악할 수 없다면 경쟁사보다 앞서가는 독창적이고 고품질의 소프트웨어를 개발하는 회사의 존재는 의미가 없습니다.
제품 문서 피드백
효과적인 기술 제품 문서는 프로세스를 개선하여 제품을 이해하고 쉽게 사용할 수 있는 서면 솔루션으로 문제를 진단함으로써 최종 사용자 경험을 향상시킵니다. 고객이 귀사의 제품 사용 방법을 신뢰하고 이해하면 나중에 필요할 때 귀사를 다시 찾을 수 있습니다.
SDL의 새로운 연구에 따르면 전 세계 시장에서 문서의 역할이 점점 더 커지고 있습니다. 연구에 따르면 구매자의 약 53%가 제품을 사용해 보기 전에 기술 문서를 보고 구매를 결정한다고 합니다. 또한 이 연구의 또 다른 통계에 따르면 구매자의 94%가 제품 정보를 한 곳에 모아두는 것이 도움이 되고 유용하다고 생각하는 것으로 나타났습니다. 이 때문에 요즘은 각 회사에서 제품 개발이나 테스트뿐만 아니라 제품 문서화에도 똑같이 중점을 두고 있습니다.
문서화 팀을 관리하는 책임자가 지정되어 있고, 사용성 개선을 위해 수정과 평가를 거쳐 제품 문서를 작성하고 제대로 업데이트가 되었다고 해도 사용자나 소비자들이 기술적인 제품을 이해하기에는 여전히 어려움이 있습니다. 이는 사용자/독자가 문서를 읽는 방식이나 그들이 진정으로 묻는 질문을 이해하지 못하기 때문에 발생할 수 있습니다. 따라서 문서 작성에서 가장 어려운 측면 중 하나는 독자의 입장에서 생각하는 것입니다. 결국 제품 문서를 작성하는 사람은 누구든지 제품에 대한 확실한 이해가 있어야 합니다.
이러한 전문 지식으로 인해 작성자는 일반 사용자에게는 분명하지 않은 사항을 간과할 수 있습니다. 일반적으로 제품을 만드는 사람에게는 자명하지만 제품을 구매하고 사용하는 사람에게는 명확하지 않은 부분이 있을 때 이런 일이 발생합니다.
이는 다양한 방식으로 발생할 수 있습니다:
**글쓰기 구조 또는 형식: 주관적인 표현으로 보일 수 있지만, 핸드북을 작성하는 방식조차도 혼란을 야기할 수 있습니다. 문서를 읽는 독자의 유형을 파악하는 것이 중요합니다. 그렇지 않으면 "개발자는 설명적인 텍스트보다 예제를 선호합니다." 또는 "예제와 시각 자료가 있음에도 불구하고 문서가 명확하지 않습니다."와 같은 문구가 발생할 수 있습니다.
**매뉴얼에 정리된 주제: 같은 시장에서 활동하는 기업끼리 표준화된 문서 형식을 개발하는 경우가 있습니다. 기업 가이드가 이를 따르지 않는다면 독자는 이질감을 느낄 수 있습니다.
**암시적 용어의 과도한 사용: 핸드북에 약어를 사용할 경우, 약어가 아니더라도 문구의 의미가 거의 없을 수 있습니다. '상태', 'ID', '자격증명' 등의 단어에는 명시적인 의미로 위장한 암시적 의미가 포함되어 있어 인지하기 어렵습니다. "UID" 대신 "사용자 아이디"와 같은 특정 명칭을 사용하세요.
올바른 번역: 번역은 글로벌 도달에 있어 큰 부분을 차지합니다. 많은 기업이 특정 국가의 문화에 맞지 않거나 단순히 단어가 특정 국가에서 영어와 동일하게 번역되지 않는 잘못된 번역의 사용자 설명서와 제품 문서를 작성합니다. 이러한 미묘한 뉘앙스를 이해하면 제품 설명서를 읽을 수 없는 정보에서 완전히 포괄적이고 번역된 제품 설명서로 만들 수 있습니다.
이러한 상황을 방지하기 위해 사용자 피드백과 탐색 패턴을 수집하고 분석하는 솔루션을 개발하는 것이 목표입니다.
Vocally a Docsie 기능과 같은 피드백 도구는 탐색 패턴을 파악 및 평가하고 고객이 제품 문서를 어떻게 보는지 조사할 수 있는 좋은 방법입니다. [여기에서 피드백 수집의 7가지 황금률에 대해 알아보세요.(https://www.docsie.io/blog/articles/7-golden-rules-to-successfully-approach-customer-feedback/)
이러한 정보는 사용자 가이드, 사용자 매뉴얼 및 제품 문서를 업데이트하고 최적화하여 고객이 제품에 대해 더욱 원활하게 학습할 수 있는 환경을 만드는 데 매우 중요합니다. 새로운 제품을 출시했는데 매뉴얼 지침이 부실하여 지원 요청이 증가하는 것을 발견하는 것보다 더 실망스러운 일은 없습니다.
포괄적인 제품 문서를 작성하는 방법
양질의 제품 문서는 매력적이고 유용하며 강력합니다. 저는 능숙한 문서화가 훌륭한 제품 관리의 필수 요소라고 주장하고 싶습니다. 제품 관리자가 제품 개발에서 큰 역할을 하는 만큼 성공의 중요한 부분은 고객이 이해하고 제품에 대한 지식을 넓히는 데 사용할 수 있는 훌륭하고 세련된 제품 문서를 작성하는 것입니다.
대부분의 제품 문서에는 어떤 문제가 있을까요?
많은 제품 관리자가 제품 문서 초안 작성을 꺼려합니다. 그들이 익숙한 제품 문서는 매력적이고 읽기 쉽고 공감하기 쉽게 만드는 데 더 많은 주의를 기울이지 않으면 고객의 관심을 끌지 못할 수 있습니다.
그러나 많은 기업들이 훌륭한 제품 문서를 작성하고 제작하는 데 필요한 주의를 기울이지 않는 경우가 많습니다. 부실한 제품 문서는 단지 문서 작성만을 목적으로 작성됩니다. 모호하게 받아들일 수 있는 생각으로 가득 찬 장황한 문구와 부실한 레이아웃을 사용하여 보는 사람이 자료와 상호 작용하는 것을 방해합니다. 부실한 제품 문서는 작성자를 비판으로부터 보호하기 위해 작성되며 모든 사람의 시간을 완전히 낭비합니다. 고객도 이런 이유로 문서를 읽는 것을 싫어합니다.
이 문제를 해결하고 고객이 즐겁게 읽을 수 있는 더 나은 제품 문서를 작성하려면 어떻게 해야 할까요?
훌륭한 제품 문서는 읽힐 의도로 작성됩니다. 간결합니다. 좋은 제품 문서는 형식이 잘 갖추어져 있으며 회사 직원이나 고객 모두가 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의 복잡한 과정을 거치지 않고도 바로 게시할 수 있기 때문에 매우 유용합니다. 제품 문서가 준비되면 노 스위치만 누르면 자동으로 렌더링됩니다.
검색 기능: 제품 문서가 많거나 기능이 많은 경우 Docsies 검색 플러그인 광고는 고객이 문서를 빠르고 쉽게 검색하여 필요한 정보를 찾아 제품 문서에서 정보를 미리보고 흡수하는 프로세스의 속도를 높일 수 있는 유용한 보너스입니다.
링크 기능: 닥시는 제품 문서를 SEO 친화적으로 만듭니다. 회사 웹사이트의 특정 페이지로 백링크하거나 온라인에서 검색 가능한 제품 기반의 키워드를 작성하여 동일한 제품을 찾고 있는 신규 고객을 유치할 수 있습니다.
**다양한 번역 기능: Docsies의 최첨단 고스트 번역기를 사용하면 제품 문서를 다양한 언어로 번역할 수 있습니다. 또한 닥시의 언어 선택 기능을 사용하면 고객이 자신에게 가장 적합한 언어를 선택할 수 있습니다. 이는 전 세계로 진출하고 기업의 고객 기반을 확장하는 동시에 신규 고객 및 해외 고객과의 신뢰를 구축하는 데 매우 유용합니다.
원활한 협업을 위해 작업을 할당하고 댓글을 달 수 있는 기능: 닥시는 제품 문서화 팀과의 협업을 위한 놀라운 도구를 제공합니다. 코멘트를 할당하고, 작업을 설정하고, 역할을 할당할 수 있으므로 Docsie를 사용하여 제품 문서화 프로젝트에서 작업하는 사용자가 어떤 작업을 수행하는지 더 잘 관리할 수 있습니다. [자세한 내용은 이 블로그(https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/)에서 확인하세요.)
피드백 생성: 고객이 문서에 대해 어떻게 생각하는지 알 수 있어야 고객의 요구에 맞게 제품 문서를 최적화하여 고객이 제품 문서와 지식 포털을 더 즐겁게 이해할 수 있습니다 제품 문서 피드백의 중요성에 대해 자세히 알아보려면 제 블로그를 확인하세요.
그 외에도 여러분과 여러분의 제품 관리 팀이 훌륭한 제품 문서를 작성하는 데 사용할 수 있는 다양한 기능이 있습니다. 이 글에서는 각 Docsie 지식창고와 제품 문서에 추가하여 문서를 향상시키고 전반적인 사용성을 개선할 수 있는 플러그인에 대해 살펴보고자 합니다.
문서 포털을 역동적으로 만드는 ## Docsie 플러그인!Docsie에는 문서를 더욱 매력적으로 만드는 데 사용할 수 있는 다양한 플러그인이 있습니다. 이 블로그에서는 세 부분으로 나누어 설명하겠습니다.
이 섹션에서는 이러한 지식 포털 플러그인에 대한 설명을 세 부분으로 나누어 설명하겠습니다.
파트 1: 첫 번째 파트에서는 '디스플레이 버전 선택기', '디스플레이 언어 선택기', '디스플레이 섹션 앵커', '디스플레이 바닥글 탐색'에 대해 설명합니다.
2 부 : 이 부분에서는 '코드 강조 표시', '검색'및 '소셜 네트워크에 공유'플러그인을 보여줄 것입니다.
파트 3: 3부에서는 '이미지 미리보기', '문서 메타데이터', '섹션 자동 강조' 플러그인을 보여드립니다.
플러그인을 살펴보기 전에 먼저 닥시 플랫폼 내에서 이러한 플러그인에 액세스하는 방법에 대해 설명하겠습니다.
먼저 작업 영역에서 오른쪽 상단에 있는 점 세 개를 클릭하고 계정을 열어야 합니다:
그런 다음 배포 내에서 '새 배포 구성+'를 통해 새 배포를 생성하면 플러그인에 액세스할 수 있습니다.
그런 다음 '추가 옵션'을 클릭하면 임베드된 스크립트 또는 Docsie 포털을 통해 배포된 문서에 이러한 플러그인을 추가할 수 있습니다.
다른 옵션은 이미 게시된 문서 아래의 '배포 구성 업데이트' 버튼을 통해 Docsie의 지식창고 플러그인에 액세스하는 것입니다.
이 대시보드가 열리면 필요에 따라 플러그인을 추가하거나 제거한 다음 배포를 업데이트할 수 있습니다.
PART 1:
이제 Docsie 플러그인에 액세스하는 방법을 알았으니 파트 1로 넘어가겠습니다.
파트 1** 비디오 튜토리얼을 보시려면 여기에서 이 비디오를 확인하세요:
'디스플레이 버전 선택기'와 '디스플레이 언어 선택기'부터 시작해 보겠습니다.
이 두 가지가 활성화되면 지식창고 왼쪽 하단에 플로팅 탭으로 나타납니다. 이를 통해 고객과 제품 문서를 읽는 사람들이 서로 다른 언어와 버전으로 제품 문서를 볼 수 있습니다.
사용자가 언어 선택기에서 언어를 누르면 읽고 있는 전체 문서가 해당 할당된 언어로 변경됩니다.
섹션 표시 앵커가 활성화되면 고객이 각 헤더 옆에 문서의 특정 섹션으로 연결되는 링크를 표시할 수 있습니다.
이 링크를 누를 때마다 헤더를 제외하고는 변경되며 고객이 이 HTML을 복사하여 붙여넣으면 보내는 사람에게 문서의 이 특정 섹션으로 연결됩니다.
다음은 '바닥글 탐색 표시'입니다.
이 플러그인은 문서 북의 오른쪽 하단에 탐색 버튼을 추가합니다. 다음과 같은 모양입니다.
이렇게 하면 고객이 문서를 더 편안하게 탐색할 수 있습니다.
PART 2:
2부 **비디오 튜토리얼을 보려면 여기에서 이 비디오를 확인하세요:
이 부분에서는 '코드 강조 표시', '검색', '소셜 네트워크에 공유' 플러그인을 보여드리겠습니다.
이제 '코드 강조 표시' 플러그인부터 시작해 보겠습니다.
이 플러그인은 고객에게 다양한 코드를 표현해야 하는 기술 제품에 적합합니다. 이 플러그인을 사용하면 고객이 할당된 코드를 복사하여 붙여넣기할 수 있으며, '복사' 버튼을 추가하여 에디터에서 쉽게 사용할 수 있습니다.
이제 검색 플러그인에 대해 자세히 알아보겠습니다.
Docsie의 지식창고에서 활성화되면 고객은 지식창고의 오른쪽 상단에 있는 검색 탐색을 통해 문서를 검색할 수 있습니다.
고객이 검색을 클릭하면 정교한 대시보드가 표시되어 고객이 서가 및 도서 내에서 특정 정보를 정확히 찾을 수 있는 위치를 파악할 수 있습니다.
이를 통해 고객이 제품에 대해 필요한 정보를 찾고 검색하는 프로세스의 속도를 크게 높일 수 있습니다.
다음은 소셜 네트워크에 공유 플러그인입니다.
이 플러그인을 사용하면 고객이 작성된 제품 문서에서 강조 표시된 섹션을 가져와 소셜 미디어에서 공유할 수 있습니다.
이는 트래픽과 새로운 잠재 고객을 늘리고 브랜드에 대한 신뢰를 높일 수 있기 때문에 매우 유용합니다.
파트 3:
3부 **비디오 튜토리얼을 보려면 여기에서 이 비디오를 확인하세요:
3부에서는 '이미지 미리보기', '문서 메타데이터', '섹션 자동 강조' 플러그인을 보여드리겠습니다.
이미지 미리보기 플러그인부터 시작하겠습니다.
이미지 미리 보기를 사용하면 고객이 제품 문서의 이미지를 확대하거나 축소하여 더 잘 볼 수 있습니다.
다음은 '문서 메타데이터'입니다.
이를 통해 고객은 제품 문서 또는 지식창고의 일부가 업데이트된 타임스탬프를 확인할 수 있습니다. 이 타임스탬프는 작성된 문서의 상단과 하단에 위치합니다.
이제 '자동 하이라이트 섹션 플러그인'을 살펴보겠습니다.
이 간단한 플러그인을 사용하면 고객이 지식창고 내의 특정 문서에서 현재 위치를 추적할 수 있습니다.
지식 포털 내에서 각 위치를 강조 표시하여 yo8ru 고객이 어떤 섹션에 있는지 더 잘 추적하고 다른 섹션으로 더 쉽게 이동할 수 있도록 합니다.
이러한 모든 도구와 그 이상은 Docsie의 플랫폼에서 제공됩니다. 아직 사용해 보지 않으셨다면 꼭 사용해 보시기 바랍니다. 여기를 클릭하세요
또한 질문이 있으시면 hello@docsie.io로 언제든지 문의해 주세요.