Kolibri プロジェクト

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

プロジェクトの概要

オープンソースの組織:
Kolibri
テクニカル ライター:
ダニエレ V
プロジェクト名:
Kolibri コンテンツ ワークフロー
プロジェクトの期間:
長時間（5 か月）

プロジェクトの説明

以下の提案は、調査を実施し、Kolibri のメンターと話をして作成したものです。メンターとの会話は、以下で説明するユーザー ペルソナを発展させるうえで役立ちました。また、ディスカッションを通じて、ユーザーが必要に応じてどのチュートリアルを視聴するかを選択できるように、チュートリアル リポジトリやランディング ページに関するアイデアを生み出すことができました。

概要

この提案は、パソコンから Kolibri Studio にコンテンツをインポートし、次に Kolibri Studio から Kolibri にコンテンツをインポートする際の、さまざまなユーザー ジャーニーをガイドするソリューションを提供します。チュートリアルの中央リポジトリを作成することをおすすめします。ユーザーはランディング ページからこれらのチュートリアルにアクセスします。ランディング ページには、各ワークフロー チュートリアルへのリンクが記載された表が表示され、そのチュートリアルが役立つユーザーの種類が示されます。これにより、ユーザーのニーズと能力に応じてチュートリアルがパーソナライズされます。ワークフロー（インストール - インポートなど）は、複数のレッスンで説明されます。各レッスンには動画が含まれています。動画ではワークフローの一部を紹介し、これらのワークフローが Kolibri アプリケーションを接続する仕組みについて個々のコンセプトを実演します。

主な目標

  1. ユーザーがニーズに最適なワークフローを判断できるよう、チュートリアルのランディング ページを作成します。このランディング ページは Read the Google ドキュメント プラットフォームでホストされます。

  2. ワークフローの構成要素ごとに個別のレッスンを作成し、難しいレッスンで演習を補完します。

  3. ワークフローごとにインタラクティブな動画を作成します。

プロジェクトのツール

作業には、スクリーンキャスト ソフトウェアを使用します。Camtasia では経験がありますが、法規制があまりないソフトウェアやフリーウェアも扱った経験があります。こちらにリンクされているサンプル動画（https://youtu.be/DkMP_VdGslU）は、現在ライセンスを持っている Blueberry Software の Flashback で作成されています。字幕は YouTube で作成します。チュートリアル ページは、Kolibri の Read the Docs のサイトでホストされます。下書きは Google ドキュメントで完了します。最終版のためにテキスト ファイルを Markdown または reStructuredText に変換するお手伝いをします。

試合経過

このプロジェクトは、長期プロジェクト ガイドライン（2019 年 9 月 2 日から 2020 年 2 月 28 日までの 26 週間）に従います。私は週に 10 時間ほどかけて、以下の目標を達成します。これらの目標に加えて、必要に応じてこの期間中にメンター ミーティングやコミュニケーションに参加します。その際、メンターと協力して最適な時間を決定いたします。タイムラインは通常 4 週間単位で分割され、複数の動画、チュートリアル ページ、演習を制作します。

第 1 週と第 2 週

目標:

  • 情報にアクセスするために必要なウェブサイトやアカウントを、個人のデバイスに設定します。
  • ランディング ページの構造とより詳細なワイヤーフレームの開発を開始する。
  • メンターと動画のスタイルについて話し合ってください。また、動画のオープニング画面のテンプレート、タイトル画面と終了画面用のフィラー ミュージック、含めるべき追加情報を作成します。
  • 現在のドキュメントとドキュメントの構造を確認して、追加のリソースやチュートリアルの参照用にリンクを抽出してください。

第 3 週から第 6 週（レベル 1 - 初心者向けチュートリアル）

