Polkadot 開発者ドキュメント センター: 開発者エクスペリエンスの新たな章を開く

原文:https://polkadot.com/blog/polkadot-dev-docs-hub

著者: アルベルト・ヴィエラ (PaperMoon 創設者)

編集者: OneBlock+

Decentralized Futures からの資金提供を受けて、PaperMoon チームはPolkadot Developer Documentation Center を正式に立ち上げました。この統合プラットフォームは、開発者の参入プロセスを簡素化するだけでなく、包括的な開発リソースと技術文書も提供し、Polkadot エコシステムの開発における重要なマイルストーンを示します。次に、OneBlock+ の誕生の経緯、構造設計、開発者ドキュメント センターの今後の拡張計画について詳しく紹介します。

コラボレーション イノベーション: Polkadot 開発者ドキュメント センターの誕生

Polkadot Developer Documentation Center は、 Decentralized Futuresからの資金提供を受けて開発されました。これは、地方分権の精神を遵守し、さまざまな分野での協力をカバーする画期的なプロジェクトです。これは、異なるチームが共通の目標に向かってどのように協力できるかを示すだけでなく、Polkadot、そのエコシステム、コミュニティに実際的なメリットをもたらします。 PaperMoon はプロジェクトの主なプロモーターおよびコーディネーターであり、 Web3 Foundation (W3F) はフィードバック、コンテンツの作成と移行、法的相談の面で重要なサポートを提供します。 Distractive は、ランディング ページのデザイン、ブランド ガイダンス、情報フィードバック、公開プロセスのサポートを担当しました。最後に、パリティは開発プロセスと一部の調整作業の実装にも関与しています。

Polkadot 開発者ドキュメント センター: 開発者エクスペリエンスの新たな章を開く

断片化から統一へ: PaperMoon の使命とビジョン

PaperMoon チームが Decentralized Futures から資金提供を受けた後、PaperMoon チームの当初の目標は、Chopsticks のドキュメントから Asset Hub との対話方法に至るまで、Polkadot エコシステムに関連するドキュメントを作成することでした。しかし、これらのマイルストーンを前進させようとしたとき、チームはより深刻な問題にすぐに気づきました。Polkadotの開発者ドキュメントの断片化された状態が、開発者のオンボーディング エクスペリエンスに深刻な影響を与えているということです。

開発者は、Polkadot ドキュメントを使用する際に、長い間次の課題に直面してきました。

  • 情報は、Substrate.io、Polkadot Wiki、GitHub、フォーラムなどの複数のプラットフォームに分散しています

  • 多くのドキュメントの内容が古いか、必要な情報を見つけるのが困難です。

  • 開発者は、リソースに一貫性がないため、混乱し、開始するのが難しいと感じることがよくあります。

他のエコシステムと比較して、多くのドキュメントがメイン サイトと同じドメイン名でホストされるため、Polkadot で開発している開発者は簡単に道に迷い、どこから始めればよいのか、正確な情報を見つける方法が分からなくなる可能性があります。この種のドキュメントの断片化は、かなりの摩擦点を生み出すだけでなく、開発者の意欲をそぐ可能性さえあり、結果的に SEO やその他の側面に悪影響を及ぼします。

Polkadot はシャード化されたエコシステムですが、そのドキュメントもシャード化する必要があるという意味ではありません。この認識により、PaperMoon チームは W3F および DF 委員会に大きな変更を提案することになりました。それは、分散型フューチャーのタスクに再び焦点を当て、代わりに Polkadot 開発者ドキュメント センターを作成するというものです。 PaperMoon チームのビジョンは明確です。開発者が Polkadot 上に構築する際に必要な情報を見つけるための統合されたエントリ ポイントをセンターにすることです。データがドキュメント センターに直接保存されているか、開発者が外部リソース (Polkadot-SDK Rust ドキュメントなど) に誘導されているかに関係なく、開発者は自信を持ってドキュメント センターにアクセスし、適切なガイダンスと説明に従って必要なリソースを簡単に見つけることができます。物語。

Polkadot 開発者ドキュメント センター: 開発者エクスペリエンスの新たな章を開く

適切なコンテンツを見つける:情報アーキテクチャ

