Top 15 Best Practices for Product Release Documentation

이런 실수를 통해 고객의 관점에서 제품을 바라봐야 한다는 것을 깨달았습니다. 그때 마치 전구가 켜지듯 깨달음이 찾아왔습니다. 고객의 문제점을 해결하는 제품을 제공하고 전문적인 제품 문서로 지원한다면 성공적인 결과를 얻을 수 있을 것입니다.

또한 전문적이고 시각적으로 보기 좋으며 읽기 쉬운 제품 문서를 만드는 것이 쉽지 않다는 것도 알게 되었습니다. 하지만 올바르게 작성된 제품 문서는 만족한 고객을 열광적인 고객으로 만들고 궁극적으로 수익 증가로 이어집니다.

전문적인 제품 문서 작성을 위한 모범 사례는 무엇인가요?¶

이러한 모범 사례들은 시각적으로 매력적이고, 유익하며, 사용하기 쉬운 제품 문서를 만드는 데 도움이 됩니다. 이 가이드라인을 따르면 좋은 고객을 훌륭한 고객으로 만들 수 있는 제품 문서를 제공할 수 있습니다. 훌륭한 고객은 결국 회사의 수익 증가에 기여하며, 제품 문서는 고객 경험의 중요한 구성 요소입니다.

1. 대상 고객을 이해하고 그들이 원하는 것을 제공하기¶

고객의 기대치를 파악하는 것이 필수적입니다. 예를 들어, 제품 문서가 관리자용인지 일반 사용자용인지 고려해야 합니다. 대상 고객의 범위에 따라 관리자를 위한 기술적인 내용이나 일반 사용자를 위한 명확하게 정의된 용어와 지침을 작성해야 할 수 있습니다.

전문적인 제품 문서 작성의 모범 사례는 관리자 또는 일반 사용자 수준에서 고객 기대치를 이해하는 것입니다. 대상 고객 정보를 수집하는 방법에는 다음과 같은 것들이 있습니다:

• 설문지와 설문조사
• 고객 피드백 인식
• 회사 내 브레인스토밍
• 인기 있는 고객 의견에 대한 피드백
• 고객 원탁 토론

2. 문서화 계획 수립하기¶

문서화 계획을 작성하면 프로젝트 구현 중 발생할 수 있는 잠재적인 병목 현상을 예측하는 데 도움이 됩니다. 제품 문서 작성은 어려울 수 있으므로, 문서화 과정에서 발생할 수 있는 문제를 예상하기 위한 문서화 계획을 세우는 것이 좋습니다.

문서화 계획 수립의 이점은 다음과 같습니다:

• 실행 가능한 항목 - 새로운 제품 문서 계획에 재사용할 수 있는 적용 가능한 정보를 선별하기 위해 기존 문서를 감사합니다.

• 템플릿과 스타일 가이드 준수 - 제품 문서가 새로운 제품을 위한 것이라면 해당 산업의 어조와 스타일을 유지하고, 기존 제품에 관한 것이라면 브랜드의 연속성을 보장하기 위해 현재의 스타일 가이드와 템플릿을 유지합니다.

• 문서 작성 도구 기록 - 문서 작성 도구는 제품 문서화 프로세스를 정의하고 간소화하는 동시에 팀워크의 연속성과 문서 개발 프로세스에 대한 더 나은 이해를 보장합니다.

3. 제품 문서를 단순화하기¶

2016년에 실시된 한 연구에 따르면 제품 문서를 읽는 사용자가 얼마나 되는지 조사했습니다. 그 결과 사용자의 단 25%만이 제품 문서를 읽지 않는다는 놀라운 사실이 밝혀졌습니다. 조사 결과, 사용자가 제품 문서를 읽지 않는 이유는 다음과 같습니다:

• 사용자의 인내심 부족 - 웹을 통한 즉각적인 정보 시대에서 사용자들은 문제 해결책을 찾는 데 인내심이 부족합니다. 온라인이나 오프라인에서 제품 문서를 읽는 것은 특정 제품에 필요한 방대한 정보 때문에 노동 집약적일 수 있습니다.

• 건너뛰기 증후군 - 사용자들은 종종 필수 제품 문서를 건너뛰고 제품 사용법의 기본 사항으로 바로 넘어갑니다. 사용자들은 자세한 지침을 읽기보다 제품과의 상호작용을 통해 제품 작동 방식을 배우고 이해합니다. 지침은 가능한 한 명확하고 유익해야 합니다.

• 혼란스러운 레이아웃과 구조 - 매뉴얼은 종종 이해하고 따르기 어려운 형식으로 작성됩니다. 많은 사용자들이 제품 문서가 혼란스럽거나 질문과 관련이 없다고 생각하여 좌절하고 매뉴얼 읽기를 포기합니다. 회사가 상세한 대상 고객 조사를 실시하지 않아 사용자의 필요성을 제대로 이해하지 못하는 경우가 많습니다.

4. 스크린샷과 그래픽 정보 포함하기¶

