原文:https://polkadot.com/blog/polkadot-dev-docs-hub
作者:Alberto Viera(PaperMoon 创始人)
编译:OneBlock+PaperMoon
团队在 Decentralized Futures 的资助下,正式推出了波卡开发者文档中心。这个统一平台不仅简化了开发者的入门流程,还提供了全面的开发资源和技术文档,标志着波卡生态系统发展的重要里程碑。接下来,OneBlock+ 将为大家详细介绍开发者文档中心的诞生过程、结构设计以及未来的扩展计划。
协作创新:波卡开发者文档中心的诞生
波卡开发者文档中心是通过 Decentralized Futures 的资助开发的。这是一个具有里程碑意义的项目,秉持去中心化的精神,涵盖了多个不同领域的合作。它不仅展示了不同团队如何为一个共同目标协作,还为波卡及其生态系统、社区带来了实际的益处。PaperMoon 是该项目的主要推动者和协调者,Web3 Foundation(W3F)在反馈、内容创建与迁移、以及法律咨询等方面提供了重要支持。Distractive 负责了着陆页的设计、品牌指导、信息反馈及发布过程的支持。最后,Parity 也参与了开发过程以及一些协调工作的实施。
从碎片化到统一:PaperMoon 的使命与愿景
在 PaperMoon 团队获得 Decentralized Futures 资助后,PaperMoon 团队的最初目标是创建与波卡生态系统相关的文档,涵盖从 Chopsticks 文档到如何与 Asset Hub 进行交互等内容。然而,在着手推进这些里程碑时,团队很快意识到一个更为严峻的问题:波卡开发者文档的碎片化状态正严重影响开发者的入门体验。开发者们在使用波卡文档时,长期面临着以下几个挑战:信息分散在 Substrate.io、Polkadot Wiki、GitHub 和论坛等多个平台上。许多文档内容已过时,或者很难找到所需信息。由于资源的不一致性,开发者在入门时往往感到困惑和困难。对比其他生态系统,很多文档会托管在与主站点同一域名下,而在波卡上开发的开发者则容易迷失方向,不知道从哪里开始,或如何找到准确的信息。这种文档碎片化不仅造成了相当大的摩擦点,甚至可能让开发者望而却步,进而对 SEO 等方面产生负面影响。虽然波卡是一个分片化的生态系统,但这并不意味着它的文档也必须是分片的。
这一认识促使 PaperMoon 团队向 W3F 和 DF 委员会提出了一个重大的转变:将 Decentralized Futures 任务的重心重新聚焦,转而创建波卡开发者文档中心。PaperMoon 团队的愿景很明确:让该中心成为开发者在波卡上构建时查找所需信息的统一入口。无论数据是否直接存储在文档中心,还是将开发者引导至外部资源(如 Polkadot-SDK Rust 文档),开发者都能够自信地前往文档中心,通过合理的引导和叙事,轻松找到所需的资源。
寻找正确的内容:信息架构
为了确定波卡开发者文档中心的内容结构,PaperMoon 团队进行了两轮独立的信息架构练习。由于内容存在碎片化且部分信息已过时,第一次练习要求参与者列出至少 15 个他们希望在文档中心看到的主题或页面。在这一阶段,PaperMoon 团队邀请了来自不同领域的 14 位生态系统关键玩家参与,包括 W3F、Parity、PaperMoon、Distractive、平行链团队、钱包开发者等。最终,参与者提交了 154 条建议,涵盖了 18 个不同类别。参与者的背景非常多样,包括 2 位核心开发者、2 位市场人员、1 位商务开发人员、3 位开发者关系人员、3 位生态团队人员、2 位技术教育人员和 1 位产品工程人员。通过对这些建议的汇总,团队能够更清晰地了解不同领域的关注重点。在收集到这些不同的建议后,第二轮练习要求参与者将这些建议整理成不同的模块,并提出这些模块应成为文档的高层次分类。
在这一轮练习中,共有 9 位来自技术导向或对波卡生态系统非常熟悉的参与者参与。通过总结得出的结果,确定了至少 12 个关键模块,并为最终的信息架构奠定了基础。通过这两轮练习以及与 W3F 和 Parity 的深入互动,PaperMoon 团队最终完成了波卡开发者文档中心的最终信息架构设计。如今,您可以在文档中心看到这一版本。
在这个版本中,开发者分为了以下四个主要类别:区块链开发者:希望基于 Polkadot SDK 构建区块链并在波卡上启动的开发者。他们需要理解波卡的基本概念,配置链以利用波卡的安全性,访问不同的测试框架,了解运行时升级等。
智能合约开发者:希望在波卡生态系统上构建基于智能合约的应用的开发者。他们需要了解不同的路径选择(如 EVM 或 Wasm)、可用工具以及可以使用的链(如 AssetHub、Acala、Astar、Moonbeam 等)。
基础设施提供者:希望在波卡之上运行基础设施(如验证者、RPC 提供者)的开发者。他们需要了解如何正确设置 RPC 或验证者节点,并理解成为验证者的意义。工具开发者:希望为波卡生态系统构建通用工具(如 SDK、监控仪表盘、网站等)的开发者。他们需要了解不同编程语言中可用的工具。当前的初步版本只是一个起点。接下来,PaperMoon 团队将与更广泛的开发者群体进行沟通,收集反馈,深入了解每个受众的具体需求。
只有在获得足够的关注和时间后,才能进一步细化开发者类别,为不同需求的开发者提供更加精准的资源。
内容迁移与创建:从现有资源到新平台的转变
在波卡开发者文档中心的总体结构完成后,PaperMoon 团队开始了内容创建的工作,这是一项充满挑战的任务!团队首先梳理了哪些内容可以从 Substrate.io 或 Polkadot Wiki 迁移过来,哪些内容需要从零开始创建。迁移和创建所需的内容是一个高度密集的过程。为了确保文档的完整性,PaperMoon 团队决定将大约 50 页内容更新并迁移到新的文档中心,这意味着初期版本将包含超过 80 页的内容。此外,还需要创建索引页面,这些页面将帮助开发者更方便地导航并找到他们所需的内容。整个过程中,PaperMoon 团队共创建了约 170 个 pull requests(PR)。每个 PR 都由一个专门的内容审查团队进行审核,团队主要由 PaperMoon 的工程师组成,并得到 W3F 技术教育人员的协助,确保技术准确性。同时,另有一个格式审查团队(由 PaperMoon 的工程师组成)负责检查内容是否符合文档的标准。这个过程持续了约三个月,同时还包括了通过资助安排进行的其他任务。
与此同时,PaperMoon 团队与 Distractive 合作,处理文档的发布流程、着陆页、法律和品牌指导,确保最终的发布工作顺利进行。在所有准备工作完成后,PaperMoon 团队创建了波卡开发者文档中心的内部草稿,供 W3F 和 Parity 的团队提供反馈。他们对内容、叙事结构以及产品导向等方面给出了非常有价值的建议。现在,PaperMoon 团队已经准备好发布波卡开发者文档中心的第一版。
下一步:新征程的开始
随着波卡开发者文档中心第一版的发布,PaperMoon 团队的工作并未结束;实际上,这才是新征程的开始。在发布后,PaperMoon 团队将集中精力推进以下几个关键任务(以及其他相关事项):创建代码片段仓库结构:建立一个存储和测试所有代码片段的系统,确保文档中展示的所有代码示例都能正常工作。设立最低文档标准:从 GitHub 仓库中提取并创建一套最低文档标准,确保内容不重复,并保证每个版本发布时的更新。与此同时,PaperMoon 团队还计划为已文档化的工具贡献代码,确保它们符合这些标准。优化 GitHub runner:优化 GitHub runner 以便追踪正在文档化的产品的新版本发布,从而确保文档内容始终保持最新。扩展教程内容:PaperMoon 团队将增加更多主题的教程,并提供更多实际的开发示例,帮助开发者更好地理解和应用波卡生态系统。此外,随着波卡 2025 年的计划逐步展开,PaperMoon 团队将在文档方面为开发者提供更加完善的支持,助力他们在波卡上成功构建项目。特别是,随着以太坊兼容智能合约的引入,PaperMoon 团队将与 W3F 和 Parity 一起推动波卡新的智能合约叙事,确保为开发者提供准确的文档,帮助他们顺利构建基于智能合约的应用。
结语:持续优化与社区共建波卡开发者文档中心
是波卡生态系统中的一项重要里程碑,它将开发者所需的所有资源集中在一个平台上,使得在波卡上构建和开发变得更加便捷。然而,这只是一个起点。一个统一的文档中心只有在不断更新并保持与生态系统同步时,才能发挥其真正的价值。如果你正在波卡上构建工具或项目,PaperMoon 团队诚邀你为文档中心贡献力量,帮助团队持续改进。无论是添加新内容、更新现有信息,还是提出创新的想法,每一份贡献都是宝贵的。这就是最好的开源——由社区推动,为社区服务。让我们携手努力,让波卡开发者文档中心成为开发者创建创新项目的首选资源。
👉 访问波卡开发者文档中心:https://docs.polkadot.com/