このページには、Google シーズンの Google ドキュメントで承認されたテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- モーティック
- テクニカル ライター:
- Swati Thacker
- プロジェクト名:
- Mautic のエンドユーザー ドキュメントを確認、更新します
- プロジェクトの期間:
- 標準の長さ（3 か月）
プロジェクトの説明
既存のドキュメントを確認したときの第一印象:
現在、ドキュメントは長く、多くの場所で冗長であり、不完全で無秩序なため、ユーザーが探している情報を見つけるのが難しい場合があります。
私は初めて利用しましたが、キャンペーン、アセット、メッセージ、カテゴリといった Mautic のさまざまな要素がどのように組み合わされてビジネスニーズが解決されているかを理解できませんでした。各 Mautic の要素を 2 ～ 3 行で説明する、大まかな概念的なトピックを用意することを提案します。このトピックは、これらの各要素に関するさまざまな詳細なタスクトピックにリンクできます。
フォーラム、Slack チャンネル、Git リポジトリへのリンクを提供することで、コントリビューション ガイドを拡張して、問題を報告する方法、新しいコンテンツやアイデアを提案する方法、バグ / 問題 / セキュリティの脆弱性を報告する方法などの詳細情報を含めることができます。また、スタイルガイドを拡張して、標準のタイポグラフィ規則、画像のガイドライン、表などを追加する必要があります。
さらに、メールやキャンペーンには不完全な情報が多く、更新が必要な古い情報も存在します。
貢献したい地域:
ユーザーが Mautic コミュニティと直接やり取りする Slack チャンネルでのディスカッションを通じて、キャンペーンとメールが Mautic の重要な要素であることがわかりました。Mautaspx バージョン 3 を使用してキャンペーンに関するドキュメントをテストしたところ、大幅な修正が必要であることがわかりました。見つかった問題と、それぞれの問題に対する提案は次のとおりです。
- Mautic のユーザーはキャンペーンの作成中に、さまざまなアクション、決定、条件を選択できます。多くのアクションや決定事項に関するドキュメントが不足していますが、キャンペーンの条件に関するドキュメントはほとんどありません。不足している情報を特定し、エンドユーザー ドキュメントに追加する必要があります。
- キャンペーンは単純な場合もあれば、非常に複雑な場合もあります。現在のドキュメントは、初めてキャンペーンを構築するユーザーにとってはあまり意味がありません。まず、ユースケース（単純なものから複雑なものの両方）を特定し、初めて使用するユーザーが独自のキャンペーンを構築する前に参照できるサンプル ワークフロー（手順ガイドのチュートリアル、エンドユーザー ガイドやチュートリアル動画内のトピックのいずれか）を作成することを提案します。
- このセクションでは、情報をより整理された整然とした形式で提示する必要があります。ユーザビリティを高めるには、タスクとコンセプト ベースのアプローチに従う必要があります。トピックでは、表を使用して、アクション、決定、条件に関する情報を表示できます。「日付トリガーの使用」のトピックは、少し違和感があります。[条件] の下にネストできます。
キャンペーンに加えて、メールに関するドキュメントも UI でテストしました。私が提案する取り組みは次のとおりです。
- Dynamic Content for Emails は、カスタムコード メール テンプレート（テンプレート メールとセグメント メールの両方）で使用できますが、現時点ではドキュメントはありません。動的コンテンツの内容とその設定方法に関する詳細と、いくつかの例を追加します。
- Monitoring のメール用に別のトピックを追加します。これには、ダッシュボードで利用可能なメール ウィジェットの使用方法と、ウィジェットを使用してメール関連の指標やアクティビティを追跡する方法に関する情報が含まれます。また、追跡メールに関する情報もここに移動します。
- ドキュメントには、連絡先の返信、バウンス管理、メーラーが所有者であることは記載されていません。これらは、[メール設定] で構成できるグローバル設定です。メール設定はすべて、包括的なトピックにまとめる必要があります。また、デフォルトの頻度ルールや登録解除の設定など、他の多くのメール設定も文書化されていません。どの設定が必須または任意であるかを記載します。
- バウンス管理ページから、Webhook に関するすべての情報を削除し、Webhook の別のトピックに配置します。そのトピックへのリンクがここに表示されます。
さらに: - ダッシュボード トピックで利用可能なウィジェットに関する情報が不完全である。この情報は重要であり、ユーザーが Mautic リソースを分析、モニタリングするうえで役立つため、追加する必要があります。
問題点を特定するために、ドキュメント全体をひとまとめに揃える必要があります。ドキュメントをユーザーが利用しやすくなるように改良する必要があります。
自分の知識や経験が、このプロジェクトにどのように役立つと期待しているか？
過去 1 か月にわたり、最新の Mautic 3.0 リリースのサポートを追加するなど、Mautic のドキュメントのさまざまな問題に取り組んだ結果、エンドユーザー向けドキュメントの構造を理解し、ドキュメントのギャップを特定することができました。他のマーケティング自動化ツールのドキュメントを調査し、Mautic エンドユーザーのドキュメントと比較して、ドキュメントでそれらのギャップを埋める方法を理解しました。また、HTML 言語、オープンソース ツール、プロセスに精通していることも有利です。 現在、ユーザー エクスペリエンス研究のコースを進めており、この原則を応用して、よりユーザー指向のドキュメントを作成しようとしています。また、情報アーキテクチャの経験を活かして、コンテンツを整理し、ユーザーの目標に合わせてドキュメントを整理し、アイデアを提案できるようになります。また、新しい技術分野に関する知識を広げるコツも身に付きます。テクニカル ライティングに関する 10 年間の経験と、以前は GSOD の経験があり、まったく新しい技術分野の組織のプロジェクトを成功に導いてきたため、Mautic のドキュメントへの貢献を正当に行えると確信しています。