目標:

  • インストール - インポート/レベル 1 ワークフロー用の初期コンテンツとレッスンを作成します。ダウンロード、インストール、構成、インポートのプロセスに関する動画を作成します。INSTALL-IMPORT 関数は、他の多くのワークフローの基礎であり、最もよく使用されるため、これらのチュートリアルとレッスンの最終処理に多くの時間が費やされます。
  • インポートする地域のタイプに焦点を当て、ランディング ページのコンテンツ（Kolibri Studio に存在する公開チャンネル）をユーザーが取得できることを示すグラフィックを作成します。
  • INSTALL-IMPORT（チャンネルの更新）の拡大に向けた追加の動画とコンテンツを開発する。追加のリソースや既存のドキュメントへのリンクとして提供される場合もあります。
  • すべての動画の字幕に取り組む。
  • 動画を「テスト」し、利用可能なリソースにユーザビリティに関するフィードバックを依頼する。これには、動画のテンプレートを再検討したり、今後の動画のためにテンプレートを固めたりすることが含まれます。

第 7 週から 10 週（レベル 2 - コンテンツ アップローダー）

目標:

  • Studio アップローダー ペルソナ向けのレッスンとワークフロー動画に焦点を当てます。
  • アップロード - 公開 - インポートのドキュメントとレッスンの全文。
  • あらゆる動画の字幕を作成する。

Weeks Eleven ～ Fourteen（レベル 3 - コンテンツの「リミキサー」および編集者）

目標:

  • 「UPLOAD-EDIT-PUBLISH-UPDATE」および「EDIT-PUBLISH-UPDATE」のワークフローに焦点を当てて、チュートリアル/レッスンのコンテンツを作成します。
  • 動画の字幕を作成する。

15 週から 18 週まで

目標:

  • この提案についての調査で伝えたように、Ricecooker を含むワークフローは優先度が低い（CHEFDEV タイプ）。タイミングとスケジュールによっては、この時間を利用して、Ricecooker の既存のドキュメントを参照する大まかなチュートリアルを作成できます。

第 19 週から第 22 週

目標:

  • 現時点で不足している要素がないかを確認し、すべてのチュートリアルの現在のフローをテストします。
  • ランディング ページの設定に取り組み、動画のリンクを開始する。
  • メンターと話し合って、Google ドキュメントで作成したページの下書きを Markdown または reStructuredText に変換するようにします。

第 23 週から第 25 週

目標:

  • 時間が許せば、優先度の低い高度なチュートリアルで最後の作業を完了します。
  • 直前: ドキュメント ページ編集、ファイル テスト、文法/スペルのチェック。
  • 動画内や他のページ上のリンクについて QA を行います。

第 26 週

長期にわたるプロジェクトの最終週。メンターと連携してプロジェクトの成果物をまとめ、最終的に必要な Google ドキュメントを完成させます。

チュートリアルのコンポーネント

チュートリアルのランディング ページ

Kolibri の Read the Docs サイトからのチュートリアル ランディング ページにアクセスでき、コンテンツ ワークフローで利用できるさまざまなチュートリアルの概要が記載されています。このページは、Kolibri エコシステムの概要を説明するとともに、さまざまなワークフローを視覚的に紹介することを目的としています。これにより、技術的にも組織のカリキュラムにも、それぞれのニーズに合った種類のワークフローを表示できます。ユーザーは、Kolibri と Kolibri Studio で利用できるオプションをより深く理解できるようになります。

チュートリアルとレッスンのページ

各チュートリアルのホームページには、（複数のレッスンで構成される）チュートリアルの概要が表示され、その後にいくつかのユーザーの目標が表示されます。チュートリアルは、個々のレッスンで構成されるワークフロー全体を図示したものです。各レッスンに 1 本の動画が用意されています。動画では、全体的なコンセプトの個々の部分を取り上げます。各レッスンは、チュートリアル ワークフローの親ページ内の個々のページに表示されます。レッスンページには、チュートリアル内の前または次のレッスンに移動できるボタンが表示されます。非常に複雑なコンセプトには、演習アクティビティが含まれる場合があります。

動画と構成

