このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソースの組織:
- Mautic
- テクニカル ライター:
- Swati Thacker
- プロジェクト名:
- Mautic のエンドユーザー向けドキュメントを確認、更新する
- プロジェクトの長さ:
- 標準の期間（3 か月）
プロジェクトの説明
既存のドキュメントを確認した最初の印象は次のとおりです。
現在、ドキュメントは長く、多くの箇所で冗長であり、不完全で、整理されていないため、ユーザーが必要な情報を探すのが難しい場合があります。
初めて Mautic を使用するユーザーとして、キャンペーン、アセット、メッセージ、カテゴリなど、Mautic のさまざまな要素がどのように連携してビジネスニーズを解決するかを理解できませんでした。各 Mautic 要素を 2 ～ 3 行で説明する概要のコンセプト トピックを用意することをおすすめします。このトピックは、これらの要素の詳細なタスク トピックにリンクできます。
フォーラム、Slack チャンネル、git リポジトリへのリンクを記載することで、問題を報告する方法、新しいコンテンツやアイデアを提案する方法、バグや問題、セキュリティの脆弱性を報告する方法などの詳細情報を追加して、貢献ガイドを拡張できます。また、スタイルガイドを拡張して、標準のタイポグラフィ規則、画像や表に関するガイドラインなどを追加する必要があります。
また、メールやキャンペーンには不完全な情報や古い情報がかなりあり、更新が必要です。
貢献したい分野:
ユーザーが Mautic コミュニティと直接やり取りする Slack チャンネルのディスカッションを見ていると、キャンペーンとメールが Mautic の重要な要素であることに気づきました。バージョン 3 で MautTIMESTAMP を使用してキャンペーンに関するドキュメントをテストしたところ、大がかりな見直しが必要であることがわかりました。以下に、見つかった問題と、それぞれの解決策を示します。
- Mautic のユーザーは、キャンペーンを作成する際に、さまざまなアクション、決定、条件から選択できます。多くのアクションと決定についてのドキュメントはなく、キャンペーン条件のドキュメントはほとんどない。不足している情報を特定し、エンドユーザーのドキュメントに追加する必要があります。
- キャンペーンは、シンプルなものから非常に複雑なものまで、さまざまなものがあります。初めてキャンペーンを作成するユーザーにとっては、現在のドキュメントではあまり意味がありません。いくつかのユースケース（簡単なものと複雑なものの両方）を特定し、初回ユーザーが独自のキャンペーンの作成を開始する前に参照できるサンプル ワークフロー（チュートリアルの手順、エンドユーザー ガイド内のトピック、チュートリアル動画のいずれか）を作成することをおすすめします。
- このセクションの情報は、より整理され、整然とした形で提示する必要があります。使いやすさを高めるには、タスクとコンセプトに基づくアプローチに従う必要があります。トピックは、表を使用して、アクション、決定、および条件に関する情報を提示できます。「日付トリガーの使用」というトピックは、少し場違いな印象を受けます。[条件] の下にネストできます。
キャンペーンに加えて、メールのドキュメントも UI と照らし合わせてテストしました。以下のような対応をご提案いたします。
- メール用動的コンテンツは、カスタムコードのメール テンプレート（テンプレート メールとセグメント メールの両方）で使用できますが、現在、ドキュメントはありません。動的コンテンツの機能と設定方法、例を追加します。
- モニタリング メール用に個別のトピックを追加します。ダッシュボードで利用可能なメール ウィジェットの使用方法や、メール関連の指標やアクティビティの追跡にウィジェットをどのように使用できるかなどです。また、追跡メールに関する情報をここに移動します。
- ドキュメントでは、連絡先の返信、バウンス管理、メール送信者がオーナーであるという設定が、[メール設定] で構成できるグローバル設定であることが明記されていません。すべてのメール設定は、1 つのカテゴリにまとめる必要があります。また、デフォルトの頻度ルールや登録解除の設定など、他のメール設定の多くはドキュメントに記載されていません。どの設定が必須か任意かを説明します。
- バウンス管理ページから、Webhook に関するすべての情報を削除し、Webhook の別のトピックに移動します。トピックのリンクをこちらからご案内いたします。
また、次の点も改善されています。 - ダッシュボードのトピックに、利用可能なウィジェットに関する不完全な情報が記載されています。この情報は重要であり、ユーザーが Mautic リソースを分析、モニタリングする際に役立つため、追加する必要があります。
不足している要素を特定するには、ドキュメント全体をつなぎ合わせる必要があります。ドキュメントをユーザーにとってよりわかりやすいものにするために、改訂する必要があります。
自分の知識や経験がこのプロジェクトにどのように役立つと思いますか？
過去 1 か月間、Mautic 3.0 の最新リリースのサポートの追加など、Mautic ドキュメントのさまざまな問題に取り組んだ結果、エンドユーザー向けドキュメントの構造を把握し、ドキュメントの不足を特定できました。他のマーケティング自動化ツールのドキュメントを調べ、Mautic のエンドユーザー向けドキュメントと比較して、ドキュメントのギャップを埋める方法を理解しました。HTML 言語、オープンソースのツール、プロセスに精通していることは、さらに利点となります。現在、ユーザー エクスペリエンス リサーチのコースを受講しており、その原則を適用して、よりユーザー重視のドキュメントを作成できます。また、情報アーキテクチャの経験を生かして、コンテンツを整理し、ドキュメントをユーザーの目標に合わせるためのアイデアを提案できます。さらに、新しい技術分野の知識を広げることに長けています。10 年にわたるテクニカル ライティングの経験と、GSOD でこれまでまったく新しい技術分野の組織を無事に完了させた経験を活かし、Mautic のドキュメントの作成に貢献できると確信しています。