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

電子プロジェクト

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

プロジェクトの概要

オープンソースの組織:: 電子
テクニカルライター:: ミスターゴールド
プロジェクト名:: Electron のチュートリアルのフロー
プロジェクトの期間:: 標準の期間（3 か月）

プロジェクトの説明

プロジェクトの概要

Electron は、JavaScript、HTML、CSS を使ったクロスプラットフォームデスクトップアプリの構築で最も人気のあるツールの一つです。Electron 上で構築されたアプリのコレクションには 900 件近くのエントリがあり、その数は増え続けています。Visual Studio Code、Atom、Postman、Slack、GitKraken など、よく利用されているデベロッパーツールのいくつかは、Electron 上に構築されています。

Electron の習熟度がシンプルで、導入の手間も少ないことから、Electron の人気が高まっています。JavaScript、HTML、CSS スタックの知識があれば、誰でも独自のアプリケーションを構築できます。全体的な成長率が高いため、把握しやすく使いやすいチュートリアルやスタートガイドを作成する必要があります。

このプロジェクトの目標は、Electron フレームワークを初めて学ぶアプリケーション開発者に自信を与え、独自の Electron アプリケーションをゼロから開発する際の一貫性のある合理的なエクスペリエンスを提供することです。

プロジェクトに関する問題

Electron のチュートリアルのドキュメントに関連する最も重要な問題は次のとおりです。 1. アプリ開発のステップについて、開始点が不明確で、概要情報が直感的でない。 2. アプリ開発プロセスに関連する、ばらばらで冗長な情報。 3. 信頼できる唯一の情報源がない、「スタートガイド」手順がまとまっていない

プロジェクトの提案

本プロジェクトの目標と上記で説明した問題を踏まえ、改善案は次のとおりです。 1. 既存のガイドを更新します。最初のステップをスムーズかつ一貫性のあるものにするために、以下のドキュメントをシンプルなものから複雑なものへと段階的に切り替えて更新する必要があります。 - 開発環境 - 初めての Electron アプリの作成 - アプリへの機能の追加（概要ページの作成） - アプリのパッケージングと配布 2. ドキュメントディレクトリを再構成します。新しいデベロッパーに、開始に不可欠な要素と今後のステップと考えられるものを示すために、最初のアプリケーションを可能な限り迅速に公開するために、ドキュメントページには手順を視覚的に、状況に合わせて分割する必要があります。再構成には、次に行う可能性のあるステップに関するガイダンスも含まれます。3. アプリケーション開発ドキュメントを整理、統合する。すべての機能に、インストールと有効化の方法、すぐに使い始める方法、初回起動後のアプリの操作方法、アプリの配布方法など、統一された手順が用意されている必要があります。 4. ドキュメントに Electricron-api-demos リポジトリを含めます。Electricron-api-demos リポジトリには、Electron アプリケーションに機能を追加する方法を示す一連のサンプルが含まれています。この情報は、信頼できる唯一の情報源のコンテンツ戦略と一貫性を持たせるために、アプリへの機能の追加に関するガイドに含める必要があります。 5. Electron Fiddle の例をドキュメントに統合します。この手順により、新しいデベロッパーは、手順を手動で繰り返すことなく、特定のコードがどのように動作するかを簡単に確認できるようになります。この統合には、更新されたチュートリアルのコードサンプルの記述と、コードブロックへの [Fiddle での起動] ボタンの追加が含まれます。

タイムライン

申し込みの審査期間 - コミュニティや協力者についての理解を深めます。コミュニティ貢献ガイドとベストプラクティスを学ぶ。最初の投稿を行います。コミュニティの絆 - コミュニティを探索します。Electron のドキュメントの現状を調べます。弱点を特定する。第 1 週 - プロジェクトのマイルストーンと成果物についてメンターと認識合わせを行います。第 2 週 - 開発環境の見直しと最初の Electron アプリの作成を行います。第 3 週 - アプリケーションアーキテクチャの見直し、アプリへの機能の追加、アプリのパッケージング、配布の各ページを行います。アプリに追加できる機能のリストを含む概要ページを作成する第 4 週 - ドキュメントディレクトリを再構成する第 5 週 - Electricron-api-demos をメインのドキュメントに統合する方法のテンプレートを準備する第 6 ～ 7 週 - Electricron-api-demos リポジトリを移行する第 8 週 - Electron Fiddle をメインのドキュメントに統合する方法のテンプレートを準備する最初のサンプルを作成します。第 9 ～ 10 週 - Electron Fiddle をメインのドキュメントに統合する第 11 週 - Electricron-api-demos リポジトリと Electron Fiddle サンプルを移行した後、主要なドキュメントの構造とページの確定第 12 週 - 結果の評価

