原文: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/