신제품 문서 출시 시 15가지 모범 사례

신제품을 출시할 때 모범 사례 중 하나는 제품 출시 준비를 수행하는 것입니다. 특히 제품 출시를 지원하기 위한 신제품 문서 작성에 집중하는 것이 좋습니다. 문서가 없으면 잠재 사용자가 새 솔루션을 구매한 후 참고할 수 있는 관련 정보가 없습니다.

보다 광범위한 마케팅 전략의 일환으로 제품 관리자와 제품 팀원은 다음 제품 출시 시 따라야 할 15가지 모범 사례에 대해 계속 읽어야 합니다. 마지막에는 이러한 중요한 문서를 최상의 상태로 만드는 방법을 이해하게 될 것입니다!

어떤 유형의 제품 문서를 작성해야 하나요?

모범 사례 목록을 살펴보기 전에 어떤 유형의 제품 문서가 존재하며 각 문서가 의도하는 목표가 무엇인지 명확히 알아봅시다:

• 제품 요구 사항 문서** - 제품 요구 사항 문서 또는 PRD는 기업이 릴리스 기준을 충족하는 데 사용되는 내부 제품 문서의 한 유형입니다. 여기에는 최종 제품이 사용자를 위해 무엇을 달성해야 하는지 설명하지만, 방법이나 위치를 구체적으로 정의하지는 않습니다. 그런 다음 개발팀과 테스트팀은 PRD를 사용하여 제품을 출시할 준비가 된 비즈니스 요구 사항에 맞게 조정합니다. PRD는 소프트웨어 제품에 일반적으로 사용되지만 모든 제품 로드맵을 준수하는 데 사용할 수 있습니다.

• 사용자 가이드 및 셀프 서비스** - 제품 팀은 성공적인 제품 출시를 위한 소프트 전제 조건으로 사용자 가이드를 만들어야 합니다. 이름에서 알 수 있듯이 사용자 가이드는 최종 사용자가 새 제품을 사용할 때 생산성을 극대화할 수 있도록 도와주는 문서입니다. 여기에는 고객이 최대한의 가치를 얻을 수 있도록 모든 주요 사용자 대면 기능이 자세히 설명되어 있어야 합니다. 더 좋은 방법은 셀프 서비스 외부 지식창고에서 이러한 가이드를 공유하여 고객이 스스로 도움을 받을 수 있도록 하는 것입니다!

• 설정, 설치 및 구성 가이드** - 제품에 설정, 설치 및 구성이 필요한 경우에는 또 다른 기술 제품 문서 자산을 만들어야 합니다. 목표는 사용자 관점과 해당되는 경우 개발자 관점에서 이러한 프로세스를 명확하게 설명하는 것입니다. 소프트웨어 문서의 경우 여러 장치와 여러 운영 체제에 걸쳐 있을 수 있으므로 이 점을 염두에 두어야 합니다.

• 마케팅 에셋** - 이것이 제품 문서라고 생각하지 않으실 수도 있지만, 실제로는 제품 문서입니다! 마케팅 자산의 스타일과 형식은 고객이 제품을 사용하기 전에 제품을 인식하는 방식에 영향을 미칩니다. 좋은 인상을 남기는 것이 중요합니다. 제품의 새로운 기능을 어떻게 설명하고 있나요? 어떤 대상을 대상으로 하나요? 이 기능이 누군가의 업무나 개인 생활을 어떻게 개선할 수 있을까요? 여러분과 회사 전체가 고객이 이렇게 생각하기를 바라는가?

신제품 출시 시 문서화를 위한 15가지 모범 사례

제품 문서에 대한 입문서에 이어서 다음은 모범 사례 목록입니다:

1: 시작하기!

이제 막 제품 문서로 시작하시나요? 훌륭합니다! 이제 주저하지 마시고 시작하세요. 많은 사람들이 제품 문서를 완벽하게 작성하기를 원하지만, 완벽을 추구하다 보면 그 작업에 마비가 오기도 합니다. 서비스에 대한 기본 개념을 문서로 정리한 다음, 고객에게 깊은 인상을 남길 수 있도록 깔끔하게 정리하는 데 집중하세요. 릴리즈 노트는 기본 사항을 정의하는 데 매우 유용하며, 이 문서를 기반으로 구축할 수 있습니다.

