このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- CERN-HSF
- テクニカル ライター:
- LuckInTheRain
- プロジェクト名:
- ROOT ドキュメントの拡張と改善
- プロジェクトの期間:
- 長時間（5 か月）
プロジェクトの説明
このプロジェクトでは、世界中の高エネルギー物理学コミュニティで使用されているデータ分析とデータ プレゼンテーション用のメイン ソフトウェア システムである ROOT のドキュメントを改善することを目標としています。
私はプロジェクトのために提供できるテクニカル ライターのスキルに加えて、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 が提供する機能を説明するチュートリアル
- 新しいルート 7 ヒストグラム
- 新しい Root 7 のグラフィック
推定スケジュール（5 か月）:
- フェーズ 1: ROOT ドキュメントとチュートリアルのタスクとスコープの定義: 2 週間
- フェーズ 2: ROOT フォーラムで重要なユーザーの質問を収集、分析する: 2 週間
- フェーズ 3: ルート ドキュメントの作成: 8 週間
- フェーズ 4: チュートリアルの作成: 8 週間
最後に、昨年、Google の長期的な Google シーズン プロジェクトで ROOT ドキュメントにすでに貢献したことを補足させていただきます。マニュアルの新しい構成を策定しました。 今年の提案は、ROOT にない他のドキュメントの面の完成の一助となるでしょう。