マイルストーンの詳細

申し込みの審査期間期間の最初の段階では、コミュニティチャンネルとソースコードのチェックと、プロジェクトの担当者への連絡に専念します。

後半では、投稿ガイドとベストプラクティスを交えて、投稿の文化全般の確認を行います。このときに、最初の投稿でフローの仕組みを確認します。

コミュニティの絆

この時間では、ドキュメントフォルダとそのロードマップを詳しく調べることができます。この情報に基づいて、改善できる弱点（不完全な部分や不足している部分など）を特定できます。ギャップを埋めるために（可能であれば）pull リクエストを作成します。

第 1 週～第 2 週

最初の週はメンターとのコミュニケーションを行い、期待されるマイルストーンとそのタイムリーな実施について調整します。

第 2 週は、開発環境の修正と、初めての Electron アプリの作成を行います。[Developer Environment] ページについては、全般的な概要の書き換えと校正が含まれています。「初めての電子アプリの作成」ページでは、開始点と終了点を明確にした一貫性のある手順ガイドにページを作成し、冗長な情報（「Nutshell で電子開発」と「この例を試す」セクションの 2 つの類似コードブロックなど）を削除しています。

成果物: Electron アプリケーションのクイックスタート方法について、簡単に理解できる導入ガイドを改訂しました。

第 3 週

今週は以下を行います。 1. [アプリケーションアーキテクチャ] ページの改善。これには、以下が含まれます。[メインプロセスとレンダラプロセス] セクションの既存の情報を書き換えて、初めて閲覧するユーザーにとってシンプルで直感的なものにします。アーキテクチャ、プロセスの接続方法、プロセスの通信方法、それらの主な違いを視覚的に表現します。映像の例: One、Two、Three（低品質） 2. Electron アプリケーションに追加できるすべての機能に関する情報の統合これには、ガイドを書き換えて、機能のインストールと有効化の方法に関する統一された手順と、その機能の動作の例をまとめることが含まれます。さらに、使用可能なすべての機能を一覧表示する新しいページ（概要）が作成されます。統合の手順は次のようになります。 - 概要 - 例: - コードサンプル - ビジュアルの例（可能な場合）

[Application Distribution] ページが簡略化されています。これには、以下が含まれます。 a. Application Packaging の Application Distribution ガイドへの統合 b. 配布方法の自動と手動の分割 c. 自動配布の例として electron Forge を挙げます。d. 手動配布の例としてソースファイルのコピーと asar アーカイブの作成について記載します。 #### 第 4 週今週は、ドキュメントディレクトリの再構築に専念します。以下が含まれています。

1 - 既存のガイドを少なくとも 3 つのカテゴリに分ける。 a. クイックスタート b. 基本の学習 c. 高度な手順

クイックスタートカテゴリには、基本的なチュートリアル（インストール、構成、配布）が含まれ、初心者でもゼロからクイックスタートを行うための一貫したガイドを作成できます。各ガイドには、シリーズ内の前後のガイドへのリンクを含める必要があります。

構造は次のようになります。 1. 前提条件 2. Electron をインストールします。 3. 基本的なアプリケーションを作成する 4. アプリケーションをパッケージ化/配布する

クイックスタートのセクションを完了すると、ユーザーは Electron アプリケーションの仕組みに関する基本を理解し、完全に機能する分散可能な Electron アプリケーションを利用できるようになります。

「基本を学ぶ」カテゴリには、Electron に関する理解を深め、クイックスタートセクションで作成したアプリケーションの拡張に役立つガイドが用意されています。このガイドの内容は次のとおりです。 - アプリケーションアーキテクチャ - アプリへの機能の追加 - ボイラープレートと CLI

高度な手順のカテゴリには、Electron アプリの設定と微調整を目的に、より高度なガイドが用意されています。 - テストとデバッグ - ユーザー補助 - セキュリティ - アップデート