2: 단순하게, 바보처럼...

KISS의 줄임말인 이 원칙은 60년대 미 해군에서 유행했던 실제 디자인 원칙입니다(말장난 의도). 제품 문서에도 동일한 원칙이 적용될 수 있습니다. 스스로에게 물어보세요: "어떻게 하면 모든 인구 통계가 이해할 수 있는 방식으로 필요한 정보를 전달할 수 있을까?"

이를 제품 비전에 적용하려면 플레쉬-킨케이드 가독성 테스트를 권장합니다. Grammarly와 같은 콘텐츠 채점 도구는 일반적으로 이 시스템을 사용합니다. 이 테스트는 서면 콘텐츠를 분석할 때 미국 고등학교 성적에 해당하는 점수를 제공합니다. 콘텐츠의 해석 가능성을 극대화하려면 8학년 또는 취학 연령인 13~14세를 목표로 하세요 - 잠깐만요... 글을 얼마나 쉽게 이해할 수 있는지 말이죠.

3: 타겟 고객 이해하기

지금까지 간단하게 시작하셨군요. 이제 실제로 누구를 대상으로 글을 쓰고 있는지 알아야 합니다. 예를 들어 소프트웨어 회사의 타깃 독자는 자동차 제조업체와 매우 다를 것입니다.

어린 학생들이 개념을 단계별로 학습할 수 있는 간단한 도구에 중점을 둔 교육용 소프트웨어 회사를 상상해 봅시다. 가장 먼저 떠오르는 생각은 "그럼 타겟 고객은 어린이겠군요?"일 것입니다. 꼭 그렇지는 않습니다. 유치원이나 고등학교의 소프트웨어 패키지에 대한 주요 의사 결정권자(예: IT 부서 및 조달을 담당하는 내부 이해관계자)가 대상 고객입니다. 두 번째 대상은 교육용 소프트웨어를 직접 보고 학교에서의 사용을 지지할 수 있는 어린 학생들입니다.

4: 스토리보다는 가치에 집중하기

누구나 좋은 스토리를 좋아하지만, 고객은 제품이 어떤 가치를 제공하는지 알고 싶어합니다. 작업이나 워크플로우를 간소화할 수 있나요? 온라인에서만 제공되는 경쟁사와 달리 오프라인에서도 제품을 사용할 수 있나요? 다른 경쟁 제품보다 더 빠르게 작업을 수행할 수 있나요?

이러한 예는 특정 제품의 고유한 판매 포인트(USP)를 구성합니다. USP에 초점을 맞추고 강조하면 잠재 고객을 유혹하고 다른 업체에는 없는 장점을 이해시켜 시장 점유율을 높일 수 있습니다. 업계 경쟁업체에 대한 경쟁 분석을 수행하여 USP를 정의할 수 있습니다.

5: 서식을 활용하여 정보 분류하기

문서는 큰 텍스트 블록이 되어서는 안 됩니다. 최종 사용자가 스캔하고 탐색하기 어렵습니다. 대신 제목 및 기타 서식 옵션을 사용하여 텍스트를 나누세요.

H1 제목은 사람들이 페이지를 클릭할 때 가장 먼저 보게 되는 것입니다. H2 및 H3는 페이지에서 다루는 주제에 대한 하위 제목 역할을 합니다. 글머리 기호 또는 번호 매기기 목록을 사용하여 콘텐츠를 그룹화하여 쉽게 읽을 수 있도록 하고, 리치 스니펫을 사용하여 SEO 및 SERPS 가시성을 개선할 수도 있습니다. 마크다운에 대한 지식이 있다면 Docsie와 같은 온라인 마크다운 편집기에서 다양한 서식 옵션을 제공하여 제품 문서를 돋보이게 만들 수 있습니다!

6번: 문서를 한곳에 보관하세요.

기술 문서를 배포한 후 장기적으로 모니터링하고 관리하는 것이 얼마나 복잡한 일인지 깨닫는 것보다 더 나쁜 일은 없습니다. 문서에 업데이트가 필요한 경우 어떻게 해야 할까요? 원본 문서는 어디에 있으며 새 버전의 페이지를 어떻게 공개할 수 있을까요? 이 콘텐츠를 다른 언어로 번역하는 것은 어떨까요?

