제품 문서 작성 및 관리 방법에 대한 단계별 가이드 | 상품관리 #31

게시 됨: 2023-10-02
제품 관리는 새로운 기능을 찾아내거나 기존 기능을 최적화하는 것만이 아닙니다. 이는 또한 사용자가 제품을 효과적으로 사용하고 발생할 수 있는 문제를 해결하는 데 필수적인 제품 문서를 만드는 것이기도 합니다. 그렇다면 그러한 문서에는 무엇이 포함되어야 할까요? 우리 기사를 읽고 알아보세요.

제품 설명서 – 목차:

  1. 제품 설명서란 무엇입니까?
  2. 제품 문서를 작성하는 방법은 무엇입니까?
  3. 제품 문서 게시 및 배포
  4. 요약

제품 설명서란 무엇입니까?

제품 문서는 제품, 기능, 사용 방법 및 기타 관련 세부 사항을 설명하는 텍스트, 시각적 자료, 비디오의 모음입니다. 문서를 작성하는 주요 목적은 사용자가 제품 사용 방법, 특히 고급 기능을 이해하도록 돕는 것입니다.

문서화는 특히 최종 사용자에게 서비스를 제공할 뿐만 아니라 다른 제품과 통합되는 디지털 제품을 만드는 경우 중요합니다. 예를 들어 데이터를 다른 애플리케이션으로 내보내거나 현지화 또는 연락처 데이터베이스를 사용할 수 있습니다.

예를 들어, 프로젝트 관리 도구에 대한 문서에는 새 프로젝트를 만드는 방법, 프로젝트에 팀 구성원을 추가하고 특정 작업만 변경할 수 있는 권한을 부여하는 방법, 동시에 여러 사람에게 작업을 할당하는 방법 및 작업을 할당하는 방법에 대한 정보가 포함될 수 있습니다. 진행 상황을 추적하세요.

제품 문서의 요소

제품 문서에는 다음이 포함될 수 있습니다.

  • 사용 설명서 – 제품 기능, 설치, 설정 및 문제 해결에 대한 정보를 제공하는 문서입니다.
  • 사용 설명서 – 사진 편집 프로그램 사용 방법, 컴퓨터 게임 방법 등 제품을 사용하여 다양한 작업을 수행하는 방법을 설명하는 문서입니다.
  • 기술 자료 – 자주 묻는 질문에 답변하거나 제품에 대한 추가 정보를 제공하는 기사 또는 웹 페이지 모음입니다. 웹사이트의 "도움말 센터" 또는 "지원" 섹션을 예로 들 수 있습니다. 고객을 지원하는 챗봇의 정보 소스로도 활용되는 경우가 많습니다.
  • FAQ - 제품에 대해 자주 묻는 질문과 답변 목록입니다. 예를 들어 "비밀번호를 어떻게 재설정하나요?", "고객지원팀에 어떻게 문의하나요?"와 같은 질문에 대한 답변이 포함된 웹사이트나 PDF 파일이 있습니다. 또는 "제품의 시스템 요구 사항은 무엇입니까?"
  • 튜토리얼 – 일반적으로 회사 웹사이트나 YouTube에 게시되는 비디오로, 제품 사용 방법이나 특정 작업 수행 방법을 보여줍니다.
  • 다이어그램 및 인포그래픽 – 제품의 구조, 기능 또는 프로세스를 그래픽으로 표현한 것입니다. 예를 들어 API를 구성할 때 선택할 옵션을 보여주는 다이어그램입니다.

제품 문서를 작성하는 방법은 무엇입니까?

타겟 고객 이해

제품 문서 작성의 첫 번째 단계는 이 특정 문서가 전달될 대상을 이해하는 것입니다. 다음 질문에 답하세요.

  • 이 문서를 누가 사용할 것인가? – 처음 사용하는 사용자인가요, 아니면 고급 사용자인가요?
  • 사용자는 어느 시점에 이 문서에 접근하게 될까요? 도구의 기능에 대한 일반 정보나 추가 정보를 찾고 있습니까, 아니면 특정 문제에 대한 해결책을 찾고 있습니까?
  • 어떤 기기에서 사용할 예정인가요? 모바일 기기라면 영상이 충분히 선명한가요?
  • 그들의 필요와 기대는 무엇입니까? 사용자는 동적 비디오를 보거나 다이어그램을 보는 것을 선호합니까?