Polkadot Developer Documentation Center のコンテンツ構造を決定するために、PaperMoon チームは 2 回の独立した情報アーキテクチャ演習を実施しました。コンテンツが断片的で、一部の情報が古いため、最初の演習では参加者に、ドキュメント センターで参照したいトピックまたはページを少なくとも 15 個リストするよう求めました。この段階で、PaperMoon チームは、W3F、Parity、PaperMoon、Distractive、パラチェーン チーム、ウォレット開発者など、さまざまな分野の 14 人の主要なエコシステム プレーヤーに参加を招待しました。最終的に、参加者は 18 の異なるカテゴリーをカバーする 154 件の提案を提出しました。参加者のバックグラウンドは非常に多様で、コア開発者 2 名、マーケター 2 名、ビジネス開発者 1 名、開発者関係スタッフ 3 名、エコシステムチームスタッフ 3 名、技術教育スタッフ 2 名、製品エンジニアリングスタッフ 1 名となっています。これらの推奨事項を集約することで、チームはさまざまな分野でどこに注力すべきかをより明確に理解できるようになります。

これらのさまざまな提案を収集した後、第 2 ラウンドの演習では、参加者に提案をさまざまなモジュールに整理し、これらのモジュールを文書の高レベルの分類にするよう提案しました。このラウンドの演習には、技術志向または Polkadot エコシステムに精通した合計 9 名の参加者が参加しました。結果を要約すると、少なくとも 12 の主要なモジュールが特定され、最終的な情報アーキテクチャの基礎が形成されました。

これら 2 回の演習と、W3F および Parity との綿密な対話を通じて、PaperMoon チームは、最終的に Polkadot 開発者ドキュメント センターの最終的な情報アーキテクチャ設計を完成させました。このバージョンはドキュメント センターで確認できるようになりました。このバージョンでは、開発者は次の 4 つの主要なカテゴリに分類されます。

  • ブロックチェーン開発者: Polkadot SDK に基づいてブロックチェーンを構築し、Polkadot 上で起動したい開発者。彼らは、Polkadot の基本概念を理解し、Polkadot のセキュリティを活用するようにチェーンを構成し、さまざまなテスト フレームワークにアクセスし、ランタイム アップグレードなどを理解する必要があります。

  • スマート コントラクト開発者: Polkadot エコシステム上でスマート コントラクト ベースのアプリケーションを構築したい開発者。彼らは、さまざまなパス オプション (EVM や Wasm など)、利用可能なツール、および使用できるチェーン (AssetHub、Acala、Astar、Moonbeam など) を理解する必要があります。

  • インフラストラクチャ プロバイダー: Polkadot 上でインフラストラクチャ (バリデータ、RPC プロバイダーなど) を実行したい開発者。彼らは、RPC またはバリデーター ノードを適切に設定する方法を知り、バリデーターであることが何を意味するかを理解する必要があります。

  • ツール開発者: Polkadot エコシステム用の共通ツール (SDK、モニタリング ダッシュボード、Web サイトなど) を構築したい開発者。さまざまなプログラミング言語で利用できるツールを理解する必要があります。

現在の暫定バージョンは単なる出発点です。次に、PaperMoon チームは、より広範な開発者コミュニティとコミュニケーションをとり、フィードバックを収集し、各視聴者の具体的なニーズをより深く理解します。十分な注意と時間をかけて初めて、開発者のカテゴリーをさらに絞り込み、さまざまなニーズを持つ開発者により正確なリソースを提供することができます。

Polkadot 開発者ドキュメント センター: 開発者エクスペリエンスの新たな章を開く

コンテンツの移行と作成:既存のリソースから新しいプラットフォームへの移行

Polkadot 開発者ドキュメント センターの全体的な構造が完成した後、PaperMoon チームはコンテンツ作成の作業を開始しましたが、これは困難な作業でした。チームはまず、どのコンテンツを Substrate.io または Polkadot Wiki から移行できるか、またどのコンテンツを最初から作成する必要があるかを整理しました。

必要なコンテンツの移行と作成は、非常に集中的なプロセスです。ドキュメントの整合性を確保するために、PaperMoon チームは約 50 ページのコンテンツを更新して新しいドキュメント センターに移行することを決定しました。これは、初期バージョンには 80 ページを超えるコンテンツが含まれることになります。さらに、開発者が必要なものをより簡単にナビゲートして見つけられるように、インデックス ページを作成する必要があります。