이 모범 사례에 대해서는 Docsie를 언급하지 않을 수 없습니다! 온라인 지식창고 소프트웨어를 사용하면 문서를 하나의 중앙 집중식 클라우드 위치에 저장할 수 있습니다. 여기에서 직원과 계약업체가 콘텐츠에 대해 공동 작업하여 출시에 맞춰 신속하게 완성할 수 있습니다. Docsie는 지식을 업데이트해야 할 때 버전 제어 관리와 글로벌 콘텐츠 로컬라이제이션을 위한 언어 관리 기능을 제공합니다. 글로벌 콘텐츠 제작을 자동화하고 싶다면 백그라운드에서 정확하게 번역해주는 멋진 고스트 AI 언어 번역 봇도 있습니다!

7: 그림이 천 단어를 말하다

작업 방법에 대한 장황한 설명을 작성하는 것은 최종 사용자에게 효과적인 교육 방법이 아닙니다. 대신 사진이나 동영상으로 보여주세요!

각 제품 문서에 대한 동영상 튜토리얼을 함께 만들어 보세요. 이렇게 하면 읽기를 선호하는 사람은 텍스트를 훑어보고, 시각적 학습자는 동영상을 선택할 수 있습니다. 마찬가지로 GIF와 이미지는 특히 소프트웨어 사용자 인터페이스(UI) 내에서 사용자가 참조하는 내용을 확인하는 데 도움이 될 수 있습니다. 다양한 학습 스타일을 수용하면 더 많은 사용자를 도울 수 있으므로 제품의 잠재력이 더 커집니다.

8: 학습 대 목표 대 이해 대 정보

문서의 의도는 무엇인가요? 사용자 의도는 온라인 제품 문서에서 매우 중요하며, 사용자 여정의 섹션에 맞게 콘텐츠를 조정하는 데 도움이 됩니다.

• 학습** - 이전에 본 적이 없는 사람이라면 학습 콘텐츠는 기본 원리를 이해하는 데 도움이 됩니다.

목표 - 이러한 유형의 콘텐츠는 'Docsie에서 PDF 파일을 내보내는 방법'과 같이 사용자가 목표를 달성하는 데 도움이 되어야 합니다. 마지막에 사용자는 PDF 내보내기라는 목표를 달성하게 됩니다.

이해 - 연구라고도 하며, 주제에 대해 이미 실무 지식이 있지만 더 깊이 이해하고 싶은 고객을 위한 콘텐츠입니다.

정보 - 질문이 있고 구체적인 답변을 원합니다. 특정 지역의 실시간 날씨나 '나무 위의 집 짓는 법'에 대한 동영상처럼 간단한 질문일 수도 있습니다.

9번: 검색 가능하게 만들기

이 문서를 공개하기 전에 사용자가 텍스트 내에서 키워드를 검색할 수 있나요?

그렇지 않다면 이를 지원하는 문서 플랫폼을 찾는 것이 좋습니다. 사용자가 정보를 빠르게 찾을 수 없는 것이 가장 큰 장애물입니다. 정보를 찾지 못하면 불만과 고객 지원팀의 업무 부담이 가중되고 전반적인 고객 경험(CX)이 부정적으로 변합니다. 아, 궁금하신 분들을 위해 Docsie는 글로벌 검색을 지원합니다!

10번: 실행 가능한 피드백 수집 준비하기

문서 작성자는 콘텐츠의 초기 버전이 추후에 변경될 수밖에 없다는 사실을 알고 있을 것입니다. 대중이 문서를 볼 때까지 문서 작성자들은 서로에게 아이디어와 피드백을 주고받을 수 밖에 없습니다.

문서가 게시된 후에는 피드백을 수집하는 것이 필수적이라고 생각합니다. 이렇게 하면 작성자가 실제 고객과 최종 사용자의 의견을 경청하여 콘텐츠와 관련된 부정적인 의견을 긍정적인 의견으로 바꿀 수 있습니다. 다른 곳을 찾을 필요 없이 Docsie에서 피드백 수집 기능을 활용할 수 있습니다!

11번: 주제 언급 시 페이지로 링크하기

이 모범 사례는 SEO 및 웹 페이지 탐색 구조를 활용합니다.

