CERN-HSF プロジェクト
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
このページでは、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 マニュアル」)は、次の分野で改善と補足が必要と思われます。
推定スケジュール(5 か月):
- フェーズ 1: ROOT のドキュメントとチュートリアルのタスクとスコープの定義: 2 週間。
- フェーズ 2: ROOT フォーラムから重要なユーザーの質問を収集して分析する: 2 週間
- フェーズ 3: ROOT ドキュメントの作成: 8 週間。
- フェーズ 4: チュートリアルの開発: 8 週間
最後に、昨年、長期にわたる Google Season of Docs プロジェクトで ROOT ドキュメントに貢献したことを付け加えておきます。マニュアルの新しい構造を定義しました。今年の提案は、ROOT にまだ不足している他のドキュメントの側面の完成に貢献するでしょう。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[[["わかりやすい","easyToUnderstand","thumb-up"],["問題の解決に役立った","solvedMyProblem","thumb-up"],["その他","otherUp","thumb-up"]],[["必要な情報がない","missingTheInformationINeed","thumb-down"],["複雑すぎる / 手順が多すぎる","tooComplicatedTooManySteps","thumb-down"],["最新ではない","outOfDate","thumb-down"],["翻訳に関する問題","translationIssue","thumb-down"],["サンプル / コードに問題がある","samplesCodeIssue","thumb-down"],["その他","otherDown","thumb-down"]],["最終更新日 2025-07-25 UTC。"],[[["\u003cp\u003eThis project aims to improve and extend the documentation of ROOT, a data analysis software used by the high-energy physics community.\u003c/p\u003e\n"],["\u003cp\u003eThe focus is on making the documentation more accessible to non-physicists, adding tutorials on core functionalities and new features like Python bindings and data mining tools.\u003c/p\u003e\n"],["\u003cp\u003eKey deliverables include technical specifications, tutorials on RDataFrame and RNtuple, and incorporating answers to frequently asked user questions.\u003c/p\u003e\n"],["\u003cp\u003eThe project will be executed in phases, starting with defining the scope, analyzing user questions, writing documentation, and developing tutorials.\u003c/p\u003e\n"],["\u003cp\u003eThe contributor has prior experience with ROOT and previously contributed to its documentation through Google Season of Docs.\u003c/p\u003e\n"]]],["The project aims to enhance the ROOT documentation, a crucial tool for high-energy physics. Key actions include improving accessibility for non-physicists, developing new tutorials on general ROOT functionality, and documenting new features like Python bindings and data mining tools (RDataFrame, RNtuple). The project will also synthesize frequently asked questions from the ROOT forum into the documentation. A five-month timeline involves defining the documentation's scope, analyzing user questions, writing the documentation, and creating tutorials.\n"],null,[]]