1 つのコンセプトの概要を説明する動画。動画は、そのアクションを画面上で実行しながら方向を示します。動画は https://youtu.be/DkMP_VdGslU でご覧いただけます。この動画では、[Setup Facility] ウィザードの使用方法を示しています。

動画では、吹き出しとハイライト表示されたカーソルを使用して、この 1 つのコンセプトの手順をユーザーに案内しています。動画は YouTube でホストされます。YouTube でホストされている場合、字幕は自動生成されます。次に、スペル、文法、句読点の字幕を編集します。エクスポートした字幕は、Amara などの翻訳ツールで翻訳できます。

動画のタイトル画面には一貫性を持たせ、最初の数週間以内にメンターと話し合う予定です。また、矢印、カーソルによるハイライト表示、ボックスなどの一貫したコールアウト スタイルを使用し、最初の数週間以内にメンターと一緒に決定します。

構造の例

最もシンプルなワークフローである「インストール インポート」は、チュートリアル全体です。チュートリアルには、動画を使って次の 2 つのレッスンが予定されています。

  • Kolibri 施設のダウンロード、インストール、設定
  • Kolibri Studio でのコンテンツのインポート - この動画は他のワークフローで参照されます

より高度なチュートリアルには、複数の動画を含む複数のサブレッスンが必要です。UPLOAD-EDIT-PUBLISH-UPDATE のワークフローは、次の構造に従います。

レッスン 1 - Kolibri Studio でのコンテンツのアップロードとチャンネルの作成

ユーザーの目標: このレッスンを終えると、次のアクションを行う方法について理解できます。

  • Kolibri Studio で、Kolibri で使用するチャネルを作成します。チャンネルのシークレット トークンを使用して Kolibri にコンテンツ チャンネルをインポートする方法を理解できます。
  • Studio ライブラリの既存の公開チャンネルからコンテンツをインポートして、チャンネルを作成します。
  • パソコンからコンテンツをアップロードしてチャンネルを作成します。

サブレッスン動画:

  • サブレッスン 1 - Kolibri Studio で独自のチャンネルを作成し、既存の公開チャンネル（Khan Academy、PHET など）からコンテンツをインポートする: 動画 1 - 公開コンテンツ チャンネル（Kolibri Studio の PUBLIC チャンネルの表示） 動画 2 – チャンネルの作成 動画 3 – 既存のチャンネルからのコンテンツのインポート 動画 4 – チャンネルの公開とシークレット トークンの取得 動画 5 – シークレット トークンを使用した Kolibri へのチャンネルのインポート
  • サブレッスン 2 - マイ ドキュメントのコンテンツ チャンネルのアップロード: 動画 1 - マイ ドキュメントからのファイルのアップロード 動画 2 - 独自の演習の作成

レッスン 2 - Kolibri Studio でのチャンネルの高度な編集

ユーザーの目標: このレッスンを終えると、次のアクションを行う方法について理解できます。

  • Kolibri Studio でコンテンツ チャンネルを編集する
  • Kolibri Studio でコンテンツ チャンネルを管理する

サブレッスン動画:

  • サブレッスン 1 - 演習の追加、フォルダ構造の再編成、コラボレーション オプションによるコンテンツの編集（1 本の動画）
  • サブレッスン 2 - コンテンツの削除/移動などの他の機能の使用（1 本の動画）

レッスン 3 – Kolibri で使用する Kolibri Studio チャンネルの公開とチャンネルの更新

ユーザーの目標: このレッスンを終えると、次のアクションを行う方法について理解できます。

  • Kolibri Studio でチャンネルを公開し、新しいコンテンツが追加された後に再公開する
  • チャンネルを更新する
  • Kolibri にインポートするチャネル トークンを取得する（このアクションについて説明するレッスン 1 の前の動画へのリンクを使用）

サブレッスン動画:

  • サブレッスン 1 - チャンネルの最新情報の公開

    動画 1: チャンネルを再公開する 動画 2: コンテンツを追加した後の Kolibri のチャンネルの更新