청중과 그들의 요구 사항을 이해하고 나면 문서 작성을 시작할 수 있습니다. 예를 들어 대상 그룹이 초보 사용자인 경우 설명서는 모든 단계에서 액세스할 수 있어야 하며 간단하고 이해하기 쉬운 언어로 작성되고 자세한 지침이 포함되어야 합니다.

잘 구성된 문서는 사용자가 제품을 이해하는 데 도움이 될 뿐만 아니라 질문에 대한 답변을 검색하는 데 소요되는 시간을 절약해 줍니다. 이렇게 하면 이탈률, 즉 고객이 서비스 구독을 중단하는 비율이 줄어듭니다.

명확한 의사소통

효과적인 제품 문서를 작성하려면 올바른 커뮤니케이션 형식(예: 비디오, 시각적 자료, 지식 기반)을 선택하는 것뿐만 아니라 명확하고 간결하게 작성하고 커뮤니케이션하는 것도 중요합니다. 제품 문서에서 효과적인 의사소통의 기본 원칙은 다음과 같습니다.

  • 쉬운 언어를 사용하십시오 . 기술적인 언어나 복잡한 용어는 피하십시오. 예를 들어, "프로젝트 시작"이라고 말하는 대신 "프로젝트 시작"이라고 말할 수 있습니다.
  • 구체적으로 설명하세요 . 사용자가 제품 사용 방법을 이해하는 데 도움이 되는 예를 제공하세요. 예를 들어, "프로젝트에 팀 구성원을 추가할 수 있습니다"라고 말하는 대신 "프로젝트 관리 페이지 하단에 있는 녹색 버튼을 클릭하여 프로젝트에 팀 구성원을 추가하세요"라고 말하고 시각적 단서가 있는 스크린샷을 추가하세요. .
  • 수동태를 피하세요 – 능동태가 이해하고 읽기 쉽습니다. 예를 들어, “이 프로젝트는 관리자가 시작할 수 있습니다.”라고 말하는 대신 “관리자는 프로젝트를 시작할 수 있습니다.”라고 말합니다.

따라야 할 다른 원칙도 많이 있지만 가장 중요한 것은 효과적인 제품 문서는 사용자가 이해할 수 있어야 하고 제품을 효과적으로 사용하는 데 도움이 되어야 한다는 점을 기억하는 것입니다.

제품 문서에 시각적 자료 사용

이미지, GIF, 짧은 비디오, 다이어그램, 인포그래픽과 같은 시각적 자료는 제품 문서에 대한 이해를 크게 향상시킬 수 있습니다. 예를 들어, 페이지에서 "팀 구성원 추가" 버튼이 있는 위치를 보여주는 스크린샷은 처음 사용자에게 매우 유용할 수 있습니다. 문서를 작성할 때 명확한 제목과 간단한 글꼴을 사용하여 텍스트를 구성하세요.

제품 문서 업데이트 및 유지 관리

제품 설명서는 정적 문서가 아닙니다. 제품의 변경 사항을 반영하려면 정기적으로 업데이트해야 합니다. 정기적인 업데이트는 문서가 목적을 달성하는 데 매우 중요합니다. 예를 들어, 제품 관리 소프트웨어에 새로운 기능을 도입하는 경우 이를 해결하기 위해 제품 설명서를 업데이트해야 합니다.

제품 문서 게시 및 배포

제품 문서를 게시하고 배포하는 것은 문서를 만드는 것만큼 중요합니다. 사용자가 어디에 있든, 어떤 장치를 사용하든 상관없이 문서에 쉽게 액세스할 수 있어야 합니다. 예를 들어 제품 설명서를 웹사이트에 업로드하거나 이메일을 통해 사용자에게 직접 보낼 수 있습니다.

제품 관리자를 위한 최고의 문서 관리 시스템

