Mautic プロジェクト

このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。

プロジェクトの概要

オープンソース組織:
Mautic
テクニカル ライター:
ケルビンを優先
プロジェクト名:
ナレッジベース
プロジェクトの長さ:
標準の期間（3 か月）

プロジェクトの説明

概要

ナレッジベースは、情報が保存、整理、共有される一元化されたリポジトリです。社外向けのナレッジベースは、ユーザーが会社の製品やサービス、組織、業界について知りたい情報をすべて確認できる場所です。一方、社内ナレッジベースは、通常、コミュニティやユーザーがコラボレーションして、会社のすべての知識や情報を社内で共有できるようにする手段として使用されます。特定のナレッジベースのコンテンツはさまざまな要因によって異なりますが、ほとんどの場合、特定のプロダクトの使用を開始する方法、高度な機能を最大限に活用する方法、一般的な問題や問題を解決する方法に関する情報が含まれます。ナレッジベースを作成して視聴者に提供する主なメリットは、視聴者/ユーザー/コミュニティに、個別に行う必要なく、詳細な情報やオンデマンドの情報、回答を即座に提供できることです。

Mautic ナレッジベースは、Mautic に直接関連するトピック（Mautic での操作方法など）や間接的に関連するトピック（一般的なマーケティング戦略など）に関するチュートリアル、ハウツー ガイド、ベスト プラクティスをまとめた一元的なリポジトリです。

執筆時点では、Mautic ナレッジベースは非常に新しく、不完全です。Mautic コミュニティは、このプロジェクトを使用して、ユーザー ドキュメントに詳細なオンデマンド情報を提供する方法を改善し、エンドユーザーが Mautic をシームレスに使用できるようにしたいと考えています。Mautic ナレッジベースには有益な情報が記載されていますが、Mautic 3x バージョンに合わせて、チュートリアルとハウツーガイドの更新と新規作成が必要でした。

既存のドキュメントを確認した最初の印象 現在、Mautic ナレッジベースは https://kb.mautic.org/ で利用できます。ドキュメントのチュートリアル、ハウツー ガイド、ベスト プラクティスのトピックの一部は最新ではなく、情報が不十分または不完全です。また、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 日～ 11 月 29 日）

  • プロジェクト レポートを提出し、メンターによる評価を行う
  • ドキュメント シーズンの参加者として経験したことについてレポートを作成して送信します。