Google Season of Docs 2024 專案更新

JSON Schema 文件專案

JSON Schema 的文件專案的主要目標是建立一個可擴展的文件架構，使其清晰、一致且全面。為了透過 Google Season of Docs (GSoD) 實現此目標，我們將重點放在

• 重組規格文件：規格文件需要一個結構，以幫助所有使用者角色了解 JSON Schema 在不同版本中的演變方式以及每個版本中引入的功能。
• 改進資訊架構：文件需要一個新的資訊架構，使其能更好地與文件開發者旅程保持一致，並根據diataxis 框架來組織內容。新的資訊架構的目標是改善入門體驗和內容的可查找性。

GSoD 專案成就

自五月以來，團隊（Valeria Hernandez、Blessing Ene Anyebe、Dhairya Amrish Majmudar 和 Benjamin Granados）一直努力實現這些目標。在文件方面，我們已完成以下工作

• 進行了徹底的內容審核
• 繪製了開發者體驗旅程
• 實作了關鍵字頁面
• 重組了規格文件

團隊還對網站進行了變更，例如目錄和上一頁/下一頁元件，旨在改善內容的可掃描性和導覽。

未來展望

那麼，還有哪些待處理的事項？我們目前正在處理JSON Hyper-Schema 和遷移頁面，它們是規格文件的一部分。

我們也在編寫文件貢獻和文字格式的指南，記錄遺失的關鍵字（請參閱問題951、952 和 961），以及撰寫逐步指南（請參閱問題180、950 和 954）。

結論

我們的文件工作每天都在擴展，您的貢獻可以改善它們。您可以透過多種方式提供協助，包括

• 拆解大型文件，以改善文件網站的整體結構
• 為開發者旅程的疑難排解和擴展階段建立遺失的文件
• 貢獻於遷移頁面

我們的文件會議每隔週的星期二下午 3:00 (UTC) 舉行。歡迎加入 JSON Schema Slack 工作區中的 #gsod24 頻道，並向我們傳送包含您電子郵件地址的訊息，以便我們將您加入會議中。

感謝您對 JSON Schema 文件專案的興趣，並期待您的貢獻及其對更廣泛開發者社群的益處。

JSON Schema 的 Google Season of Docs 團隊。

由Duy Pham在Unsplash上拍攝的照片