プロセス全体を通じて、PaperMoon チームは合計約 170 のプル リクエスト (PR) を作成しました。各 PR は、主に PaperMoon エンジニアで構成される専任のコンテンツ レビュー チームによってレビューされ、技術的な正確性を確保するために W3F 技術教育者の支援を受けます。同時に、コンテンツがドキュメントの基準を満たしているかどうかをチェックする責任を負うフォーマット レビュー チーム (PaperMoon のエンジニアで構成) も存在します。このプロセスは約 3 か月続き、資金調達の取り決めによる他の作業も含まれていました。

一方、PaperMoon チームは Distractive と協力して、ドキュメントのリリース プロセス、ランディング ページ、法的およびブランドのガイダンスを処理し、最終的なリリースがスムーズに行われるようにしました。

すべての準備が完了した後、PaperMoon チームは、フィードバックを提供するために、W3F チームと Parity チーム向けに Polkadot 開発者ドキュメント センターの内部ドラフトを作成しました。彼らは、コンテンツ、物語の構造、製品の方向性に関して非常に貴重な提案をしてくれました。

現在、PaperMoon チームは、Polkadot 開発者ドキュメント センターの最初のバージョンをリリースする準備ができています。

Polkadot 開発者ドキュメント センター: 開発者エクスペリエンスの新たな章を開く

次のステップ:新たな旅の始まり

Polkadot Developer Documentation Center の最初のバージョンのリリースで、PaperMoon チームの作業は終わったわけではありません。実際、これは新たな旅の始まりです。

ローンチ後、PaperMoon チームは、(他の関連事項の中でも特に) 以下の重要なタスクを進めることに重点を置きます。

  • コード スニペット リポジトリ構造を作成する: すべてのコード スニペットを保存およびテストするシステムを確立し、ドキュメントに示されているすべてのコード サンプルが適切に動作することを確認します。

  • 最小限のドキュメント標準を確立する: GitHub リポジトリから一連の最小限のドキュメント標準を抽出して作成し、コンテンツが複製されず、リリースごとに更新されないようにします。並行して、PaperMoon チームは、文書化されたツールにコードを提供して、ツールがこれらの標準に準拠していることを確認することも計画しています。

  • GitHub ランナーの最適化: GitHub ランナーを最適化して、文書化されている製品の新しいバージョンのリリースを追跡し、文書の内容が常に最新であることを保証します。

  • チュートリアル コンテンツの拡張: PaperMoon チームは、開発者が Polkadot エコシステムをより深く理解し、適用できるように、より多くのトピックに関するチュートリアルを追加し、より実践的な開発例を提供します。

さらに、Polkadot の 2025 年の計画が徐々に展開されるにつれて、PaperMoon チームは開発者が Polkadot 上でプロジェクトを正常に構築できるよう、ドキュメントの面でより完全なサポートを提供します。特に、イーサリアム互換のスマート コントラクトの導入に伴い、PaperMoon チームは W3F および Parity と協力して Polkadot の新しいスマート コントラクトの物語を推進し、開発者がスマート コントラクト ベースのアプリケーションをスムーズに構築できるように正確なドキュメントが提供されるようにします。

結論: 継続的な最適化とコミュニティの共同構築

Polkadot 開発者ドキュメント センターは、Polkadot エコシステムの重要なマイルストーンであり、開発者が必要とするすべてのリソースを 1 つのプラットフォームに集め、Polkadot での構築と開発をより便利にします。ただし、これは単なる出発点にすぎません。統合ドキュメント センターは、常に更新され、エコシステムとの同期が維持されている場合にのみ、その真の価値を実現できます。

Polkadot でツールやプロジェクトを構築している場合、 PaperMoon チームはチームの継続的な改善を支援するためにドキュメント センターに貢献することを心から歓迎します。新しいコンテンツの追加、既存の情報の更新、革新的なアイデアの提案など、あらゆる貢献には価値があります。

これは、コミュニティによって、コミュニティのために推進される、最高のオープンソースです。 Polkadot 開発者ドキュメント センターが開発者にとって革新的なプロジェクトを作成するための最初の選択肢となるリソースとなるよう、協力していきましょう。

👉 Polkadot 開発者ドキュメント センターにアクセスしてください: https://docs.polkadot.com/