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