2 - ドキュメントページの数を減らす。現在のバージョンのドキュメントには、内容の重複と分類されていない手順が含まれています。例: - 初めてのアプリの作成内での Electron のインストールとインストール - アプリのパッケージ化とアプリケーションディストリビューション内のファイルへのアプリのパッケージ化 - 詳細カテゴリと詳細カテゴリで分類されていない手順: 提案: 次のドキュメントを GitHub に移動し、メインドキュメントから除外します。これらのドキュメントは Electron 開発のガイドラインに特化しており、ソースリポジトリで最初に確認することをおすすめします。 - Electron の開発 - Chromium の開発 - V8 開発 - Electron の問題 - Electron のパッチ - pull リクエスト - ソースコードのディレクトリ構造 - テスト - コーディングスタイル

データ削減の主なアイデアは、膨大な数のガイドを取り除き、散らばっているパズルのピースを結合し、より構造化され、操作しやすく、ユーザーフレンドリーなバージョンの Electron ドキュメントを初めて初心者に提供することです。

第 5 ～ 7 週

第 5 週では、electron-api-demo をメインのドキュメントに統合する方法のテンプレート（1 つの方法）を準備することに専念します。このテンプレートは次のようになります。 1. メインのドキュメントの「アプリへの機能の追加」で、electron-api-demos に表示されるカテゴリを作成します。 2. 各カテゴリを確認して、デモサンプルをメインのドキュメントに移行します。 - コードサンプルは、ソースコードまたはアプリケーションの対応する機能の説明から取得できます - 転送された各サンプルの後に、関連する説明を続ける必要があります - 各子サンプル（たとえば、「システムダイアログを使用する」の子エラーダイアログなど）は、その親の下に移行する必要があります

注 #1: Electricron-api-demos とメインドキュメントの両方に存在する例（キーボードショートカット、ドラッグ&ドロップなど）があります。この場合、electron-api-demos の例を優先し、メインのドキュメントの例は無視してください。

注 #2: Electricron-api-demos アプリケーションの多くの例には、説明した特長や機能のライブデモプレビューが用意されています。この機能は、第 9 ～ 10 週の Electron Fiddle の統合まで無視されます。

例の新しい階層を考慮して、使用可能なすべての機能（第 3 週に作成されたもの）のリストを含むページを更新します。

第 6 週と第 7 週では、上述のテンプレートに従って、electron-api-demos の例をメインのドキュメントに移すことに専念します。最後に、electron-api-demos リポジトリを削除するか、非推奨にする必要があります。

第 8 ～ 10 週

第 8 週では、Electron Fiddle をメインのドキュメントに統合する方法のテンプレート（方法）を準備することに専念します。この取り組みは、Electron とコミュニティのボランティアによってすでに開始されていますが（問題 #20442 で詳細を確認してください）、適切に確定する必要があります。

Fiddle サンプルで処理する場合、基本テンプレートは次のようになります。 1. メインのドキュメントから例（クイックスタートなど）を選択します。この時点で、ドキュメントには Electricron-api-demos の例も含まれているはずです。 2. Electron Fiddle の例を再現します（サンプルコードまたはソースコードを出発点として使用します）。 3. フィドルをローカルのフォルダに保存します。 4. サンプルを /docs/fiddles/[CATEGORY]/[SECTION]/[DEMO] に移動してください。* 完了した例の一覧については、問題の「デモのリスト」セクションをご覧ください。 5. Issue #2848 の最初のコメントにあるように、[Launch in Fiddle] ボタンを追加します。

第 9 ～ 10 週では、electron-api-demos サンプル（Fiddles に変換済み）を上記のテンプレートに従ってメインドキュメントに統合します。

第 11 週

今週は、electron-api-demos リポジトリと Electron Fiddle サンプルの移行が正常に完了した後、書き込みプロジェクトを完了することに専念します。これには、以下が含まれます。 - 既存のすべてのコードサンプルに [Launch in Fiddle] ボタンがあることを確認する - 既存のすべてのコードサンプルが Fiddles として正常に機能している - メインドキュメントで Electricron-api-demos リポジトリを参照しなくなったことを確認する

第 12 週

完了した作業の完了。承認チェック。