このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- Apache Cassandra
- テクニカル ライター:
- ドヴォーラ
- プロジェクト名:
- Apache Cassandra 4.0 のドキュメントの更新とドキュメントでの TODO の解決
- プロジェクトの期間:
- 長時間（5 か月）
プロジェクトの説明
プロジェクトは、次の 2 つのサブプロジェクトで構成されています。
1. Apache Cassandra 4.0 ドキュメントの更新
既存の Apache Cassandra のドキュメントを見直して、
今後の Apache Cassandra 4.0 リリースに合わせて更新してください。これに対して Google が提案する
アプローチは、まず Cassandra のコントリビューターの cassandra-dev
メーリング リストに電話をかけて、
ドキュメント内で更新が必要な部分をハイライト表示することです。
次に、既存のドキュメントの構造化レビューを
体系化し、潜在的なギャップを特定します。例: 構造化レビューでは、テクニカル ライターは
Cassandra 構成ファイルのドキュメント
（http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html）と実際にソースに含まれている構成オプションを比較できます（https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java）。
2. Apache Cassandra ドキュメントでの TODO を解決する
Apache Cassandra のドキュメントには、「TODO」（または未完了のタスク）としてハイライト表示された
セクションがいくつか含まれています。わかっています。
- Cassandra / バックアップの運用
- Cassandra / 一括読み込みの運用
- CQL / データ定義（限定的なレビュー ポイント）
- データ モデリング
- Dynamo / Gossip、障害検出、トークンリング
- 建築/保証
- Cassandra/ヒントの運用
- アーキテクチャ/概要（別のプロジェクトとして提案）
- Cassandra/読み取り修復の運用
- コミュニティの多くのメンバーが、これらのトピックをカバーする資料を作成しています（一般公開のブログ投稿、Stack Overflow の投稿など）。これらのセクションを完了する最も生産的なアプローチは、メーリング リストから適切な参照や資料をリクエストし、Apache Cassandra ドキュメント セットの簡潔なドキュメントにまとめることです。