이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 마법의 색
- 테크니컬 라이터:
- 켈빈식 사랑
- 프로젝트 이름:
- 기술 자료
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
개요
기술 자료는 정보가 저장, 구성, 공유되는 중앙 집중식 저장소입니다. 외부에서 사용되는 기술 자료는 사용자가 회사의 제품이나 서비스, 조직, 산업에 대해 알아야 할 모든 것을 배울 수 있는 곳입니다. 반면 내부 기술 자료는 일반적으로 커뮤니티/사용자가 협업하고 회사의 모든 지식과 정보를 내부적으로 배포할 수 있는 방법으로 사용됩니다. 특정 기술 자료의 내용은 다양한 요인에 따라 달라지지만, 대부분의 요소에는 특정 제품 사용을 시작하고, 고급 기능을 최대한 활용하고, 일반적인 문제나 문제를 해결하는 방법에 관한 정보가 포함되어 있습니다. 기술 자료를 만들어 잠재고객에게 제공하는 것의 주요 이점은 개별적으로하지 않고도 독자층 구성원/사용자/커뮤니티에 심층적이고 즉각적인 주문형 정보와 답변을 제공할 수 있다는 것입니다.
Mautic Knowledgebase는 직접 (예: Mautic에서 작업 방법) 또는 간접 (예: 일반적인 마케팅 전략) 등 Mautic과 관련된 주제에 대한 튜토리얼, 안내 가이드, 권장사항을 제공하는 중앙 저장소입니다.
이 글을 작성하는 시점을 기준으로 Mautic Knowledgebase는 상당히 새롭고 불완전한 상태입니다. 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일)
- 이 기간 동안 저는 멘토와 직접 협력하여 다음을 할 수 있습니다.
- 기술 자료를 검토합니다.
- Mautic 3x 버전에 맞게 튜토리얼 및 안내 가이드를 업데이트합니다.
- 새로 만든 Mautic 커뮤니티 기술 자료에 대한 리소스를 만듭니다.
- 일련의 안내 튜토리얼과 가이드를 작성하여 Mautic 사용자가 애플리케이션을 보다 효과적으로 설정, 구성, 사용할 수 있도록 돕습니다.
- 동영상 튜토리얼을 Mautic 3x 버전에 맞게 업데이트합니다.
- 사용하지 않는 이미지와 정보를 삭제합니다.
- 이해하기 쉽도록 기술 자료를 다시 작성하세요.
- 기술 자료 문서의 스타일 가이드/패턴이 올바르게 구현되었는지 확인합니다.
- 개발팀이 마이너 기능 출시로 바쁠 수 있으므로 출시 주기를 고려합니다.
프로젝트 평가 (2019년 11월 25~29일)
- 프로젝트 보고서 제출 및 멘토 평가
- Docs 시즌에 참여한 사용자 경험 보고서를 작성하여 제출합니다.