제품 관리자가 적절한 메시지를 전달하기 위해 어떤 스타일의 문서를 사용해야 할까요?

*문서화는 오픈소스 프로젝트에서 가장 중요하지만 과소평가되는 요소 중 하나이므로 가볍게 여겨서는 안 됩니다.

일반적으로 대부분의 오픈소스 프로젝트는 작성자가 API 및 제품 문서에 대한 효과적인 문서화 환경을 만드는 데 관심이 없거나, 그럴 능력이 없거나, 시간이 없기 때문에 충분한 관심을 받지 못합니다.

애플리케이션이 아무리 훌륭하더라도 문서가 부적절하다면 소비자는 애플리케이션 사용의 이점을 누릴 수 없습니다.

또한, 어떤 이유로든 소비자가 사용할 수밖에 없는 경우에도 원하는 방식으로 성공적으로 사용할 수 없을 것입니다.

우수한 문서를 작성하는 방법을 이해하려면 다른 문서 프로젝트를 주기적으로 검토하는 것과 마찬가지로 상당한 노력이 필요합니다. 하지만 Docsie를 위해 수많은 문서를 작성한 사람으로서 제 말을 믿으세요. 자신이 아닌 다른 사람이 사용할 코드를 작성하는 경우, 특히 그 사람이 고객인 경우, 제품은 잘 문서화되고 형식이 지정되어 있으며 동적으로 표시되어야 합니다.

튜토리얼, 방법, 설명, 참조의 경우 어떤 차이가 있나요?

많은 사람들이 이 네 가지 문구가 같은 항목을 가리킨다고 잘못 알고 있습니다. 그러나 이 네 가지 문구는 매우 다양한 의미를 담고 있습니다. 이러한 다양한 유형의 문서는 매우 필수적이며 몇 가지 주요 차이점이 있습니다:

튜토리얼 문서: 이러한 유형의 문서는 교육을 위한 정보 기반 문서입니다.

하우투 가이드/사용자 가이드 문서: 사용자 가이드 문서는 특정 목표를 달성하기 위해 일련의 단계를 통해 특정 문제를 해결하는 방법을 설명합니다.

설명 문서: 다양한 설명과 배경 지식을 통해 사용자/독자가 제품에 대해 더 깊이 이해할 수 있도록 돕는 문서 형식의 설명 문서입니다.

참조 노트 문서: 이 문서는 사용자에게 다양한 새 기능 업데이트 및 사용법에 대한 설명을 제공하기 위해 작성되었습니다. 이러한 유형의 문서는 개발자 문서의 형태로 매우 '원시적'일 수 있지만, 최종 사용자가 쉽게 이해할 수 있는 사용자 친화적인 릴리스 노트로 번역할 수도 있습니다.

고품질 문서를 제작하는 이유 ## 고품질 문서를 제작하는 이유

계속 진행하기 전에 유능한 문서 작성이 오늘날 사회에서 매우 중요하지만 과소평가되는 이유를 이해하는 것이 중요합니다. 광범위하고 잘 작성된 문서의 가용성은 광범위한 채택을 달성하는 데 있어 가장 중요한 기준 중 하나이며, 특히 거의 모든 작업이 대중에게 공개되고 이러한 활동이 프로젝트의 성공에 중요한 역할을 하는 오픈 소스 프로젝트에서는 더욱 그렇습니다.

효과적인 문서를 작성해야 하는 가장 중요한 이유를 살펴보겠습니다.

고객에게 더 나은 온보딩 경험을 제공할 수 있습니다.

고객에게 제품에 대한 적절한 문서를 제공하면 고객이 제품에 대해 더 편안하게 느끼고 특정 지침에 따라 보호받을 수 있도록 지원할 수 있습니다. 이를 위해서는 다음을 수행해야 합니다:

1. 인앱 링크 또는 검색 가능한 문서 플랫폼에서 제품 설명서를 쉽게 볼 수 있고 쉽게 액세스할 수 있도록 하세요.

2. 문서가 잘 작성되어 있는지 확인하고 고객이 빠르고 쉽게 답을 찾을 수 있도록 지원하세요.

한 가지 조언을 드리자면, 문서를 한 번만 작성하면 새로운 고객이 회사에 합류할 때 계속해서 반복해서 작성할 수 있습니다.

결과적으로 지원 문의가 줄어듭니다.

문서를 읽고 이해하는 고객은 상품을 구매할 가능성이 더 높습니다. 고객이 아무것도 알아낼 수 없는 경우, 상당히 화가 날 수 있으며 대신 제품을 비난하기 시작할 수 있습니다.

일부 고객은 문제가 발생하면 즉시 지원팀에 연락하거나 이메일을 보내지만, 문서가 매력적이고 접근하기 쉬우며 이해하기 쉽다면 지원팀과 상담할 필요 없이 스스로 문제를 해결할 수 있어 고객 만족도가 높아질 것입니다.

자신의 팀을 지원하는 데 도움이 됩니다.