제품 문서를 제품에 관한 이야기를 들려주는 로드맵으로 생각해보세요. 스크린샷이나 다른 그래픽으로 쉽게 식별할 수 있는 경로로 고객을 안내하고, 각 그래픽이 서로 어떻게 상호작용하는지 설명하세요. 사용자가 보고 있는 것이 무엇인지, 또는 기능이 활성화되었을 때 제품에 어떻게 반응하고 다음에 무엇을 기대해야 하는지 명확하게 설명하세요. 각 그래픽이 목적을 가지고 있고 제품의 워크플로우가 서로 잘 작동하는지 확인하세요.

5. 주제의 명확한 이해를 위한 상호 참조 링크 사용하기¶

제품 문서를 읽을 때 상호 참조 링크가 매우 유용하다는 것을 발견했습니다. 기능이나 함수 프로세스가 무엇을 하는지 이해하는 데 관련 주제로 상호 참조하는 것이 크게 도움이 됩니다. 관련 데이터 포인트를 상호 참조함으로써 시스템 상호작용과 워크플로우에 관한 전체 그림이 더 명확해집니다.

6. 제품 문서에 KISS 원칙 적용하기¶

문서 작성 시 KISS(Keep It Simple, Stupid) 원칙을 사용하는 것을 기억하세요. 과정을 철저히 문서화하는 것이 중요하지만 문서를 과도하게 작성하지는 마세요. 문서 사용자는 특정 항목에 대한 정보를 찾고 있을 수 있으므로, KISS 원칙을 준수하면 문서 탐색과 이해가 훨씬 쉬워집니다.

예를 들어, 기능을 설명하는 데는 주제에 대한 참조(상호 참조)와 함께 간단한 표기법으로 충분할 수 있습니다. 사용자가 자신의 필요에 관련된 정보를 쉽게 검색할 수 있도록 사실을 명확하게 유지하고 과장하지 마세요. 사용자들은 제품의 모든 측면을 읽는 데 관심이 없을 수 있습니다.

7. 다양한 학습 스타일 수용하기¶

각 사람은 다른 학습 스타일을 가지고 있습니다. 심층적인 설명을 선호하는 사람이 있는 반면, 그래픽과 시각적 표현을 선호하는 사람도 있습니다. 또한 집중적인 독서보다 직접적인 참여를 통해 더 많이 배우는 사용자도 있습니다.

효과적이고 유익한 제품 문서를 만들 때 모든 학습 스타일을 포함해야 합니다. 예를 들어, 스크린샷, 그래프, 구조화된 텍스트 또는 비디오 링크와 같은 그래픽을 삽입하면 모든 학습 스타일이 제품 문서를 이해할 수 있습니다.

8. 온보딩 콘텐츠 개인화 및 구조화하기¶

대상 고객의 역할에 따라 제품 문서를 개인화하세요. 콘텐츠를 온보딩할 때 대상 고객의 역할에 따라 문서의 다양한 버전을 만드세요. 예를 들어, 관리자의 질문은 파워 유저의 문서 관련 질문과 관련이 없을 수 있습니다.

대상 고객의 역할에 맞게 약간 다른 버전의 문서를 만들어 개인화 레이어를 추가할 수 있습니다. 대상 고객의 역할에 따라 온보딩 콘텐츠를 수정하면 문서에 개인화 요소가 부여됩니다.

9. 특정 대상을 위한 용어 명확하게 정의하기¶

대상 고객에 따라 문서 전체에서 사용되는 각 용어의 의미를 설명하는 것이 좋습니다. 내부 사용자가 대상인 경우 약간의 설명과 함께 더 복잡한 용어를 사용할 수 있습니다. 그러나 외부 사용자가 문서에 접근할 때는 사용자의 전문성을 알 수 없습니다.

독특하거나 복잡한 용어를 명확하게 정의하면 모든 내부 이해관계자와 외부 사용자 간의 더 나은 효율적인 의사소통이 가능합니다.

10. 사용자 피드백 수집 방법 제공하기¶

문서 피드백은 문서의 효과에 대한 강력한 정보를 제공합니다. 문서 품질에 대한 귀중한 정보를 수집하기 위해 "좋아요/싫어요"가 있는 링크나 버튼을 제공하세요. 사용자 피드백을 수집함으로써 문서를 개선하고 향상시킬 수 있습니다.

11. 평면 구조의 문서 피하기¶

제품 문서를 작성할 때 "평면 구조"로 작성되지 않도록 하세요. 평면 텍스트로 가득 찬 문서를 읽는 것은 힘들고 지루할 수 있습니다. 또한 정보가 논의 중인 주제와 관련이 있고 사용자가 빠르게 소비할 수 있다면 독자의 문서에 대한 관심이 높아질 것입니다.

선택된 정보를 강조하거나 비디오, 이미지, 링크 및 기타 방법을 통합하여 연속적인 평면 텍스트를 분할하여 더 나은 사용자 경험을 제공하세요. 또한 문서 내용을 "간결한 단위"로 전달함으로써 독자는 더 즐거운 경험을 할 수 있으며 문서 읽기를 꺼리지 않을 것입니다.

