このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- CircuitVerse
- テクニカル ライター:
- プラガティ
- プロジェクト名:
- ユーザー ドキュメントとガイド
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
対象者と現在利用可能なユーザー ドキュメントを詳細に分析した後、以下のドキュメント タスクを提案します。
1）動画チュートリアルを追加して、一般的なワークフローのデモンストレーションを行い、オンボーディング エクスペリエンスを向上させます。1 つのコンセプトの概要を説明する動画。動画は、そのアクションを画面上で実行しながら方向を示します。
組み合わせ分析ツールの使用に関するサンプル動画チュートリアル リンクは、https://www.youtube.com/watch?v=7FkeqBYcd1w にあります。 注 1: この動画は既存のコンテンツを例示していますが、アノテーションを使用して一貫性のある動画スタイルを作成することを目的としています。 注 2: 私が CircuitVerse の作業を開始する際、そのソフトウェアのライセンスを購入します。最終的なプロダクトには透かしを入れません。
動画チュートリアル ワークフローに関する推奨トピック: --CircuitVerse スタートガイド: CircuitVerse クイックツアーの動画チュートリアルをご覧ください。 --Combinational Analysis Tool の使用: 真実表データを使用して回路を生成する方法については、この動画チュートリアルをご覧ください。 --高解像度画像のエクスポート: 回路の高解像度画像を複数の形式でエクスポートする方法については、この動画チュートリアルをご覧ください --構造化設計用のサブ回路の使用: 複雑な回路の構造を簡素化するサブ回路の作成方法を解説する動画チュートリアル --Hex-Bin-Dec Convertor ツールの使用: Hex-Bin-Dec Convertor ツールの実装方法については、この動画チュートリアルをご覧ください-- 特定の回線の回路のタイミング図の可視化: この動画チュートリアルでは、特定の回線の回路のタイミング図を視覚化する方法について説明します。
一部の動画チュートリアルは、ウェブページやユーザー ドキュメントにリンクできます。
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 の 10 進数を表示する電子表示デバイスです。真理値表のデータを使用して、回路の動作を分析します。真理表 以下の表 1 に、7 セグメント デコーダの入力の組み合わせに応じたさまざまな出力を示します。
CircuitVerse 要素リスト
表 2 に、回路の実装に必要な各種コンポーネントを示します。
真理表を公式化する
CircuitVerse シミュレータ内で真理値表を作成する手順は次のとおりです。
回路を完成させる
図 10 を参照して、組み合わせ回路の対応するラベルの入力ワイヤーを 7 セグメント ディスプレイの各出力に接続して、回路を完成させます。 この動画では、CircuitVerse シミュレータ内に構築された 7 セグメント デコーダのシミュレーション回路について説明します。 動画リンク: https://www.youtube.com/embed/tGTy4P-RxP0
回路の分析
さまざまな入力値（S3、S2、S1、S0）を切り替え、真理値表（表 1 を参照）を検証して、実装された 7 セグメント デコーダ回路を検証します。
図 8 に示すように、7 セグメント ディスプレイ コンポーネントには 8 つの LED セグメントがあり、ピンの一端がモジュールから引き出されています。特定のセグメントの LED を点灯するには、該当するセグメント（図 10 では a、b、c、d、e、f、g）の電源を入れて 0 から 9 までの数字を表示する必要があります。たとえば、番号 1 を表示するには、LED b および c の電源を入れてください。
LED が正しい 10 進数が表示されない場合は、表 3 と図 10 を参照して、配線接続のトラブルシューティングを行ってください。表 3 に、7 セグメント ディスプレイのピン構成を示します。