このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソースの組織:
- CircuitVerse
- テクニカル ライター:
- プラガティ
- プロジェクト名:
- ユーザー向けのドキュメントとガイド
- プロジェクトの長さ:
- 標準期間（3 か月）
プロジェクトの説明
対象ユーザーと現在利用可能なユーザー ドキュメントを詳細に分析した結果、以下のドキュメント作成タスクを提案します。
1）動画チュートリアルを追加して、一般的なワークフローを説明し、オンボーディング エクスペリエンスを改善します。動画では 1 つのコンセプトの概要を説明します。動画では、画面上でそのアクションを実行する際の指示が表示されます。
組み合わせ分析ツールの使用方法に関するサンプル動画チュートリアルのリンクは、https://www.youtube.com/watch?v=7FkeqBYcd1w で確認できます。注 1: この動画は既存のコンテンツを例示していますが、アノテーションを使用して一貫した動画スタイルを作成する方法を示すことを目的としています。注 2: CircuitVerse で働き始める際に、このソフトウェアのライセンスを購入します。最終的な製品にはウォーターマークは含まれません。
動画チュートリアル ワークフローの推奨トピック: --CircuitVerse のスタートガイド: この動画チュートリアルでは、CircuitVerse の概要を説明します。 --組み合わせ分析ツールの使用: この動画チュートリアルでは、真理値表データを使用して回路を生成する方法を学びます。--高解像度画像をエクスポートする: この動画チュートリアルでは、回路の高解像度画像を複数の形式でエクスポートする方法を学びます。 --構造化設計にサブ回路を使用する: この動画チュートリアルでは、複雑な回路の構造を簡素化するためにサブ回路を作成する方法を学びます。 --Hex-Bin-Dec 変換ツールを使用する: この動画チュートリアルでは、回路の設計と実装に Hex-Bin-Dec 変換ツールを使用する方法を学びます。--特定の回路の回路タイミング図を可視化する: この動画チュートリアルでは、特定の回路の回路タイミング図を可視化する方法について説明します。
一部の動画チュートリアルは、ウェブページやユーザー ドキュメント間で相互リンクできます。
2）チュートリアルのランディング ページを作成し、CircuitVerse プラットフォームの概要と、さまざまなワークフローのグラフィカルなビューを紹介します。ユーザーは、Circuitverse GitHub サイトのチュートリアル ランディング ページにアクセスします。このページには、さまざまなコンテンツ ワークフローに応じて提供されるさまざまなチュートリアルの概要が記載されています。これにより、ユーザーはニーズに合わせてさまざまなチュートリアルを表示、選択できます。以下に、チュートリアルのランディング ページのページ構造の概要を示します。
3）ステップバイステップのチュートリアルを作成し、ツールを使用して基本的な回路と複雑な回路の動作を学習し、分析する方法をユーザーに説明します。実際にツールをいじってツールを教えることができます。CircuitVerse の注目のプロジェクトを参考に、オンボーディング エクスペリエンスを改善するために、初級および中級レベルのユーザー向けに少なくとも 5 つのチュートリアルを追加することを提案します。各チュートリアルでは、チュートリアルの概要、設計プロセス、コンポーネントのリスト、手順、演習を順に説明します。複雑なワークフローの場合、動画では全体的なコンセプトの個々の部分を取り上げています。
次のリンクをクリックしてサンプル チュートリアルをご覧ください: 7 セグメント デコーダの構築: https://pragatijain.github.io/circuitverse/index.html
トピックには次のものがあります。 -- ローリング LED ディスプレイを作成する -- リプル キャリー加算器の仕組みを調べる -- パート 1A: 4 ビットの振幅比較器を分析する -- パート 1B: 16 進数計算機を作成する -- 有限状態マシン（FSM）の実装を分析する
4）サイドバー ナビゲーションの構造を見直して、一貫性、読みやすさ、一貫性を向上させる。
プロジェクト ツール 1）Camtasia（動画チュートリアル用）。サンプル動画の作成には試用版を使用しました。CircuitVerse で働き始める際に、ソフトウェアのライセンスを購入します。最終的な製品にはウォーターマークは含まれません。2）ガイドを作成するための Google ドキュメント。後で GitHub で更新して、CircuitVerse リポジトリでホストできるようにします。 3）GitHub でコンテンツを管理するための Wiki マークアップと HTML。
タイムライン 8 月 16 日より前 GitHub で組織に貢献します。
コミュニティの結束（8 月 17 日～ 9 月 13 日） コミュニケーション チャネルと時間を設定します（時差があるため）。目標を絞り込み、両者で期待値を設定します。 コミュニティとプロダクトの詳細をご覧ください。提案されたドキュメント構造についてメンターや組織の他のメンバーと話し合い、確定します。
ドキュメント作成期間 このプロジェクトは、標準的なプロジェクトのガイドラインに沿って実施されます（2020 年 9 月 14 日から 2020 年 11 月 30 日までの合計 11 週間）。以下に示す目標を達成するために、週に 20 時間ほどを費やす予定です。これらの目標に加え、必要に応じてこの期間中、メンターのミーティングやコミュニケーションにも参加します。メンターと協力して、最適なタイミングを決定します。 注: このタイムラインは柔軟性があり、組織のニーズが変化する可能性があることを認識しています。長い期間を設定することで、必要に応じて柔軟に焦点を切り替えることができます。
1 週目: 特定されたマイルストーンに目を通し、精査します。CircuitVerse リポジトリをフォークして自分のマシンにダウンロードします。動画のスタイルについてメンターと話し合い、動画のオープニング画面テンプレート、タイトル画面とエンディング画面のフィラー ミュージック、追加すべき情報を作成します。動画チュートリアルのトピックを確認し、承認を受ける チュートリアルのトピックを特定して承認を受ける。 サイドバーのナビゲーション構造を確認して承認を受ける
2 週目: チュートリアル テンプレートを作成してメンターから承認を得る チュートリアルをホストするためのチュートリアル ランディング ページを作成する
3 週目、4 週目、5 週目: さまざまなシミュレータ ワークフローを示す動画チュートリアルを追加する
週 6、7、8、9: さまざまなシンプルな回路と複雑な回路のチュートリアルを作成する
週 10: 一貫性を保つようにサイドバー ナビゲーションを再構成し、ユーザー オンボーディング エクスペリエンスを改善
11 週目: 誤字脱字や誤りがないか確認する。
関連する CircuitVerse の業務サンプル
*次のリンクをクリックしてサンプル チュートリアル: 7 セグメント デコーダを構築する: https://pragatijain.github.io/circuitverse/index.html
*組み合わせ分析ツールを使用するためのサンプル動画チュートリアルのリンクはこちらです。https://www.youtube.com/watch?v=7FkeqBYcd1w 注 1: この動画では既存のコンテンツを例に挙げていますが、アノテーションを使用して一貫した動画スタイルを作成する方法を紹介することを目的としています。注 2: GDevelop での作業を開始したら、ソフトウェアのライセンスを購入します。最終的な製品にはウォーターマークは含まれません。
*CircuitVerse チュートリアルのランディング ページ https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*Google ドキュメントとして提案書全体を表示: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
サンプル チュートリアル テンプレート: 7 セグメント デコーダ 7 セグメント デコーダ
概要:
このチュートリアルでは、CircuitVerse を使用して 7 セグメント デコーダを作成するさまざまな手順を紹介します。デコーダは、2 進数を対応する 10 進数に変換する組み合わせ回路です。4 ビットの入力を受け取り、7 つの出力があります。
設計手順
CircuitVerse で 7 セグメント ディスプレイ回路を生成するには、次の手順を行います。CircuitVerse シミュレータで利用可能な組み合わせ分析ツールを使用して、真理表を作成します。この真理表を使用して、シミュレータ内で回路を生成します。この回路は、7 セグメント LED ディスプレイに出力を駆動します。組み合わせ回路のラベルを 7 セグメント LED ディスプレイの出力に接続して、回路が動作する様子を確認します。7 セグメント ディスプレイは、0 ～ 9 の数字を表示する電子ディスプレイ デバイスです。真理値表のデータを使用して回路の動作を分析します。真実値表 表 1 に、7 セグメント デコーダの入力の組み合わせごとに出力を示します。
CircuitVerse の要素リスト
表 2 に、回路の実装に必要なさまざまなコンポーネントを示します。
真理表を作成します。
CircuitVerse シミュレータ内で真理表を作成するには、次の手順を行います。
回路を完成させる
図 10 を参照して、組み合わせ回路のラベルに対応する入力ワイヤーを 7 セグメント ディスプレイの出力に接続し、回路を完成させます。この動画では、CircuitVerse シミュレータ内で作成された 7 セグメント デコーダのシミュレートされた回路を示しています。動画リンク: https://www.youtube.com/embed/tGTy4P-RxP0
回路を分析する
さまざまな入力値（S3、S2、S1、S0）を切り替えて、真理値表を検証（表 1 を参照）して、実装された 7 セグメント デコーダ回路を検証します。
7 セグメント ディスプレイ コンポーネントには 8 個の LED セグメントが内蔵されており、図 8 に示すように、ピンの一端がモジュールから引き出されています。特定のセグメントの LED を点灯させるには、関連するセグメント（図 10 で a、b、c、d、e、f、g とラベル付けされています）の電源を投入して、0 から 9 までの数字を表示する必要があります。たとえば、番号 1 を表示するには、LED b と c の電源をオンにする必要があります。
LED に正しい小数が表示されない場合は、表 3 と図 10 を参照して、配線接続のトラブルシューティングを行います。表 3 に、7 セグメント ディスプレイのピン構成を示します。