제품 관리자는 제품 문서를 작성하고 관리하는 데 도움이 되는 다양한 도구를 사용할 수 있습니다. 널리 사용되는 솔루션은 다음과 같습니다.

  • Google Docs 는 문서 작성 및 편집을 위한 클라우드 기반 서비스입니다. 모든 기기에서 액세스할 수 있고 여러 팀 구성원이 사용할 수 있기 때문에 제품 관리자에게 인기 있는 도구입니다.
  • product documentation
  • Firmbee 는 사용자가 전 세계 어디에서나 실시간으로 작업을 완료할 수 있는 포괄적인 프로젝트 및 팀 관리 도구입니다. 제품 관리자는 자신과 동료의 작업을 쉽게 구성하고, 진행 상황을 추적하고, 예산을 관리하고, 채용 프로세스를 수행할 수 있습니다.
  • product documentation
  • Notion은 작업, 메모 및 파일을 추적하는 데 사용할 수 있는 작업 및 프로젝트 관리 애플리케이션입니다. Notion은 유연하고 사용자 정의가 가능하기 때문에 제품 관리자에게 인기 있는 옵션입니다.
  • product documentation
  • Zendesk Guide 는 지식창고 문서를 만들고 공유하는 데 사용할 수 있는 고객 서비스 솔루션입니다. Zendesk Guide는 지원을 제공하고 고객이 문제를 해결하도록 도울 수 있기 때문에 제품 관리자에게 인기 있는 선택입니다.
  • product documentation
요약

제품 문서를 작성하고 관리하는 것은 종종 과소평가되는 작업입니다. 많은 디지털 제품 개발자는 잘 디자인된 제품은 설명이 필요하다고 믿습니다. 그러나 제품 문서는 단순한 사용자 가이드 그 이상이어야 합니다.

또한 제품에 대한 고객의 인지도를 높이고, 새로운 기능에 대한 관심도를 분석하고, 특정 기사나 설명에 대한 조회수를 분석하는 데 도움을 줄 수 있는 도구여야 합니다. 이러한 분석은 기업이 제품을 더 잘 관리하고 사용자 경험을 개선하는 데 도움이 됩니다. 따라서 귀하와 귀하의 사용자 모두에게 도움이 될 수 있는 효과적인 제품 문서를 작성하는 데는 시간과 노력을 들일 가치가 있습니다.

저희 콘텐츠가 마음에 드신다면 Facebook, Twitter, LinkedIn, Instagram, YouTube, Pinterest, TikTok의 바쁜 꿀벌 커뮤니티에 가입하세요.

A step-by-step guide on how to create and manage product documentation | Product management #31 andy nichols avatar 1background

저자: 앤디 니콜스

5가지 등급과 끝없는 동기 부여를 갖춘 문제 해결사입니다. 이것이 그를 완벽한 사업주이자 관리자로 만듭니다. 직원과 파트너를 찾을 때 세상에 대한 개방성과 호기심은 그가 가장 중요하게 생각하는 자질입니다.

제품 관리:

  1. 제품 관리 소개
  2. 제품 관리자의 역할은 무엇입니까?
  3. 제품 수명주기 관리가 왜 중요한가요?
  4. 효율적인 제품 전략을 구축하는 방법은 무엇입니까?
  5. OKR과 SMART 목표. 어떤 프레임워크가 더 나은 결과를 가져오나요?
  6. 가치 제안을 정의하는 방법은 무엇입니까?
  7. 고객의 요구사항 파악 및 시장 세분화
  8. 성공적인 제품 컨셉을 만들어 보세요. 기술 및 단계
  9. 효과적인 제품 로드맵으로 우위 확보
  10. 디지털 제품 프로토타입 제작
  11. MVP를 구축하는 방법은 무엇입니까?
  12. MVP 대 MMP 대 MMF. 제품 개발의 주요 이정표
  13. 마스터링 가설 테스트
  14. 제품 품질 관리 개선을 위한 입증된 방법
  15. 성공적인 제품 출시를 위한 전략과 전술
  16. 제품 최적화를 통한 수익성 향상
  17. 제품 성공 측정
  18. 제품 가격을 책정하는 방법은 무엇입니까? 가장 인기 있는 가격 책정 전략
  19. 제품 디자인의 미래. 주요 동향 및 예측
  20. 제품을 언제 폐기해야 합니까? EOL 결정에 영향을 미치는 주요 요소
  21. 제품 관리의 민첩성
  22. 제품 관리의 스크럼 및 칸반.
  23. 린 제품 관리란 무엇입니까?
  24. 완료해야 할 작업. 고객이 진정으로 필요로 하는 제품 만들기
  25. 그로스 해킹이란 무엇입니까?
  26. 데이터 기반 제품 관리란 무엇입니까?
  27. 제품 관리의 A/B 테스트
  28. 유용한 제품 관리 템플릿. 어디서 찾을 수 있나요?
  29. 제품 관리의 전략 수립 도구
  30. 5가지 유용한 제품 관리 도구
  31. 제품 문서를 어떻게 작성하고 관리합니까?