このページは Cloud Translation API によって翻訳されました。

Mautic プロジェクト

このページには、Google シーズンの Google ドキュメントで承認されたテクニカルライティングプロジェクトの詳細が記載されています。

プロジェクトの概要

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

プロジェクトの説明

概略

ナレッジベースは、情報を保存、整理、共有する中央リポジトリです。ナレッジベースは、社外で使用する場合に、企業の製品やサービス、組織、業界について知っておくべきあらゆる情報を参照できる場所です。一方、社内ナレッジベースは通常、コミュニティやユーザーが協力し、会社のすべての知識と情報を社内で配布するための手段として利用されます。ナレッジベースの内容はさまざまな要因によって異なりますが、ほとんどの場合、特定のプロダクトを使い始める方法、高度な機能をさらに活用する方法、よくある問題や問題を解決する方法についての情報が含まれています。ナレッジベースを作成してオーディエンスに提示する主な利点は、オーディエンスメンバー/ユーザー/コミュニティに、詳細かつ即時のオンデマンドの情報や回答を、個別に提供しなくても提供できることです。

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

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

既存のドキュメントを確認したときの第一印象現在、Mautic ナレッジベースは https://kb.mautic.org/ から入手できます。ドキュメント内のチュートリアル、ハウツーガイド、ベストプラクティストピックの一部が最新ではなく、まばらまたは不完全です。また、Python の現行バージョンに関する情報も網羅していません。

現在の私が貢献したい分野について、改善が提案されているのはなぜですか？改善案は、効率性、一貫性、すべてのエンドユーザーの安心感を改善し、確保するためのものです。チュートリアル、ハウツーガイド、ベストプラクティス、関連画像が含まれています。また、Mautic の各機能の使い方に関する指示と説明が盛り込まれており、最新で、操作しやすく、理解しやすいものです。

分析

Mautic のナレッジベースは、Grav フラットファイル CMS と KLB4 テーマで作成されています。ナレッジベースのドキュメントを改善するためにいろいろな方法を調べた

プロジェクトの目標

ナレッジベースを確認する。
Mautic 3x バージョンに合わせてチュートリアルとハウツーガイドを更新します。
新しく作成された Mautic Community ナレッジベースのリソースを作成する
Mautic ユーザーがアプリケーションの設定、構成、使用を効果的に行えるように、一連のハウツーチュートリアルとガイドを作成します。
Mautic 3x バージョンに合わせて動画チュートリアルを更新します。
古くなった画像と情報を削除する。
理解しやすいようにナレッジベースを書き直す。
ナレッジベースドキュメントのスタイルガイド/パターンが適切に実装されていることを確認する

タイムライン

8 月 1 日より前

組織への貢献を継続する。
ナレッジベースのドキュメントと Mautic の現行バージョンについて理解を深めます。
プロジェクトの実施に役立つ新しいテクニックやテクニカルライティングのスキルを学ぶ。

コミュニティの絆（8 月 1 日～ 9 月 1 日）

コミュニケーションチャネルと時間（時差による）を設定する
目標を絞り込んで、双方に期待値を設定する
コミュニティとサービスの詳細
提案するドキュメントの構成について、メンターや組織の他のメンバーと話し合います。
提案された機能と、既存のドキュメントに加える必要のあるその他の変更を確定する。

証拠書類の期間

第 1 週（9 月 2 日～ 11 月 22 日）
この期間中に、メンターと直接連携して、次のことを行います。
ナレッジベースを確認する。
Mautic 3x バージョンに合わせてチュートリアルとハウツーガイドを更新します。
新しく作成された Mautic Community ナレッジベースのリソースを作成する
Mautic ユーザーがアプリケーションの設定、構成、使用を効果的に行えるように、一連のハウツーチュートリアルとガイドを作成します。
Mautic 3x バージョンに合わせて動画チュートリアルを更新します。
古くなった画像と情報を削除する。
理解しやすいようにナレッジベースを書き直す。
ナレッジベースドキュメントのスタイルガイド/パターンが適切に実装されていることを確認します。
開発チームはマイナーな機能のリリースに忙殺されるため、リリースの頻度を考慮する

プロジェクト評価（2019 年 11 月 25 日～ 29 日）

プロジェクトレポートと評価をメンターが提出する
「ドキュメントのシーズン」に参加した感想をレポートに記載して提出する。