このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソース組織:
- Apache Flink
- テクニカル ライター:
- haseeb1431
- プロジェクト名:
- Apache Flink の Table API と SQL のドキュメントの拡張
- プロジェクトの長さ:
- 標準期間（3 か月）
プロジェクトの説明
「テーブル API と SQL ドキュメントの拡張」で GSOD の申請を提出します。おばあちゃんもクエリを記述できるように API ドキュメントを作成します。すでに構造が存在する場合もありますが、初心者ユーザーとして確認し、必要に応じてアイデアを提案します。メンターと緊密に連携して思考プロセスを理解しながら、これまでの業界経験に基づくさまざまなアイデアも共有する予定です。
現在のドキュメントに基づく最初の考えは次のとおりです。
現在、概要ページには多くの情報が記載されていますが、初心者でも上級者でもすぐに始められるような順序に並べ替えて、概要ページを見直す必要があります。私の考えでは、a）新しいプロジェクトを開始してその上でクエリを実行する、b）既存のプロジェクト上で SQL または Table API クエリを実行する、といった異なるトラックから始められるようにしたいと思っています。
また、ユーザーが一目ですべての可能性を確認できるように、ランディング ページに API ドキュメントの完全なマップも用意する必要があります。これは、現在の概要ページの「次のステップ」セクションの改良版です。
コンセプト ページは内容が充実していますが、1 ページに詰め込みすぎているため、このページにはサブセクションを少なくする予定です。同様に、「プランナー」、「組み込み関数」、「コネクタ」の他のセクションについては、概要ページや左側のナビゲーション バーで可視性を高める必要があります。[コネクタ] ページは、コネクタ、形式など、さらにサブセクションに分割できます。システム（組み込み）関数は、使用可能なすべてのメソッドが 1 つのページに表示され、ユーザーがいつでも参照できるため、問題ないように思えますが、その周辺のコンテンツを追加することもできます。
この 3 か月間は、いくつかのフェーズに分かれています。まず、Table API と SQL API のドキュメントのサイトマップのような構造を作成します。上記のように、サブセクションとストーリーラインを導入します。完了後、上級および初級レベルのユーザーがレビューを行います。一方、フィードバックを待っている間に、プランナーやコネクタについて記述を開始できます。フィードバックをお寄せいただいた後、API ドキュメントを再構成いたします。次は、保留中のセクションの執筆を終えることに集中します。最後に、時間があれば、ゼロからサンプルを取り上げ、FLINK-12639 で活用できるエンドツーエンドのプロジェクト実装を紹介します。
2 週間後に、Slack（または他のツール）でのチャット以外の 1 時間のミーティングを開催することを提案します。プロジェクトの最初のタイムライン（予定期間）をお知らせします。これにより、プロジェクトの進捗状況を週単位で追跡できます。
最後に、このドキュメントは medium.com のブログと似ています。Flink API のさまざまな機能を学習する際に、基本的な詳細をすべて追加しています。また、技術ドキュメントの作成だけでなく、実装を実際に行ってドキュメントを確認できるという点でも、私を採用するメリットがあります。私は Table と SQL API を学びながら、オープンソースのドキュメントに貢献するので、このプロジェクトは私にとって 2 つの剣のようなものです。