Mautic 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:
Mautic
테크니컬 라이터:
Favour Kelvin
프로젝트 이름:
Knowledgebase
프로젝트 길이:
표준 기간 (3개월)

Project description

개요

지식 베이스는 정보가 저장, 정리, 공유되는 중앙 집중식 저장소입니다. 외부에서 사용되는 기술 자료는 사용자가 회사의 제품 또는 서비스, 조직, 업계에 관해 알아야 하는 모든 것을 알아볼 수 있는 곳입니다. 반면 내부 지식 기반은 일반적으로 커뮤니티/사용자가 공동작업하고 회사의 모든 지식과 정보를 내부적으로 배포할 수 있는 방법으로 활용됩니다. 특정 기술 자료의 콘텐츠는 여러 요인에 따라 다르지만 일반적으로 특정 제품을 시작하는 방법, 고급 기능을 더 많이 사용하는 방법, 일반적인 문제 해결 방법에 관한 정보가 포함됩니다. 지식 베이스를 만들어 시청자에게 제공하면 개별적으로 하지 않아도 시청자/사용자/커뮤니티에 심층적이고 즉각적인 주문형 정보와 답변을 제공할 수 있다는 것이 가장 큰 이점입니다.

Mautic Knowledgebase는 Mautic과 직접 (예: Mautic에서 작업하는 방법) 또는 간접적으로 (예: 보다 일반적인 마케팅 전략) 관련된 주제에 관한 튜토리얼, 방법 가이드, 권장사항을 제공하는 중앙 저장소입니다.

이 글을 작성하는 시점에서 Mautic 지식 베이스는 매우 새롭고 불완전합니다. Mautic 커뮤니티는 이 프로젝트를 사용하여 사용자 문서에 심층적이고 주문형 정보를 제공하는 방식을 개선하여 최종 사용자가 Mautic을 사용할 때 원활한 환경을 제공하고자 합니다. Mautic 지식 베이스를 살펴보면 유용한 정보가 많지만, Mautic 3x 버전에 맞게 업데이트된 튜토리얼과 방법 가이드가 필요하고 새 튜토리얼과 방법 가이드를 만들어야 합니다.

기존 문서를 검토한 첫 번째 느낌은 현재 Mautic 기술 자료(https://kb.mautic.org/)를 사용할 수 있다는 것입니다. 문서의 일부 튜토리얼, 방법 가이드, 권장사항 주제가 최신 상태가 아니며 정보가 부족하거나 불완전하며 현재 버전의 Mautic에 관한 정보도 다루지 않습니다.

제안된 개선사항이 현재의 개선사항보다 나은 점은 무엇인가요? 또는 내가 기여하고 싶은 영역은 무엇인가요? 이번 개선사항은 모든 최종 사용자의 효율성, 일관성, 안심할 수 있는 환경을 개선하고 보장하기 위한 것입니다. 텍스트로 된 튜토리얼, 방법 가이드, 권장사항, 관련 이미지가 포함되며, Mautic의 각 기능을 사용하는 방법에 관한 안내와 설명이 최신 상태로 제공되며 탐색하기 쉽고 이해하기 쉬워야 합니다.

분석

Mautic 지식 베이스는 Grav 플랫 파일 CMS 및 KLB4 테마로 작성되었습니다. 기술 자료 문서를 개선하는 방법을 많이 조사했습니다.

프로젝트 목표

  • 기술 자료를 검토합니다.
  • 튜토리얼과 안내 가이드를 Mautic 3x 버전에 맞게 업데이트합니다.
  • 새로 생성된 Mautic 커뮤니티 기술 자료의 리소스 만들기
  • Mautic 사용자가 보다 효과적으로 애플리케이션을 설정, 구성, 사용하는 데 도움이 되는 일련의 안내 튜토리얼과 가이드를 작성합니다.
  • Mautic 3x 버전에 맞게 동영상 튜토리얼을 업데이트합니다.
  • 사용하지 않는 이미지와 정보를 삭제합니다.
  • 기술 자료를 더 쉽게 이해할 수 있도록 다시 작성합니다.
  • 기술 자료 문서의 스타일 가이드/패턴이 적절하게 구현되었는지 확인합니다.

타임라인

8월 1일 이전

  • 조직에 계속 기여합니다.
  • 기술 자료 문서 및 Mautic의 현재 버전에 대해 자세히 알아봅니다.
  • 프로젝트를 구현하는 데 도움이 되는 새로운 기법과 기술 문서 작성 기술을 학습합니다.

커뮤니티 유대감 (8월 1일~9월 1일)

  • 커뮤니케이션 채널 및 시간 설정 (시차로 인한)
  • 내 목표를 미세 조정하고 양측의 기대치를 설정합니다.
  • 커뮤니티 및 제품에 대해 자세히 알아보기
  • 제안된 문서 구조를 멘토 및 조직의 다른 구성원과 논의합니다.
  • 제안된 기능 및 기존 문서에 필요한 기타 수정사항을 마무리합니다.

문서화 기간

  • 1주 차 (9월 2일~11월 22일)
  • 이 기간 동안 저는 다음과 같은 목적으로 멘토와 직접 협력합니다.
  • KB를 검토합니다.
  • 튜토리얼과 안내 가이드를 Mautic 3x 버전에 맞게 업데이트합니다.
  • 새로 생성된 Mautic 커뮤니티 기술 자료의 리소스 만들기
  • Mautic 사용자가 보다 효과적으로 애플리케이션을 설정, 구성, 사용하는 데 도움이 되는 일련의 안내 튜토리얼과 가이드를 작성합니다.
  • Mautic 3x 버전에 맞게 동영상 튜토리얼을 업데이트합니다.
  • 사용하지 않는 이미지와 정보를 삭제합니다.
  • 이해하기 쉽게 KB를 다시 작성합니다.
  • 기술 자료 문서의 스타일 가이드/패턴이 올바르게 구현되었는지 확인합니다.
  • 개발팀이 마이너 기능 출시로 바쁠 수 있으므로 출시 주기를 고려합니다.

프로젝트 평가 (2019년 11월 25일~11월 29일)

  • 멘토의 프로젝트 보고서 및 평가 제출
  • Docs 시즌에 참가한 경험을 토대로 보고서를 작성해 제출해 주세요.