이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 모틱
- 테크니컬 라이터:
- 스와티 탁커
- 프로젝트 이름:
- Mautic 최종 사용자 문서 검토 및 업데이트
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
기존 문서를 살펴본 첫 번째 느낌은 다음과 같습니다.
현재 설명서는 길고, 많은 곳에서 중복되고, 불완전하고, 무질서해서 사용자가 원하는 정보를 찾기가 어려울 수 있습니다.
처음 사용했을 때 캠페인, 애셋, 메시지, 카테고리 등 Mautic의 다양한 요소가 어떻게 조화를 이루어 비즈니스 요구사항을 해결하는지 이해할 수 없었습니다. 각 마우틱 요소를 2~3줄로 설명하는 대략적인 개념 주제를 제시해 보세요. 이 주제는 이러한 각 요소에 관한 다양한 세부 작업 주제로 연결될 수 있습니다.
참여 가이드는 포럼, 슬랙 채널, git 저장소 링크를 제공하여 문제 열기, 새 콘텐츠/아이디어 제안, 버그/문제/보안 취약점 신고 방법 등 더 많은 정보를 포함하도록 확장할 수 있습니다. 또한 스타일 가이드는 표준 활자 규칙, 이미지, 표 등에 대한 지침을 추가하도록 확장되어야 합니다.
또한 이메일, 캠페인, 업데이트가 필요한 오래된 정보 등 불완전한 정보도 많습니다.
기여하고 싶은 분야:
사용자가 Mautic 커뮤니티와 직접 상호작용하는 Slack 채널의 토론을 살펴보면서 캠페인과 이메일이 Mautic의 핵심 요소라는 것을 알게 되었습니다. 저는 버전 3에 Mautibox를 사용하여 캠페인에 대한 문서를 테스트한 결과 대대적인 개선이 필요하다는 사실을 알게 되었습니다. 다음은 발견한 몇 가지 문제와 각 문제에 대한 제안사항입니다.
- Mautic 사용자는 캠페인을 만들 때 다양한 작업, 결정, 조건 중에서 선택할 수 있습니다. 많은 작업 및 의사 결정에 대한 문서가 누락되어 있지만 캠페인 조건에 대한 문서는 거의 없습니다. 누락된 정보를 파악하여 최종 사용자 문서에 추가해야 합니다.
- 캠페인은 단순할 수도 있고 매우 복잡할 수도 있습니다. 현재 설명서는 처음으로 캠페인을 구축하는 사용자에게 그다지 도움이 되지 않습니다. 간단한 유스케이스와 복잡한 유스케이스를 파악하고, 캠페인 생성을 시작하기 전에 초보 사용자가 참고할 수 있는 샘플 워크플로(단계별 튜토리얼, 최종 사용자 가이드 내 주제 또는 둘러보기 동영상 형식)를 만드는 것이 좋습니다.
- 이 섹션의 정보는 더 체계적이고 질서 있게 제시되어야 합니다. 사용성을 높이려면 작업 및 개념 기반 접근 방식을 따라야 합니다. 주제에서는 표를 사용하여 작업, 결정, 조건에 관한 정보를 표시할 수 있습니다. '날짜 트리거 사용' 주제가 약간 어색합니다. 조건 아래에 중첩될 수 있습니다.
캠페인 외에도 UI에 대한 이메일 문서를 테스트했습니다. 제안하는 작업은 다음과 같습니다.
- 이메일용 동적 콘텐츠는 맞춤 코드 이메일 템플릿 (템플릿 이메일 및 세그먼트 이메일 모두에 해당)에 사용할 수 있지만 현재 문서가 없습니다. 동적 콘텐츠의 작동 방식과 설정 방법에 관한 세부정보와 몇 가지 예시를 추가합니다.
- 모니터링 이메일용으로 별도의 주제를 추가합니다. 여기에는 대시보드에서 사용할 수 있는 이메일 위젯을 사용하는 방법과 이메일 관련 측정항목 및 활동을 추적하는 데 이를 사용하는 방법에 관한 정보가 포함될 수 있습니다. 또한 추적 이메일에 관한 정보도 여기에 이동하세요.
- 이 문서에서는 연락처 답장, 반송 관리, 메일러 소유자 등이 이메일 설정에서 구성할 수 있는 전체 구성 설정임을 명확히 밝히지 않습니다. 모든 이메일 설정은 하나의 대주제 아래에 있어야 합니다. 또한 기본 발송 빈도 규칙, 수신 거부 설정 등 다른 많은 이메일 설정은 문서화되어 있지 않습니다. 필수 설정과 선택적 설정을 명시합니다.
- 이메일 수신 거부 관리 페이지에서 Webhooks에 관한 모든 정보를 삭제하고 Webhooks에 관한 별도의 주제에 배치합니다. 그러면 여기에서 해당 주제의 링크를 제공해 드릴 수 있습니다.
또한 다음과 같은 문제가 있습니다. - 대시보드 주제에 사용 가능한 위젯에 관한 정보가 불완전합니다. 이 정보는 사용자가 Mautic 리소스를 분석하고 모니터링하는 데 도움이 되므로 중요하며 추가되어야 합니다.
공백을 파악하려면 전체 문서를 스크랩해야 합니다. 사용자가 문서에 더 쉽게 접근할 수 있도록 문서를 개편해야 합니다.
내 지식/경험이 이 프로젝트에 어떤 도움이 될 수 있을까요?
지난 한 달 동안 최신 Mautic 3.0 출시 지원을 추가하는 등 Mautic 문서의 다양한 문제를 해결하면서 최종 사용자 문서의 구조를 숙지하고 문서의 공백을 파악할 수 있었습니다. 문서의 공백을 메우는 방법을 파악하기 위해 다른 마케팅 자동화 도구의 문서를 조사하고 이를 Mautic 최종 사용자 문서와 비교하는 데 시간을 보냈습니다. HTML 언어, 오픈소스 도구 및 프로세스에 익숙하다는 점도 도움이 됩니다. 현재 사용자 경험 연구 과정을 수강하고 있으며 원칙을 적용하여 보다 사용자 지향적인 문서를 만들 수 있습니다. 또한 정보 아키텍처에 대한 경험을 바탕으로 콘텐츠를 정리하고 사용자의 목표에 맞춰 문서를 구성할 아이디어를 제안할 수 있습니다. 또한 새로운 기술 영역에 대한 지식을 넓히는 데 능숙합니다. 10년간의 기술 문서 작성 경험과 이전에 완전히 새로운 기술 분야에서 조직의 프로젝트를 성공적으로 완료한 GSOD 경험을 바탕으로 Mautic 문서에 기여할 수 있을 것입니다.