このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- モート語
- テクニカル ライター:
- ケルビンを優先
- プロジェクト名:
- ナレッジベース
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
抽象化
ナレッジベースは、情報を保存、整理、共有する、一元化されたリポジトリです。ナレッジベースは、社外で使用する場合、企業の製品やサービス、組織、業界について知っておくべきあらゆることを学べる場所です。一方、社内のナレッジベースは通常、コミュニティやユーザーが協力し、会社のすべての知識と情報を社内で配布できるようにするための手段として利用されます。ナレッジベースの内容はさまざまな要因によって異なりますが、ほとんどの場合、特定のプロダクトを使い始める方法、高度な機能を活用する方法、よくある問題や問題を解決する方法についての情報が含まれます。ナレッジベースを作成してオーディエンスに提示する主なメリットは、詳細かつ即時のオンデマンドの情報や回答をオーディエンス メンバー、ユーザー、コミュニティに個別に提供することなく提供できることです。
Mautic Knowledgebase は、Mautic に関連するトピックについて、直接（例: Mautic でのやり方）または間接的（例: より一般的なマーケティング戦略）に関するトピックのチュートリアル、ハウツーガイド、ベスト プラクティスの中央リポジトリです。
本稿を執筆している時点では、Mautic のナレッジベースはかなり新しく、不完全です。Mautic コミュニティは、このプロジェクトを利用して、詳細なオンデマンド情報をユーザー ドキュメントに提供する方法を改善し、エンドユーザーが Mautic を使用する際にシームレスなエクスペリエンスを提供したいと考えています。Mautic Knowledgebase はとても参考になりましたが、新しいチュートリアルとハウツーガイドを作成したり、Mautic 3x バージョンと一致させたりするには、最新のチュートリアルとハウツーガイドが必要でした。
既存のドキュメントをご覧になったときの第一印象: 現在、Mautic ナレッジベースは https://kb.mautic.org/ からご利用いただけます。ドキュメント内のチュートリアル、ハウツーガイド、ベスト プラクティス トピックは、最新ではなく、まばらまたは不完全です。また、Mautic の現行バージョンに関する情報も含まれていません。
現在の自分が貢献したいと思う分野よりも、改善が提案された理由は何ですか。今回提案する改善は、効率性、一貫性、エンドユーザーの安心感を改善するためのものです。これには、手書きのチュートリアル、ハウツーガイド、ベスト プラクティス、関連画像が含まれ、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 日～ 29 日）
- プロジェクト レポートやメンターの評価を受ける
- Google ドキュメント シーズンに参加したことについてのレポートを作成し、送信する。