このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- CERN-HSF
- テクニカル ライター:
- LuckInTheRain
- プロジェクト名:
- ROOT ドキュメントの拡張と改善
- プロジェクトの長さ:
- 長時間実行（5 か月）
プロジェクトの説明
このプロジェクトの目標は、世界中の高エネルギー物理学コミュニティで使用されているデータ分析とデータ表示のための主要なソフトウェア システムである ROOT のドキュメントを改善することです。
プロジェクトに必要なテクニカル ライターのスキルに加えて、ルート（6 と 7）に精通しており、プロジェクトに必要な、以下のような他のコンポーネントに関する知識がある
- C++
- Python
- Git/GitHub
- ウェブサイト作成ツール（html、markdown、Jekyll）
ROOT ドキュメントには主に次の 3 つの要素があります。
- ウェブサイト https://root.cern、
- C++ クラス リファレンス ガイド（https://root.cern/doc/master/）
- フォーラム https://root-forum.cern.ch
ROOT ドキュメント（新しい「ROOT マニュアル」）は、次の分野で改善と補足が必要と思われます。
- 特に導入章は、物理学者以外の人にもわかりやすくなるはずです。
- ROOT の一般的な機能について説明するチュートリアルがさらに開発される予定です。
- 新しいトピックや新しい開発については、詳細な説明と例を記載します。以下に例を挙げます。
- Python バインディング
- 数学ライブラリは
- 高レベルのグラフィック ツール（TRatioPLot、THStack）の手動による説明
- 新しいデータ マイニング分析ツール（RDataFrame と RNtuple）
- 新しいキーデータ形式（RDataFrame と RNtuple）には、詳細な技術仕様とチュートリアルが必要です。
ROOT フォーラムに投稿されたような、ユーザーからの重要な質問への回答は、ドキュメントに含める必要があります。そのためには、よくある質問を細かく分析し、統合期間を経て、新しい「ルート マニュアル」やリファレンス ガイドの新しいチュートリアルの資料に変換する必要があります。
ROOT 7 が提供する機能を紹介するチュートリアル。
- 新しい ROOT 7 ヒストグラム
- 新しい ROOT 7 グラフィック
推定スケジュール（5 か月）:
- フェーズ 1: ROOT のドキュメントとチュートリアルのタスクとスコープの定義: 2 週間。
- フェーズ 2: ROOT フォーラムから重要なユーザーの質問を収集して分析する: 2 週間
- フェーズ 3: ROOT ドキュメントの作成: 8 週間。
- フェーズ 4: チュートリアルの開発: 8 週間
最後に、昨年、長期にわたる Google Season of Docs プロジェクトで ROOT ドキュメントに貢献したことを付け加えておきます。マニュアルの新しい構造を定義しました。今年の提案は、ROOT にまだ不足している他のドキュメントの側面の完成に貢献するでしょう。