システム
ライト
ダークGoogle Season of Docs 2024 プロジェクトの最新情報
ブログに戻るJSON Schema ドキュメントプロジェクト
JSON Schema のドキュメントプロジェクトの主な目標は、明確で一貫性があり、包括的な、スケーラブルなドキュメントアーキテクチャを作成することです。Google Season of Docs (GSoD) を通じてこれを達成するために、私たちは以下に焦点を当てました。
- 仕様ドキュメントの再構築: 仕様ドキュメントには、すべてのペルソナが、JSON Schema が異なるリリースでどのように進化してきたか、そして各バージョンで導入された機能を理解するのに役立つ構造が必要です。
- 情報アーキテクチャの刷新: ドキュメントには、ドキュメント開発者ジャーニーにより整合し、Diátaxis フレームワークに基づいてコンテンツを整理する、新しい情報アーキテクチャが必要です。新しい情報アーキテクチャの目標は、オンボーディングエクスペリエンスとコンテンツの発見可能性を向上させることです。
GSoD プロジェクトの成果
5月以降、チーム（Valeria Hernandez、Blessing Ene Anyebe、Dhairya Amrish Majmudar、Benjamin Granados）は、これらの目標を達成するために懸命に取り組んできました。ドキュメントに関しては、以下を完了しました。
- 徹底的なコンテンツ監査を実施
- 開発者エクスペリエンスジャーニーをマッピング
- キーワードページを実装
- 仕様ドキュメントを再構築
チームはまた、コンテンツの読みやすさとナビゲーションを向上させることを目的とした、目次や前/次コンポーネントなど、ウェブサイトに変更を加えました。
今後の展望
それでは、何が残っているでしょうか？現在、仕様ドキュメントの一部であるJSON Hyper-Schemaと移行ページに取り組んでいます。
また、ドキュメントの投稿とテキストフォーマットのガイドラインのドキュメント化、不足しているキーワードのドキュメント化（ issue 951、952、961を参照）、ステップバイステップガイドの作成（ issue 180、950、954を参照）も行っています。
まとめ
ドキュメントに関する私たちの取り組みは日々拡大しており、皆さんの貢献によって改善することができます。お手伝いいただける方法はいくつかあります。例：
- ドキュメントウェブサイト全体の構造を改善するために、大きなドキュメントを分割する
- 開発者ジャーニーのトラブルシューティングとスケーリングの段階で不足しているドキュメントを作成する
- 移行ページに貢献する
ドキュメント会議は、毎週火曜日の午後3時（UTC）に隔週で開催されます。JSON Schema Slack ワークスペースの #gsod24 チャンネルにご参加いただき、メールアドレスを記載したメッセージをお送りください。会議にご招待いたします。
JSON Schema ドキュメントプロジェクトにご関心をお寄せいただきありがとうございます。皆さんの貢献と、より広範な開発者コミュニティへの利益を期待しています。
JSON Schema's Google Season of Docs チーム。