탄탄한 지식창고는 팀원들을 돕는 데에도 사용될 수 있습니다. 따라서 내부 팀에게 새로운 기능, 계획된 로드맵, API 문서 등 모든 사람이 같은 정보를 공유할 수 있도록 필요한 모든 정보를 제공해야 합니다.

효과적인 문서 작성 방법에 대한 단계별 지침 ###

문서의 내용을 작성하는 것과 이 활동을 정리하는 것은 어떤 어조를 사용할지, 어떻게 문서를 이해하기 쉽게 만들지 결정하는 것과는 완전히 다른 작업입니다. 오라일리](https://www.oreilly.com/content/the-eight-rules-of-good-documentation/)에 따르면 훌륭한 문서를 위한 8가지 규칙이 있습니다:

1. 독자를 끌어당기는 문서를 작성합니다.

2. 프로젝트의 모든 영역을 포괄하는 철저한 문서를 작성합니다. 2.

3. 이해하기 쉬운 요약 자료를 작성합니다. 3.

4. 사례 연구를 통해 제품 활용 방법을 설명하는 문서를 작성합니다. 4.

5. 필요한 경우 반복이 포함된 문서를 작성합니다. 5.

6. 최신 상태로 문서를 작성합니다 6.

7. 기여하기 쉬운 문서 작성 7.

8. 발견하고 이해하기 쉬운 문서 작성 8.

이러한 요소는 대부분 콘텐츠와 관련이 있습니다. 그 다음에는 이러한 정보를 구조화하는 '방법'에 대해 6단계로 살펴보겠습니다:

무엇을 기록할지 결정하세요.

시작하기 전에 튜토리얼, 참고 문서, 사용 설명서 또는 설명 등 어떤 종류의 문서를 만들 것인지 생각해 보세요.

제품의 특성이 작성해야 할 문서의 종류에 직접적인 영향을 미친다는 점에 유의하세요.

프레임워크를 만듭니다.

먼저 문서의 토대를 구축하세요. 처음에는 아주 작은 것일 수도 있고 몇 개의 그룹으로만 구성될 수도 있지만 시간이 지남에 따라 구축 중인 전체 플랫폼의 규모와 복잡성이 커지기 시작할 것입니다. 정기적으로 조직 구조를 검토해야 합니다.

여러분은 교수자이며, 궁극적으로 수업에서 학생들이 학습하는 방식에 대한 책임이 있다는 점을 명심하세요. 학생들은 교수자의 지시에 따라 학습을 진행하게 되므로 조직에 더 많은 시간을 할애할수록 학생들은 더 성공적으로 학습에 임할 수 있습니다.

항상 건전한 멀티미디어 기술을 활용하세요.

동영상, 그림, 다양한 스타일을 활용하고 문서에 직접 연결하세요. Docsie 를 사용하면 이러한 모든 것을 플랫폼에 삽입할 수 있으므로 이 과정이 더 쉬워집니다.

이러한 요소는 소비자들이 여러분이 표현하는 정보를 더 잘 이해하는 데 도움이 될 뿐만 아니라 검색 엔진 최적화에도 효과적이어서 역동적인 문서를 통해 더 많은 양질의 리드를 확보할 수 있습니다.

검색 가능한지 확인하세요.

지식창고 플랫폼마다 검색 기능에 차이가 있는데, 어떤 플랫폼은 세그먼트로 드릴다운할 수 있는 기능이 없는 기본 검색만 제공하는 반면(수천 개의 파일이 없는 경우에는 기술적으로 괜찮습니다), 어떤 플랫폼은 문서뿐만 아니라 사용자 이름으로도 검색할 수 있는 쿼리 옵션을 제공하는 경우도 있습니다.

하지만 한 가지 중요한 점은 빠르게 검색할 수 있는 도구를 사용해야 한다는 것입니다. 앱에 포함된 검색 기능을 사용하면 앱을 종료하지 않고도 간편하게 파일을 검색하고 미리 볼 수 있습니다.

Docsie를 사용하면 동적으로 검색 가능한 탐색 기능을 통해 쉽게 액세스할 수 있는 정보를 찾을 수 있습니다.

지속적인 개선 및 업데이트 노력

문서를 생성하고 사용하는 것은 문서를 생성한 사람이나 문서를 통해 이익을 얻은 사람이 금방 잊어버리기 때문에 어렵습니다. 문서도 그 여정에서 여러 가지 도전에 직면합니다.

시간이 지날수록 오래된 문서는 모니터 화면의 낮은 위치에 남는 경향이 있기 때문에 폴더 구조가 공동묘지처럼 보이게 됩니다.

따라서 오래된 문서를 다시 살펴보고 개선하는 것은 물론, 동료들에게도 수시로 같은 작업을 하도록 독려하세요. Docsie에서는 간단하고 쉬운 고급 버전 관리 시스템을 통해 업데이트를 생성할 수 있습니다.

마지막 생각:

효과적인 문서 작성 방법에 대해 더 자세히 알고 싶으신가요? 소프트웨어 문서 전문가를 위한 수많은 블로그와 정보를 여기에서 찾아볼 수 있습니다.