키워드를 언급할 때 해당 키워드로 링크하나요? 다른 주제를 언급할 때 사용자가 현재 페이지의 맥락에서 다른 주제를 아직 이해하지 못할 수 있습니다. 문서가 있는 언급된 주제에 링크를 걸어야 독자들이 주요 주제에 대해 배우면서 하위 주제를 빠르게 참조할 수 있습니다.

12번: 모호함이 아닌 명확함

제품 문서를 작성할 때는 명확성이 모호함보다 중요합니다. 모호함을 피하기 위해 평이한 영어를 사용할 수 있으며, 이는 기본적으로 꼭 필요한 경우가 아니라면 전문 용어와 기술적인 언어를 피하는 것을 의미합니다. 전문 용어를 사용해야 하는 경우에는 일반 독자를 위해 바로 뒤에 간단한 정의를 작성하세요.

"이 설명서의 정보를 이해하는 데 문제가 있는 경우 고객 지원 담당자에게 이러한 이해의 어려움을 극복하는 방법에 대한 추가 세부 정보를 요청하세요."

"표시된 내용을 이해하기 어려운 경우 고객 지원팀에 도움을 요청할 수 있습니다."

어느 쪽을 선호하시나요?

13번: 문서를 더 빠르게 만드는 템플릿 만들기

신제품을 출시할 때는 문서 작성 프로세스를 신속하게 진행하는 것이 최우선 과제입니다. 템플릿을 사용하면 이 작업을 수행할 수 있습니다.

템플릿은 페이지의 재사용 가능한 구조를 정의하여 작성자가 더 빠르고 일관성 있게 콘텐츠를 만들 수 있도록 도와줍니다. 다양한 콘텐츠 스타일에 맞게 여러 개의 템플릿을 만들 수도 있습니다. Docsie는 사용자 정의 템플릿 지원과 함께 사용할 수 있는 다양한 사전 구축 템플릿을 제공합니다.

14: 작가를 위한 목소리 톤 및 스타일 가이드 설정하기

작가에게 얼마나 많은 자유가 있나요?

제품 문서의 최종 초안에서 일관성이 떨어질 수 있으므로 작성자를 통제하는 것이 중요합니다. 목소리 톤(ToV) 가이드라인과 콘텐츠 작성 스타일 가이드를 통해 이를 수행할 수 있습니다.

• 목소리 톤** - 말하는 내용이 아니라 말하는 방식이 중요합니다. 작가가 격식을 차리고 격식을 차리길 원하시나요, 아니면 좀 더 캐주얼하게 작성하길 원하시나요? 유머가 허용되나요, 아니면 주제가 더 진지한가요? 대화적이고 열정적인 콘텐츠를 원하시나요, 아니면 냉철한 사실만을 원하시나요?

• 스타일 가이드라인** - 이 문서에서는 회사의 사명 선언문과 작성자가 페이지를 작성하고 서식을 지정할 때 정해진 스타일을 따르는 방법을 설명할 수 있습니다. 여기에는 타겟팅할 사용자 페르소나, 메타 설명과 같은 SEO 원칙, 인용 또는 참조 요건(시카고, AP 스타일 등)이 포함될 수 있습니다.

15: 강력한 지식창고 플랫폼을 사용하여 문서 게시하기

작성된 콘텐츠가 연료라면 메시지를 전달하기 위해 어떤 수단을 사용하고 있나요?

고품질의 제품 문서를 배포하려면 강력한 지식창고 플랫폼이 필수적입니다. 문서를 사용할 수 없거나 페이지 로딩 속도가 느리면 문서를 만드는 데 들인 모든 노력이 물거품이 됩니다.

기존 문서를 가져오기, 내부 팀과 콘텐츠 공동 작업, 새 문서 작성 및 편집, 동적 리치 콘텐츠 임베드, 지식창고에 게시할 수 있는 기능이 필요합니다. 버전 관리는 글로벌 콘텐츠 로컬라이제이션을 위한 언어 관리 및 자동 번역과 함께 장기적인 문서 업데이트에도 매우 중요합니다.

짐작하셨죠? 이 모든 기능은 Docsie에서 사용할 수 있습니다. 이러한 기능을 직접 사용해 보려면 Free Forever 요금제를 사용해 보세요!