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