このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- ARK エコシステム
- テクニカル ライター:
- yslcrypto
- プロジェクト名:
- プロジェクト 1 - コア ブロックチェーン開発ガイド
- プロジェクトの長さ:
- 標準の期間（3 か月）
プロジェクトの説明
スタートガイドのセクションを読んだ後、次のようなことを考えました。
開発環境を設定する方法
インストール: ここでは、開発ツールのインストール方法について詳しく説明します。コードサンプルと、一般的なエラーとその修正方法を記載します（トラブルシューティング ページへのリンクをここに記載できます）。
最初のテストネットを起動する: 第一印象: 現時点では、ざっと目を通しただけですぐにセットアップしたい人にとってはかなり混乱します。変更すべき点は次のとおりです。
testnet などの基本的なコンセプトについても定義することを検討してください。
もっと短いコードサンプル（mkdir、cd など）を用意します。また、読者が簡単にコピー&ペーストできるように、それらをグループ化します。コピーして貼り付ける作業は誰でも大好きです。
最初に読んだとき、ネットワーク ブートのサブセクションの手順 1 と 2 が何を達成するのかが不明でした。リンクをクリックして、目を通すのは、多くの労力を要します。あまり細かい部分に立ち入ることなく、この点について明確に説明できると思います。
少なくともステップ 5（実際にはステップ 4 だと思いますか？）で core-container の概要を大まかに説明するので、読者はリンクをクリックせずに何をしているか、ある程度の直感を得ることができます。
ステップ 3 と 5（実際には 4）では、長いコードサンプルについて説明します。
最後のステップとして、インストールしたプラグインとファイルにリンクを貼り、読者の作業を楽にします。
最後に、段落ごとに 1 つのアイデアしかないように編集します（簡単に概要を把握できるようにするため）。また、トーンをもう少し楽しく、親しみやすくし、絵文字をいくつか追加します。
ブロックチェーンをモニタリングする方法
最初の段落を簡素化します。プラグインとデリゲートの役割（または少なくとも基本原則の説明へのリンク）、ブロックの偽造の意味、ネットワーク イベントの例を説明します。
問題を定義する: 完全なノードとは何なのかという直感を読者に示し、詳しい説明へのリンクを示して、フルノードと外部アプリケーションのトレードオフをわかりやすく説明します。最後に、このサブセクションの最後に、動作するテストネットと開発環境を設定する方法に関する前のセクションの開始ページへのリンクを追加します（読者がこのページに最初にアクセスした場合に備えて）。
Events API: 使用可能なイベントのリストから、目的のデータを取得するために「block.applied」を使用すべきかどうかは明らかではありません。以下のヒントでより明確になりますが、先に説明します。
「block.applied」が返す値が不明です。この点を明確にすることが重要だと考えています。
最後に示すコードサンプルでは、（前述の疑似コードサンプルの）「block.forger」が「block.generatorPublicKey」に置き換えられ、「delegateWeAreMonitoring」が「delegateKey」に置き換えられていることを明確に示したほうがよいでしょう。最後に、コードサンプルと疑似コードサンプルの整合性を確保するため、if 文で「delegateKey」と「generatorKey」を入れ替えます。
プラグインの作成: このコンテキストでスキャフォールディングが意味するところを説明します。たとえば、次のような内容です。建設現場の実際のスキャフォールディングと同様に、このコンテキストでスキャフォールディングについて言及する場合は、プラグイン用のシンプルな事前構築済み構造を指します。この構造の上に、実際のプラグインを構築できます。
ディレクトリとプラグインの名前を変更するコードサンプルを追加し、package.json の例を示し、plugin.js に「必要な構成を追加する」とはどういう意味かを説明します。
まとめ: 変更内容を明確にします。最後に、おめでとうのエンディングとその他の絵文字で締めくくります。
ARK SDK を使用して最初のトランザクションを送信する方法
スタートガイド: ユーザーがコピー＆ペーストで新しいディレクトリを作成できるようにするコードサンプルを追加します。
Testnet に接続する: 読者が REST API を知らない場合は、REST API について説明します（少なくとも説明へのリンクを記載します）。JSON ビューアの例を添付し、リンクを記載します。2 つ目のヒントでは、読者にお願いしているため、より親しみやすい口調を使用します。
Config Manager の変更: ネットワーク関連のバグの一般的な例を挙げ、トラブルシューティングのセクションへのリンクを検討します。
送信アカウントと受信アカウントを設定する: コピーして貼り付けることで、読者が config ディレクトリに移動できるようにコードサンプルを追加します。delegates.json の内容を示すコードサンプルを追加します。
ARK CORE TESTER CLI を使用してトランザクションを送信する方法
前提条件: ARK Core GitHub リポジトリの動作するコピーを取得する方法と、読者を適切なディレクトリに移動する方法を示したコードサンプルを追加します。
基本: パス環境変数に詳しくない方のために、最初の段落をわかりやすくします。
結論
最後に、ドキュメントを読んだ際にメモした簡単なメモをご紹介します。プロジェクトを一緒に始める際には、私自身がプロセスを試して、どこでつまずくかを確認したいと思います。その知識を使って、ドキュメントをさらに簡素化します。
最後に、私は 1 件のプロジェクトしか確認していませんが、2 週間以上かかることはないと思います。メールでやり取りしたように、この期間中に複数のプロジェクトに取り組むことは可能だと思います。