12. SEO 친화적인 문서 만들기¶

온라인 제품 문서의 모범 사례는 문서 SEO 친화적인 스타일로 작성하는 것입니다. 인터넷 전반에서 문서에 대한 검색 결과를 최대화하는 방식으로 문서를 작성해야 합니다. 고객이 문서를 검색해야 할 수 있으며, 호스팅 사이트의 명시적 링크가 없을 때 검색어를 입력하면 SEO 친화적일 때 응답이 더 빠르고 간결합니다.

13. 제품 문서 최신 상태 유지하기¶

특히 온라인으로 액세스하는 경우 제품 문서 유지 관리는 매우 중요합니다. 제품 요구사항이 변경되는 경우가 많으며 온라인 문서는 새로운 변경 사항이나 업데이트를 반영해야 합니다. 따라서 사용자 문서는 최신 상태여야 하며 최근 업데이트를 반영하고 고객에게 제품 문서의 변경 사항을 알리고 인식시켜야 합니다.

14. 사용자가 제품 문서를 읽지 않을 수 있다는 점 이해하기¶

2014년 연구에 따르면 사용자들이 제품 문서를 완전히 읽지 않는다는 사실이 밝혀졌습니다. 문서를 읽지 않는 주요 이유는 다음과 같습니다:

• 제품 문서가 지나치게 복잡함
• 문서가 질문에 직접적으로 답하지 않음
• 문서를 읽지 않아 제품의 많은 기능을 사용하지 않음
• 문서를 읽는 것보다 "직접 해보는" 학습을 선호함

15. 동적 및 정적 콘텐츠 모두 관리하기¶

제품 문서는 업데이트, 새로운 기능, 수정된 콘텐츠, 업데이트된 유지 보수 알림 등으로 지속적으로 발전합니다. 이러한 업데이트는 제품 요구사항에 따라 지속적으로 발전하는 살아있는 문서로 간주됩니다.

정적 콘텐츠는 제품 수명 주기 동안 변경되지 않는 데이터를 사용자에게 제공합니다. 정적 콘텐츠의 목적은 특히 신규 사용자에게 제품 수명 주기 동안 변경되지 않는 정보를 제공하는 것입니다. 정적 콘텐츠는 풍부한 문서에 필수적이지만 일반적으로 동적 문서보다 뒤로 밀립니다.

콘텐츠를 동적 또는 정적으로 분류하면 문서 세트를 유지 관리하기가 더 쉽습니다. 문서가 동적 또는 정적으로 분류되면 제품 수명 주기 문서를 더 쉽게 구현하고 검증할 수 있습니다. 새 기능 업데이트(정적) 또는 상세한 제품 업데이트(동적)에 대한 문서에 약간의 변경 사항이 있을 수 있습니다.

16. 제품 문서 가용성에 대한 모범 사례¶

사용자가 반드시 많은 제품 문서를 읽지는 않더라도, 필요할 때는 즉시 제공받기를 원합니다. 문서의 전통적인 전달 방식은 제품과 함께 인쇄된 매뉴얼을 제공하는 것이었습니다. 그러나 오늘날의 디지털 온라인 세계에서는 문서가 종종 웹을 통해 제공됩니다.

제품 문서가 어떻게 제공되든 쉽게 접근할 수 있는 액세스 포인트를 갖추는 것이 중요합니다. 오늘날 문서를 제공하는 주요 방법은 다음과 같습니다:

• 오프라인 문서 - 많은 제품은 인쇄된 매뉴얼이나 "빠른 시작" 단축키 시트와 함께 제공됩니다. 이러한 문서는 일반적으로 "일회성"이며 쉽게 배포되지 않습니다. 그러나 많은 매뉴얼은 이동성을 높이거나 필요에 따라 인쇄할 수 있는 옵션을 제공하는 PDF 형식으로 선택적으로 제공됩니다.

• 온라인 문서 - Google에서 문제에 대한 답을 검색할 때마다 온라인 문서의 일부를 가져오고 있을 가능성이 높습니다. 웹의 등장으로 최종 사용자를 위한 매뉴얼이나 제품 문서 자료 인쇄가 대체되었습니다. 온라인 문서의 일부 이점은 다음과 같습니다:

• 원격 근무 - 팬데믹이 우리에게 가르쳐준 한 가지는 재택근무가 특히 온라인 문서로 질문에 답할 수 있을 때 사무실만큼 생산적일 수 있다는 것입니다.

• 협업 - 쉽게 접근할 수 있는 온라인 문서 포털을 통해 팀원들은 즉시 정보를 공유하고 사무실에서는 종종 불가능한 팀워크를 생성할 수 있습니다.

• 모바일 친화적 - iPad와 스마트폰과 같은 모바일 기기의 등장으로 일상적인 상호작용에서 PC가 서서히 대체되고 있습니다. 스마트폰으로 온라인 문서에 쉽게 액세스할 수 있으며, 점심 시간에 좋아하는 카페에서도 제품 문제를 쉽게 조사할 수 있습니다.